Skip to content

Tools Reference

OpenQuok MCP tools — channels, posts, plugs, analytics, directory launch profiles, and directory SEO.

12 min read

Connect your agent today

Draft from chat, review in your calendar, and publish only what you approve.

Start your free trial

Overview

All tools run in the context of the workspace tied to your opo_ token. They call the same backend services as /api/v1/public/* — lower latency, no HTTP loopback.

A typical social workflow: integrationList → schedulePostTool → postsList / postsStatus / postsReschedule → analyticsPost → plugsUpsert. For directory launch (My Products, not social channels): directoryProfilesList (mainOnly) → directoryVariantsEnsure → directoryProfilesUpdate when filling copy → directoryListingSummary → optional directorySeoOverview. Image and video generation MCP tools from other catalogs are not available yet.

Channel discovery

groupList

List business profiles (API: customers) for the authenticated workspace. Use a profile’s id with integrationList when you only need channels in one profile.

Input: none

Output:

{
  "groups": [
    {
      "id": "<customer-group-id>",
      "name": "Client A"
    }
  ]
}

integrationList

List connected social channels for the authenticated workspace.

Input:

FieldTypeRequiredDescription
groupstringNoBusiness profile id (customer) from groupList; when set, only channels in that profile are returned

Output:

{
  "integrations": [
    {
      "id": "<integration-id>",
      "name": "My Threads account",
      "identifier": "threads",
      "platform": "threads",
      "picture": "https://example.com/profile.jpg",
      "disabled": false,
      "profile": "https://www.threads.net/@handle",
      "customer": { "id": "<customer-group-id>", "name": "Client A" }
    }
  ]
}

Use returned id values as integration, integrationId, or acting-channel UUIDs in schedulePostTool settings. platform mirrors identifier for compatibility with agents trained on other MCP catalogs.

integrationSchema

Return posting rules, character limits, compose settings schema, and allow-listed provider tools for a platform identifier (no connected channel required).

Input:

FieldTypeDescription
platformstringProvider identifier, e.g. threads, instagram
isPremiumbooleanOptional; when the provider tiers character limits by plan, pass whether the workspace is premium (defaults to false)

Output:

{
  "output": {
    "rules": "…",
    "maxLength": 500,
    "settings": { },
    "tools": [],
    "extensionPublishMode": "member_browser_handoff",
    "agentNote": "Reddit handoff only — not server-published…"
  }
}

For reddit, extensionPublishMode is member_browser_handoff and agentNote explains draft/handoff (omit on OAuth channels).

triggerTool

Invoke an allow-listed provider method on a connected channel (same behavior as POST /public/integration-trigger/:id).

Input:

FieldTypeDescription
integrationstringConnected channel UUID (alias for integrationId)
integrationIdstringConnected channel UUID from integrationList
methodNamestringProvider tool method name from integrationSchema
dataobjectOptional payload passed to the provider method
dataSchemaarrayOptional key-value pairs (key, value) — alternative to data

Scheduling

schedulePostTool

Create or schedule posts across one or more connected channels. On reddit, treat this as draft/handoff — OpenQuok does not publish to reddit.com from the server (see callout below).

Input:

FieldTypeDescription
typedraft | schedule | nowDraft, scheduled, or publish immediately
datestringISO-8601 time when type is schedule
socialPostarrayPer-channel payloads (see below)

Each socialPost entry:

FieldTypeDescription
integrationstringConnected channel UUID (publishing channel)
postsAndCommentsstring[]Main post body; additional strings are same-account reply chains only — not cross-account plugs
settingsobjectProvider compose settings on the publisher (same keys as REST providerSettingsByIntegrationId)
attachmentsstring[]Public image or video URLs — uploaded automatically before scheduling

Output:

{
  "output": [
    {
      "postId": "<post-id>",
      "integration": "<integration-id>"
    }
  ]
}

Example input

{
  "type": "schedule",
  "date": "2026-06-26T14:00:00.000Z",
  "socialPost": [
    {
      "integration": "<integration-id>",
      "postsAndComments": ["Hello from MCP!"],
      "attachments": ["https://example.com/photo.jpg"]
    }
  ]
}

Provider settings on the publisher

Put per-channel compose options in settings on the publishing socialPost entry. Keys match REST providerSettingsByIntegrationId[integrationId] — for example threads.internalEngagementPlug for a same-account delayed engagement reply, or nested threads.crossAccountPlugs for comments from another connected Threads channel.

Setting bucketUse for
threads.internalEngagementPlugSame-account delayed engagement reply after publish
threads.crossAccountPlugsComments from other Threads channels in the workspace
x.crossAccountPlugsReposts from other X channels after publish
linkedin.crossAccountPlugsComments or reshares from other LinkedIn channels

Full field shapes: CLI examples — Threads, CLI examples — X, CLI examples — LinkedIn.

uploadFromUrl

Fetch a public HTTPS image or video URL into workspace media. Returns id and path for schedulePostTool media or compose settings.

Input:

FieldTypeRequiredDescription
urlstringYesPublic https:// URL to fetch and store

Output:

{
  "id": "<media-id>",
  "path": "org/<media-id>.jpg"
}

Posts management

postsList

List posts in a date window for the workspace.

Input:

FieldTypeRequiredDescription
startstringNoStart ISO timestamp; default is 30 local calendar days before today
endstringNoEnd ISO timestamp; default is 30 local calendar days after today
integrationIdsstring[]NoFilter to specific connected channel ids
customerGroupIdstringNoFilter to a business profile id from groupList

Output:

{
  "success": true,
  "data": {
    "posts": []
  }
}

postsFindSlot

Suggest a free schedule slot for the workspace or a specific connected channel.

Input:

FieldTypeRequiredDescription
integrationIdstringNoConnected channel id; omit to consider all channels

Output:

{
  "success": true,
  "data": {
    "date": "2026-06-27T14:00:00.000Z"
  }
}

postsStatus

Flip a post row between draft and scheduled at the stored publish time.

Input:

FieldTypeRequiredDescription
postIdstringYesPost row id from postsList or schedulePostTool
statusdraft | schedule | scheduledYesschedule and scheduled both mean scheduled

Output:

{
  "success": true,
  "data": {
    "postGroup": "<post-group-id>",
    "posts": []
  }
}

postsReschedule

Move a post group to a new publish time. Pass any post row id from postsList — the whole group moves together.

Input:

FieldTypeRequiredDescription
postIdstringYesPost row id from postsList or schedulePostTool
scheduledAtstringYesNew publish time (ISO-8601)
actionupdate | scheduleNoupdate (default) moves publishDate only and preserves each row’s state; schedule re-queues publishing and clears releaseId, releaseUrl, and errors
republishbooleanNoRequired true when action is schedule and the group already has published rows

Output:

{
  "success": true,
  "data": {
    "postGroup": "9a0a1b2c-3d4e-4f5a-9b8c-aa11bb22cc33",
    "posts": [
      {
        "id": "5b3c1d2e-9a3f-4e6b-bb12-2c0a5f1a90a1",
        "state": "QUEUE",
        "publishDate": "2026-06-15T14:30:00.000Z",
        "postGroup": "9a0a1b2c-3d4e-4f5a-9b8c-aa11bb22cc33"
      }
    ]
  }
}

postsReviewTodo

Set or update the review-todo note on a post row.

Input:

FieldTypeRequiredDescription
postIdstringYesPost row id
notestring | nullNoKanban review note; pass null to clear
isReviewedbooleanNoMark the review todo as complete
kanbanManualFinishAcknowledgedbooleanNoAcknowledge manual kanban finish for the post group

Output:

{
  "success": true,
  "data": {
    "posts": []
  }
}

postsDelete

Delete a post row by id.

Input:

FieldTypeRequiredDescription
postIdstringYesPost row id to delete

Output:

{
  "success": true,
  "data": {}
}

postsMissing

List provider candidates when a published post is missing release_id (needed before per-post analytics).

Input:

FieldTypeRequiredDescription
postIdstringYesPost row id with release_id missing

Output:

{
  "success": true,
  "data": {
    "items": []
  }
}

postsConnect

Link a post row to a provider release_id for per-post analytics.

Input:

FieldTypeRequiredDescription
postIdstringYesPost row id
releaseIdstringYesProvider release id from postsMissing candidates

Output:

{
  "success": true,
  "data": {}
}

Analytics

analyticsPlatform

Platform-level metrics for a connected channel.

Input:

FieldTypeRequiredDescription
integrationIdstringYesConnected channel id from integrationList
days7 | 30 | 90YesLookback window in days

Output:

{
  "success": true,
  "data": {}
}

analyticsPost

Per-post metrics for a published post row. Returns empty data for drafts.

Input:

FieldTypeRequiredDescription
postIdstringYesPublished post row id
days7 | 30 | 90YesLookback window in days

Output:

{
  "success": true,
  "data": {}
}

Global plugs

Global plugs are channel-level rules that fire when a published post’s likes cross a threshold. Per-post plugs are set on schedulePostTool.settings instead — internal plugs for same-account engagement and cross-account plugs for comments or reposts from other connected channels. See Global plugs and MCP examples for Threads, X, and LinkedIn.

plugsCatalog

List global plug types and field names per provider. No input.

Output: catalog of plug definitions with identifier, methodName, and fields arrays.

plugsList

List saved global plug rules on a connected channel.

Input:

FieldTypeRequiredDescription
integrationIdstringYesConnected channel id from integrationList

Output:

{
  "plugs": []
}

plugsUpsert

Create or update a global plug rule on a connected channel.

Input:

FieldTypeRequiredDescription
integrationIdstringYesConnected channel id
funcstringYesPlug function name from plugsCatalog (e.g. autoPlugPost)
fieldsarrayYesField values as name and valueor pairs matching the catalog
plugIdstringNoExisting plug row id to update instead of creating a duplicate

Output: saved plug row.

plugsActivate

Enable or disable a saved global plug rule.

Input:

FieldTypeRequiredDescription
plugIdstringYesPlug row id from plugsList
activatedbooleanYestrue to enable, false to disable

Output: updated plug row.

plugsDelete

Delete a saved global plug rule.

Input:

FieldTypeRequiredDescription
plugIdstringYesPlug row id from plugsList

Output: deletion confirmation.

Directory launch

Requires a workspace plan with directory launch enabled. Tools call the same services as /public/directory-launch/*. They manage My Products business profiles and browser-extension autofill — not schedulePostTool.

If the user asks…Start with
Create or open a PeerPush / Uneed profiledirectoryProfilesList (mainOnly: true) → directoryVariantsEnsure
Fill or update tagline, description, or site fieldsdirectoryProfilesUpdate on the variant productProfileId
What is missing before I launch?directoryListingSummary
Which launch paths exist?directoryDestinationsList

Agent prompt recipes: MCP examples — PeerPush, Uneed.

directoryDestinationsList

Published directory launch destinations (read-only catalog). Returns provider slugs, directorySiteKey values such as peerpush and uneed, and start URLs. Does not submit on directory sites.

Input: none

Output: array of destination rows (provider slug, site key, start URL).

directoryProfilesList

List business profiles for directory launch (not social integrationList channels). Use mainOnly: true before directoryVariantsEnsure to resolve the main productProfileId.

Input:

FieldTypeRequiredDescription
integrationCustomerIdstringNoChannel group id from groupList
mainOnlybooleanNoWhen true, exclude per-directory variants

Output: array of profile DTOs.

directoryProfilesGet

Load one main or variant profile: profileData, directorySiteKey, similarityToMainPercent on variants.

Input:

FieldTypeRequiredDescription
productProfileIdstringYesMain or variant product profile id

directoryProfilesCreate

Create a new main business profile (organization comes from the token). Does not create per-site variants — call directoryVariantsEnsure afterward.

Input: name (required) plus optional integrationCustomerId, tagline, description, websiteUrl, logoUrl, profileData object.

directoryProfilesUpdate

Patch copy on a main or directory-variant profile (tagline, description, websiteUrl, logoUrl, profileData). Use when the user asks to fill or revise tailored fields. Requires productProfileId plus at least one field to change.

directoryVariantsEnsure

Create or return a per-directory copy of a main profile (idempotent). Typical flow: list mains with mainOnly, then pass mainProductProfileId and directorySiteKey (peerpush, uneed, …). Copies the main profile on first create. Does not submit on the directory site.

Input:

FieldTypeRequiredDescription
mainProductProfileIdstringYesMain profile id (not a variant id)
directorySiteKeystringYesKebab-case site key
namestringNoOptional variant display name

Output: profile DTO plus created boolean.

directoryListingSummary

Read-only launch readiness per published destination: submission status and missing profile fields before extension autofill.

Input: productProfileId (required) — main or variant id.

directorySubmissionsList

Read-only submission history (listing URLs, completion). Optional productProfileId and destinationId filters.

Directory SEO

Requires directory SEO on the plan. Metrics are cached — each domain metric includes checkedAt; overview responses include manualRefreshAvailableAt before calling directorySeoRefresh.

directorySeoOverview

Cached directory SEO workspace overview for a main product profile (product domain metric and competitors). Read checkedAt before directorySeoRefresh.

Input: productProfileId (required).

directorySeoHistory

Historical rating points for the product domain and tracked competitors.

Input: productProfileId (required), optional days (default 90, max 366).

directorySeoRefresh

Manual refresh when cooldown allows (or force when supported).

Input: productProfileId (required), optional force boolean.

directorySeoCompetitorsAdd

Add a competitor domain (workspace competitor quota applies).

Input: domain (required), optional label and sortOrder.

directorySeoCompetitorsRemove

Input: domain (required).

directorySeoCompetitorsUpdate

Input: domain (required), label (nullable).

Search documentation
Find a docs page
Discord Support