MCP Tools
Tool signatures, parameters, paging and segmentation rules, and rate limits generated from active server schemas.
MuseCanto exposes a suite of strongly typed, sandboxed tools designed for direct invocation by AI agents in Cursor, Claude Code, Windsurf, and custom orchestrators.
Global Invocation Guidelines
Explicit Workspace Routing (organizationSlug)
All workspace-scoped tools require organizationSlug. Call
list_organizations first to obtain valid slugs and verify canRead /
canWrite flags.
Idempotency Guarantees (idempotencyKey)
Mutation operations (e.g., create_document, create_x_thread_draft)
require a unique idempotencyKey. The server caches outcomes for 24 hours
under the same key.
Rate Limits & Execution Budgets
- Rate Limit: 60/120/180 requests and 10/30/60 writes per minute by plan
(env values are an operations ceiling). - Request Body & Timeout: Request
bodies capped at 256 KiB with a strict 15-second execution timeout budget. -
Pagination & Segments: Document bodies are read in segments (default 8,000
characters, max 20,000). Inspect
truncatedand query subsequent segments vianextOffset.
Dynamically Generated Schema Reference
The tool definitions below are generated automatically from the active MCP server schema:
whoami
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {}
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"workspacePolicy": {
"type": "string",
"const": "all-current-and-future-memberships"
},
"writePolicy": {
"type": "string",
"const": "membership-and-workspace-quotas"
}
},
"required": [
"user",
"scopes",
"workspacePolicy",
"writePolicy"
],
"additionalProperties": false
}list_publish_platforms
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"contentKind": {
"description": "Only return platforms that can receive this content type.",
"type": "string",
"enum": [
"document",
"x_thread"
]
}
}
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"nameEn": {
"type": "string"
},
"region": {
"type": "string"
},
"channels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"driver": {
"type": "string"
},
"mode": {
"type": "string"
},
"contentKind": {
"type": "string"
},
"requiredFeature": {
"type": [
"string",
"null"
]
}
},
"required": [
"driver",
"mode",
"contentKind",
"requiredFeature"
],
"additionalProperties": false
}
}
},
"required": [
"key",
"name",
"nameEn",
"region",
"channels"
],
"additionalProperties": false
}
}
},
"required": [
"items"
],
"additionalProperties": false
}list_organizations
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"offset": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 50
}
}
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"planId": {
"type": "string"
},
"canRead": {
"type": "boolean"
},
"canWrite": {
"type": "boolean"
}
},
"required": [
"id",
"slug",
"name",
"role",
"planId",
"canRead",
"canWrite"
],
"additionalProperties": false
}
},
"nextOffset": {
"type": [
"number",
"null"
]
}
},
"required": [
"items",
"nextOffset"
],
"additionalProperties": false
}list_topics
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"offset": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"categoryId": {
"type": "string",
"maxLength": 64
}
},
"required": [
"organizationSlug"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"emoji": {
"type": [
"string",
"null"
]
},
"sourceDocumentId": {
"type": [
"string",
"null"
]
},
"channel": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"updatedAt": {
"type": "string"
},
"bookId": {
"type": "string"
},
"bookSlug": {
"type": "string"
},
"locale": {
"type": [
"string",
"null"
]
},
"publishStatus": {
"type": "string",
"enum": [
"draft",
"published"
]
},
"publishedAt": {
"type": [
"string",
"null"
]
},
"publishedPlatformCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"url": {
"type": "string"
},
"excerpt": {
"type": "string",
"maxLength": 300
},
"planning": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "topic"
},
"intendedType": {
"type": "string",
"enum": [
"document",
"x_thread"
]
},
"categoryId": {
"type": "string"
},
"startsAt": {
"type": [
"string",
"null"
]
},
"endsAt": {
"type": [
"string",
"null"
]
},
"allDay": {
"type": "boolean"
},
"completed": {
"type": "boolean"
},
"completedAt": {
"type": [
"string",
"null"
]
},
"archivedAt": {
"type": [
"string",
"null"
]
}
},
"required": [
"kind",
"intendedType",
"categoryId",
"startsAt",
"endsAt",
"allDay",
"completed",
"completedAt",
"archivedAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"slug",
"name",
"type",
"description",
"updatedAt",
"bookId",
"bookSlug",
"locale",
"publishStatus",
"publishedAt",
"publishedPlatformCount",
"url",
"excerpt",
"planning"
],
"additionalProperties": false
}
},
"nextOffset": {
"type": [
"number",
"null"
]
}
},
"required": [
"items",
"nextOffset"
],
"additionalProperties": false
}get_topic
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"topicId": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"organizationSlug",
"topicId"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"emoji": {
"type": [
"string",
"null"
]
},
"sourceDocumentId": {
"type": [
"string",
"null"
]
},
"channel": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"updatedAt": {
"type": "string"
},
"bookId": {
"type": "string"
},
"bookSlug": {
"type": "string"
},
"locale": {
"type": [
"string",
"null"
]
},
"publishStatus": {
"type": "string",
"enum": [
"draft",
"published"
]
},
"publishedAt": {
"type": [
"string",
"null"
]
},
"publishedPlatformCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"url": {
"type": "string"
},
"angle": {
"type": "string",
"maxLength": 4000
},
"planning": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "topic"
},
"intendedType": {
"type": "string",
"enum": [
"document",
"x_thread"
]
},
"categoryId": {
"type": "string"
},
"startsAt": {
"type": [
"string",
"null"
]
},
"endsAt": {
"type": [
"string",
"null"
]
},
"allDay": {
"type": "boolean"
},
"completed": {
"type": "boolean"
},
"completedAt": {
"type": [
"string",
"null"
]
},
"archivedAt": {
"type": [
"string",
"null"
]
}
},
"required": [
"kind",
"intendedType",
"categoryId",
"startsAt",
"endsAt",
"allDay",
"completed",
"completedAt",
"archivedAt"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"slug",
"name",
"type",
"description",
"updatedAt",
"bookId",
"bookSlug",
"locale",
"publishStatus",
"publishedAt",
"publishedPlatformCount",
"url",
"angle",
"planning"
],
"additionalProperties": false
}
},
"required": [
"resource"
],
"additionalProperties": false
}list_topic_categories
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"offset": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"required": [
"organizationSlug"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"nextOffset": {
"type": [
"number",
"null"
]
},
"defaultCategoryId": {
"type": "string"
}
},
"required": [
"items",
"nextOffset",
"defaultCategoryId"
],
"additionalProperties": false
}create_topic
Write · all plans, subject to library, storage, and rate limits · mcp:write
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 128,
"description": "Unique key for this write; reuse identical arguments when retrying (24-hour replay window)"
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"angle": {
"type": "string",
"maxLength": 4000
},
"intendedType": {
"default": "document",
"description": "Defaults to document. Use x_thread only for planned X posts, never for todos.",
"type": "string",
"enum": [
"document",
"x_thread"
]
},
"categoryId": {
"description": "Defaults to todo (preset 待办). Call list_topic_categories for other IDs.",
"type": "string",
"maxLength": 64
},
"startsAt": {
"description": "Calendar start YYYY-MM-DDTHH:mm:ss. Omit to use today UTC 00:00:00 as an all-day event.",
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"
},
{
"type": "null"
}
]
},
"endsAt": {
"description": "Calendar end YYYY-MM-DDTHH:mm:ss. Omit to derive from startsAt.",
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$"
},
{
"type": "null"
}
]
},
"allDay": {
"default": false,
"type": "boolean"
}
},
"required": [
"organizationSlug",
"idempotencyKey",
"title"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"emoji": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"url": {
"type": "string"
},
"bookId": {
"type": "string"
},
"bookSlug": {
"type": "string"
},
"bookName": {
"type": "string"
},
"isContentInbox": {
"type": "boolean"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"id",
"name",
"updatedAt",
"url"
],
"additionalProperties": false
}
},
"required": [
"resource"
],
"additionalProperties": false
}list_books
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"offset": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"required": [
"organizationSlug"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"layout": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"slug",
"name",
"description",
"layout",
"updatedAt"
],
"additionalProperties": false
}
},
"nextOffset": {
"type": [
"number",
"null"
]
}
},
"required": [
"items",
"nextOffset"
],
"additionalProperties": false
}get_book
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"bookId": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"organizationSlug",
"bookId"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"layout": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"slug",
"name",
"description",
"layout",
"updatedAt"
],
"additionalProperties": false
}
},
"required": [
"resource"
],
"additionalProperties": false
}create_book
Write · all plans, subject to library, storage, and rate limits · mcp:write
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 128,
"description": "Unique key for this write; reuse identical arguments when retrying (24-hour replay window)"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"description": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"organizationSlug",
"idempotencyKey",
"name"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"emoji": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"url": {
"type": "string"
},
"bookId": {
"type": "string"
},
"bookSlug": {
"type": "string"
},
"bookName": {
"type": "string"
},
"isContentInbox": {
"type": "boolean"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"id",
"name",
"updatedAt",
"url"
],
"additionalProperties": false
}
},
"required": [
"resource"
],
"additionalProperties": false
}list_documents
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"bookId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"offset": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"required": [
"organizationSlug",
"bookId"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"emoji": {
"type": [
"string",
"null"
]
},
"sourceDocumentId": {
"type": [
"string",
"null"
]
},
"channel": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"updatedAt": {
"type": "string"
},
"bookId": {
"type": "string"
},
"bookSlug": {
"type": "string"
},
"locale": {
"type": [
"string",
"null"
]
},
"publishStatus": {
"type": "string",
"enum": [
"draft",
"published"
]
},
"publishedAt": {
"type": [
"string",
"null"
]
},
"publishedPlatformCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"url": {
"type": "string"
},
"excerpt": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"slug",
"name",
"type",
"description",
"updatedAt",
"bookId",
"bookSlug",
"locale",
"publishStatus",
"publishedAt",
"publishedPlatformCount",
"url",
"excerpt"
],
"additionalProperties": false
}
},
"nextOffset": {
"type": [
"number",
"null"
]
}
},
"required": [
"items",
"nextOffset"
],
"additionalProperties": false
}search_documents
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"bookId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"offset": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"query": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"organizationSlug",
"query"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"emoji": {
"type": [
"string",
"null"
]
},
"sourceDocumentId": {
"type": [
"string",
"null"
]
},
"channel": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"updatedAt": {
"type": "string"
},
"bookId": {
"type": "string"
},
"bookSlug": {
"type": "string"
},
"locale": {
"type": [
"string",
"null"
]
},
"publishStatus": {
"type": "string",
"enum": [
"draft",
"published"
]
},
"publishedAt": {
"type": [
"string",
"null"
]
},
"publishedPlatformCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"url": {
"type": "string"
},
"excerpt": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"slug",
"name",
"type",
"description",
"updatedAt",
"bookId",
"bookSlug",
"locale",
"publishStatus",
"publishedAt",
"publishedPlatformCount",
"url",
"excerpt"
],
"additionalProperties": false
}
},
"nextOffset": {
"type": [
"number",
"null"
]
}
},
"required": [
"items",
"nextOffset"
],
"additionalProperties": false
}get_document
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"documentId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"offset": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"length": {
"default": 8000,
"type": "integer",
"minimum": 1,
"maximum": 20000
}
},
"required": [
"organizationSlug",
"documentId"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"emoji": {
"type": [
"string",
"null"
]
},
"sourceDocumentId": {
"type": [
"string",
"null"
]
},
"channel": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"updatedAt": {
"type": "string"
},
"bookId": {
"type": "string"
},
"bookSlug": {
"type": "string"
},
"locale": {
"type": [
"string",
"null"
]
},
"publishStatus": {
"type": "string",
"enum": [
"draft",
"published"
]
},
"publishedAt": {
"type": [
"string",
"null"
]
},
"publishedPlatformCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"url": {
"type": "string"
},
"version": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"markdown": {
"type": "string"
},
"totalLength": {
"type": "number"
}
},
"required": [
"id",
"slug",
"name",
"type",
"description",
"updatedAt",
"bookId",
"bookSlug",
"locale",
"publishStatus",
"publishedAt",
"publishedPlatformCount",
"url",
"version",
"markdown",
"totalLength"
],
"additionalProperties": false
},
"truncated": {
"type": "boolean"
},
"nextOffset": {
"type": [
"number",
"null"
]
}
},
"required": [
"resource",
"truncated",
"nextOffset"
],
"additionalProperties": false
}update_document
Write · all plans, subject to library, storage, and rate limits · mcp:write
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 128,
"description": "Unique key for this write; reuse identical arguments when retrying (24-hour replay window)"
},
"documentId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"baseRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "version from get_document. Read all segments at the same version before replacing Markdown."
},
"markdown": {
"type": "string",
"minLength": 1,
"maxLength": 100000
},
"title": {
"description": "Optional title, 1–150 characters after trimming. Omit to leave the current title unchanged. Empty and oversized titles are rejected.",
"type": "string",
"minLength": 1,
"maxLength": 150
}
},
"required": [
"organizationSlug",
"idempotencyKey",
"documentId",
"baseRevision",
"markdown"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"emoji": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"url": {
"type": "string"
},
"bookId": {
"type": "string"
},
"bookSlug": {
"type": "string"
},
"bookName": {
"type": "string"
},
"isContentInbox": {
"type": "boolean"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"id",
"name",
"updatedAt",
"url",
"version"
],
"additionalProperties": false
}
},
"required": [
"resource"
],
"additionalProperties": false
}list_publish_tasks
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"offset": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"documentId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"state": {
"type": "string",
"enum": [
"planned",
"copied",
"draft",
"confirmation",
"scheduled",
"running",
"published",
"failed",
"unknown",
"cancelled"
]
}
},
"required": [
"organizationSlug"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"docId": {
"type": "string"
},
"docSlug": {
"type": "string"
},
"bookSlug": {
"type": "string"
},
"title": {
"type": "string"
},
"platform": {
"type": [
"string",
"null"
]
},
"account": {
"type": [
"string",
"null"
]
},
"mode": {
"type": "string"
},
"source": {
"type": "string",
"const": "schedule"
},
"state": {
"type": "string",
"enum": [
"planned",
"copied",
"draft",
"confirmation",
"scheduled",
"running",
"published",
"failed",
"unknown",
"cancelled"
]
},
"at": {
"type": [
"string",
"null"
]
},
"allDay": {
"type": "boolean"
},
"error": {
"type": [
"string",
"null"
]
},
"urls": {
"type": "array",
"items": {
"type": "string"
}
},
"jobId": {
"type": [
"string",
"null"
]
},
"resolved": {
"type": "boolean"
},
"nextAction": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"id",
"docId",
"docSlug",
"bookSlug",
"title",
"platform",
"account",
"mode",
"source",
"state",
"at",
"allDay",
"error",
"urls",
"jobId",
"nextAction",
"url"
],
"additionalProperties": false
}
},
"nextOffset": {
"type": [
"number",
"null"
]
},
"truncated": {
"type": "boolean"
}
},
"required": [
"items",
"nextOffset",
"truncated"
],
"additionalProperties": false
}get_publish_task
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"taskId": {
"type": "string",
"maxLength": 250,
"pattern": "^schedule:[^:]+$",
"description": "Exact schedule: id from list_publish_tasks."
}
},
"required": [
"organizationSlug",
"taskId"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"docId": {
"type": "string"
},
"docSlug": {
"type": "string"
},
"bookSlug": {
"type": "string"
},
"title": {
"type": "string"
},
"platform": {
"type": [
"string",
"null"
]
},
"account": {
"type": [
"string",
"null"
]
},
"mode": {
"type": "string"
},
"source": {
"type": "string",
"const": "schedule"
},
"state": {
"type": "string",
"enum": [
"planned",
"copied",
"draft",
"confirmation",
"scheduled",
"running",
"published",
"failed",
"unknown",
"cancelled"
]
},
"at": {
"type": [
"string",
"null"
]
},
"allDay": {
"type": "boolean"
},
"error": {
"type": [
"string",
"null"
]
},
"urls": {
"type": "array",
"items": {
"type": "string"
}
},
"jobId": {
"type": [
"string",
"null"
]
},
"resolved": {
"type": "boolean"
},
"nextAction": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"id",
"docId",
"docSlug",
"bookSlug",
"title",
"platform",
"account",
"mode",
"source",
"state",
"at",
"allDay",
"error",
"urls",
"jobId",
"nextAction",
"url"
],
"additionalProperties": false
},
"snapshot": {
"anyOf": [
{
"type": "object",
"properties": {
"capturedAt": {
"type": "string"
},
"contentHash": {
"type": "string"
},
"changed": {
"type": "boolean"
},
"postCount": {
"type": "number"
},
"preview": {
"type": "string",
"maxLength": 8000
},
"truncated": {
"type": "boolean"
}
},
"required": [
"capturedAt",
"contentHash",
"changed",
"postCount",
"preview",
"truncated"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"resource",
"snapshot"
],
"additionalProperties": false
}prepare_publish
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"documentId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"method": {
"type": "string",
"enum": [
"x_immediate",
"x_scheduled"
],
"description": "X thread publication only. Long-form article publishing is not available through MCP."
},
"xUserId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"runAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"timeZone": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"organizationSlug",
"documentId",
"method"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"documentId": {
"type": "string"
},
"version": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"updatedAt": {
"type": "string"
},
"method": {
"type": "string",
"enum": [
"x_immediate",
"x_scheduled"
]
},
"ready": {
"type": "boolean"
},
"executed": {
"type": "boolean",
"const": false
},
"scheduled": {
"type": "boolean",
"const": false
},
"target": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"const": "x"
},
"mode": {
"type": "string",
"const": "post"
}
},
"required": [
"platform",
"mode"
],
"additionalProperties": false
},
"account": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"username"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"runAt": {
"type": [
"string",
"null"
]
},
"timeZone": {
"type": [
"string",
"null"
]
},
"localTime": {
"type": [
"string",
"null"
]
},
"checks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"level": {
"type": "string",
"enum": [
"error",
"warning"
]
},
"message": {
"type": "string"
}
},
"required": [
"code",
"level",
"message"
],
"additionalProperties": false
}
},
"postLengths": {
"type": "array",
"items": {
"type": "number"
}
},
"nextAction": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"documentId",
"version",
"updatedAt",
"method",
"ready",
"executed",
"scheduled",
"target",
"account",
"runAt",
"timeZone",
"localTime",
"checks",
"postLengths",
"nextAction",
"url"
],
"additionalProperties": false
}request_publish_approval
Write · all plans, subject to library, storage, and rate limits · mcp:write
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 128,
"description": "Unique key for this write; reuse identical arguments when retrying (24-hour replay window)"
},
"documentId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"expectedUpdatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
"method": {
"type": "string",
"enum": [
"x_immediate",
"x_scheduled"
]
},
"xUserId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"runAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"timeZone": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"organizationSlug",
"idempotencyKey",
"documentId",
"expectedUpdatedAt",
"method",
"xUserId"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"approval": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"organizationSlug": {
"type": "string"
},
"documentId": {
"type": "string"
},
"title": {
"type": "string"
},
"clientName": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"pending",
"approved",
"executed",
"revoked",
"expired",
"changed",
"disconnected"
]
},
"method": {
"type": "string",
"enum": [
"x_immediate",
"x_scheduled"
]
},
"account": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"id",
"username"
],
"additionalProperties": false
},
"runAt": {
"type": [
"string",
"null"
]
},
"timeZone": {
"type": [
"string",
"null"
]
},
"expiresAt": {
"type": "string"
},
"contentHash": {
"type": "string"
},
"documentUpdatedAt": {
"type": "string"
},
"posts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"images": {
"type": "array",
"items": {
"type": "string"
}
},
"referenceUrl": {
"type": [
"string",
"null"
]
},
"referenceMode": {
"default": null,
"anyOf": [
{
"type": "string",
"enum": [
"link",
"quote",
"reply"
]
},
{
"type": "null"
}
]
}
},
"required": [
"text",
"images",
"referenceUrl",
"referenceMode"
],
"additionalProperties": false
}
},
"taskId": {
"type": [
"string",
"null"
]
},
"reviewUrl": {
"type": "string"
},
"documentUrl": {
"type": "string"
}
},
"required": [
"id",
"organizationSlug",
"documentId",
"title",
"clientName",
"status",
"method",
"account",
"runAt",
"timeZone",
"expiresAt",
"contentHash",
"documentUpdatedAt",
"posts",
"taskId",
"reviewUrl",
"documentUrl"
],
"additionalProperties": false
}
},
"required": [
"approval"
],
"additionalProperties": false
}get_publish_approval
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"approvalId": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"organizationSlug",
"approvalId"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"approval": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"organizationSlug": {
"type": "string"
},
"documentId": {
"type": "string"
},
"title": {
"type": "string"
},
"clientName": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"pending",
"approved",
"executed",
"revoked",
"expired",
"changed",
"disconnected"
]
},
"method": {
"type": "string",
"enum": [
"x_immediate",
"x_scheduled"
]
},
"account": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"id",
"username"
],
"additionalProperties": false
},
"runAt": {
"type": [
"string",
"null"
]
},
"timeZone": {
"type": [
"string",
"null"
]
},
"expiresAt": {
"type": "string"
},
"contentHash": {
"type": "string"
},
"documentUpdatedAt": {
"type": "string"
},
"posts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"images": {
"type": "array",
"items": {
"type": "string"
}
},
"referenceUrl": {
"type": [
"string",
"null"
]
},
"referenceMode": {
"default": null,
"anyOf": [
{
"type": "string",
"enum": [
"link",
"quote",
"reply"
]
},
{
"type": "null"
}
]
}
},
"required": [
"text",
"images",
"referenceUrl",
"referenceMode"
],
"additionalProperties": false
}
},
"taskId": {
"type": [
"string",
"null"
]
},
"reviewUrl": {
"type": "string"
},
"documentUrl": {
"type": "string"
}
},
"required": [
"id",
"organizationSlug",
"documentId",
"title",
"clientName",
"status",
"method",
"account",
"runAt",
"timeZone",
"expiresAt",
"contentHash",
"documentUpdatedAt",
"posts",
"taskId",
"reviewUrl",
"documentUrl"
],
"additionalProperties": false
}
},
"required": [
"approval"
],
"additionalProperties": false
}execute_publish
Write · all plans, subject to library, storage, and rate limits · mcp:write
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"approvalId": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"organizationSlug",
"approvalId"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"taskId": {
"type": "string"
},
"accepted": {
"type": "boolean",
"const": true
},
"nextAction": {
"type": "string"
}
},
"required": [
"taskId",
"accepted",
"nextAction"
],
"additionalProperties": false
}get_writing_preferences
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
}
},
"required": [
"organizationSlug"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"text": {
"type": "string"
},
"revision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"updatedAt": {
"type": [
"string",
"null"
]
}
},
"required": [
"text",
"revision",
"updatedAt"
],
"additionalProperties": false
}update_writing_preferences
Write · all plans, subject to library, storage, and rate limits · mcp:write
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 128,
"description": "Unique key for this write; reuse identical arguments when retrying (24-hour replay window)"
},
"expectedRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"text": {
"type": "string",
"maxLength": 8000
},
"userProvided": {
"type": "boolean",
"const": true,
"description": "Only save preferences the user explicitly supplied or asked you to remember. Never infer preferences from chat history. Empty text clears them."
}
},
"required": [
"organizationSlug",
"idempotencyKey",
"expectedRevision",
"text",
"userProvided"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"text": {
"type": "string"
},
"revision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"updatedAt": {
"type": [
"string",
"null"
]
}
},
"required": [
"text",
"revision",
"updatedAt"
],
"additionalProperties": false
}list_content_variants
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"offset": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"sourceDocumentId": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"organizationSlug",
"sourceDocumentId"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"emoji": {
"type": [
"string",
"null"
]
},
"sourceDocumentId": {
"type": [
"string",
"null"
]
},
"channel": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"updatedAt": {
"type": "string"
},
"bookId": {
"type": "string"
},
"bookSlug": {
"type": "string"
},
"locale": {
"type": [
"string",
"null"
]
},
"publishStatus": {
"type": "string",
"enum": [
"draft",
"published"
]
},
"publishedAt": {
"type": [
"string",
"null"
]
},
"publishedPlatformCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"url": {
"type": "string"
}
},
"required": [
"id",
"slug",
"name",
"type",
"description",
"updatedAt",
"bookId",
"bookSlug",
"locale",
"publishStatus",
"publishedAt",
"publishedPlatformCount",
"url"
],
"additionalProperties": false
}
},
"nextOffset": {
"type": [
"number",
"null"
]
}
},
"required": [
"items",
"nextOffset"
],
"additionalProperties": false
}create_document
Write · all plans, subject to library, storage, and rate limits · mcp:write
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"bookId": {
"description": "Optional standard library ID. Omit to save in this workspace's Content inbox.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 128,
"description": "Unique key for this write; reuse identical arguments when retrying (24-hour replay window)"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"emoji": {
"description": "Optional single Unicode emoji for the article icon, e.g. 📝, 🇨🇳 or 👩🏽💻. Omit or pass null for no icon. Text, shortcodes and multiple emojis are rejected.",
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"markdown": {
"type": "string",
"minLength": 1,
"maxLength": 100000
},
"description": {
"type": "string",
"maxLength": 200
},
"parentId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"sourceDocumentId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"channel": {
"description": "Target platform key for this content variant. Call list_publish_platforms for valid keys.",
"type": "string",
"pattern": "^[a-z][a-z0-9_-]{0,31}$"
}
},
"required": [
"organizationSlug",
"idempotencyKey",
"name",
"markdown"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"emoji": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"url": {
"type": "string"
},
"bookId": {
"type": "string"
},
"bookSlug": {
"type": "string"
},
"bookName": {
"type": "string"
},
"isContentInbox": {
"type": "boolean"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"id",
"name",
"updatedAt",
"url"
],
"additionalProperties": false
}
},
"required": [
"resource"
],
"additionalProperties": false
}list_x_accounts
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"offset": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 50
}
}
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": [
"string",
"null"
]
},
"isDefault": {
"type": "boolean"
},
"connectedAt": {
"type": "string"
}
},
"required": [
"id",
"username",
"isDefault",
"connectedAt"
],
"additionalProperties": false
}
},
"nextOffset": {
"type": [
"number",
"null"
]
}
},
"required": [
"items",
"nextOffset"
],
"additionalProperties": false
}get_x_thread
Read · all plans · mcp:read
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"documentId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"offset": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"length": {
"default": 8000,
"type": "integer",
"minimum": 1,
"maximum": 20000
}
},
"required": [
"organizationSlug",
"documentId"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"emoji": {
"type": [
"string",
"null"
]
},
"sourceDocumentId": {
"type": [
"string",
"null"
]
},
"channel": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"updatedAt": {
"type": "string"
},
"bookId": {
"type": "string"
},
"bookSlug": {
"type": "string"
},
"locale": {
"type": [
"string",
"null"
]
},
"publishStatus": {
"type": "string",
"enum": [
"draft",
"published"
]
},
"publishedAt": {
"type": [
"string",
"null"
]
},
"publishedPlatformCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"url": {
"type": "string"
},
"posts": {
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string",
"maxLength": 20000
},
"textOffset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"media": {
"default": [],
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"key": {
"type": "string"
},
"alt": {
"type": "string"
}
},
"required": [
"id",
"url"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"text",
"textOffset",
"media"
],
"additionalProperties": false
}
},
"totalLength": {
"type": "number"
},
"editable": {
"type": "boolean"
}
},
"required": [
"id",
"slug",
"name",
"type",
"description",
"updatedAt",
"bookId",
"bookSlug",
"locale",
"publishStatus",
"publishedAt",
"publishedPlatformCount",
"url",
"posts",
"totalLength",
"editable"
],
"additionalProperties": false
},
"truncated": {
"type": "boolean"
},
"nextOffset": {
"type": [
"number",
"null"
]
}
},
"required": [
"resource",
"truncated",
"nextOffset"
],
"additionalProperties": false
}create_x_thread_draft
Write · all plans, subject to library, storage, and rate limits · mcp:write
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"bookId": {
"description": "Optional standard library ID. Omit to save in this workspace's Content inbox.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 128,
"description": "Unique key for this write; reuse identical arguments when retrying (24-hour replay window)"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"posts": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 50000
},
"description": "Ordered plain-text posts; no publishing, media or references"
},
"sourceDocumentId": {
"description": "Optional source article in this workspace; independent drafts can omit it.",
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"organizationSlug",
"idempotencyKey",
"name",
"posts"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"emoji": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"url": {
"type": "string"
},
"bookId": {
"type": "string"
},
"bookSlug": {
"type": "string"
},
"bookName": {
"type": "string"
},
"isContentInbox": {
"type": "boolean"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"id",
"name",
"updatedAt",
"url"
],
"additionalProperties": false
}
},
"required": [
"resource"
],
"additionalProperties": false
}update_x_thread
Write · all plans, subject to library, storage, and rate limits · mcp:write
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"documentId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"posts": {
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 50000
},
"description": "Ordered plain-text posts; no publishing, media or references"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 128,
"description": "Unique key for this write; reuse identical arguments when retrying (24-hour replay window)"
},
"expectedUpdatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "updatedAt from get_x_thread; read again after a conflict"
},
"title": {
"description": "Optional title, 1–150 characters after trimming. Omit to leave the current title unchanged. Empty and oversized titles are rejected.",
"type": "string",
"minLength": 1,
"maxLength": 150
}
},
"required": [
"organizationSlug",
"documentId",
"posts",
"expectedUpdatedAt"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"emoji": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"url": {
"type": "string"
},
"bookId": {
"type": "string"
},
"bookSlug": {
"type": "string"
},
"bookName": {
"type": "string"
},
"isContentInbox": {
"type": "boolean"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"id",
"name",
"updatedAt",
"url"
],
"additionalProperties": false
}
},
"required": [
"resource"
],
"additionalProperties": false
}create_image_upload
Write · all plans, subject to library, storage, and rate limits · mcp:write
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 128,
"description": "Unique key for this write; reuse identical arguments when retrying (24-hour replay window)"
},
"extension": {
"type": "string",
"enum": [
"gif",
"jpeg",
"jpg",
"png",
"webp"
]
},
"fileSize": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 20971520,
"description": "Image file size in bytes; maximum 20MB"
},
"alt": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"organizationSlug",
"idempotencyKey",
"extension",
"fileSize"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"uploadUrl": {
"type": "string"
},
"key": {
"type": "string"
},
"publicUrl": {
"type": "string"
},
"contentType": {
"type": "string"
},
"expiresInSeconds": {
"type": "number"
},
"organizationId": {
"type": "string"
}
},
"required": [
"uploadUrl",
"key",
"publicUrl",
"contentType",
"expiresInSeconds",
"organizationId"
],
"additionalProperties": false
}confirm_image_upload
Write · all plans, subject to library, storage, and rate limits · mcp:write
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"idempotencyKey": {
"type": "string",
"minLength": 8,
"maxLength": 128,
"description": "Unique key for this write; reuse identical arguments when retrying (24-hour replay window)"
},
"key": {
"type": "string",
"minLength": 1,
"maxLength": 600,
"description": "Storage key returned from create_image_upload"
},
"alt": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"organizationSlug",
"idempotencyKey",
"key"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"publicUrl": {
"type": "string"
},
"contentType": {
"type": [
"string",
"null"
]
},
"sizeBytes": {
"type": "number"
},
"markdown": {
"type": "string"
}
},
"required": [
"id",
"key",
"publicUrl",
"contentType",
"sizeBytes",
"markdown"
],
"additionalProperties": false
}
},
"required": [
"resource"
],
"additionalProperties": false
}attach_image_to_x_thread
Write · all plans, subject to library, storage, and rate limits · mcp:write
Input fields and limits (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"organizationSlug": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Target workspace slug from list_organizations"
},
"documentId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"key": {
"type": "string",
"minLength": 1,
"maxLength": 600,
"description": "Confirmed image storage key from confirm_image_upload"
},
"expectedUpdatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "updatedAt from get_x_thread; read again after a conflict"
},
"postIndex": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 49
},
"postId": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"alt": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"organizationSlug",
"documentId",
"key",
"expectedUpdatedAt"
]
}Response structure (JSON Schema)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"resource": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"emoji": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"url": {
"type": "string"
},
"bookId": {
"type": "string"
},
"bookSlug": {
"type": "string"
},
"bookName": {
"type": "string"
},
"isContentInbox": {
"type": "boolean"
},
"version": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"id",
"name",
"updatedAt",
"url"
],
"additionalProperties": false
}
},
"required": [
"resource"
],
"additionalProperties": false
}Next Steps
To see these tools assembled into multi-step agent workflows, check out Practical Workflows & Prompt Examples.