Docmino is an MCP server published by io.github.docmino, hosted at mcp.docmino.com. When last checked on 2026-11-21 it was working: it answers and lists its tools. It declares 26 tools, including get_authoring_guide, search, fetch, list_workspaces, list_documents.
Create, edit, organize, and share interactive guides, lessons, forms, and client plans in Docmino.
Nothing else in the archive shares these values.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
Returns Docmino's MDX authoring documentation for document and page content, including supported interactive component props and working examples. The default guide covers common components; a component selection returns focused schemas and examples with companion components included automatically.
| Parameter | Type | Description |
|---|---|---|
| components | array | Optional component names for focused schemas and examples. When omitted, the default authoring guide is returned. |
{
"name": "get_authoring_guide",
"title": "Get Authoring Guide",
"description": "Returns Docmino's MDX authoring documentation for document and page content, including supported interactive component props and working examples. The default guide covers common components; a component selection returns focused schemas and examples with companion components included automatically.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"components": {
"type": "array",
"items": {
"enum": [
"Accordion",
"Accordion.Item",
"Board",
"Booking",
"Calendar",
"Callout",
"Carousel",
"Carousel.Item",
"Chart.Area",
"Chart.Bar",
"Chart.Line",
"Chart.Pie",
"Columns",
"Columns.Item",
"Data",
"Dialog",
"Embed",
"Input.Checkbox",
"Input.Color",
"Input.Counter",
"Input.Date",
"Input.DateTime",
"Input.Dropdown",
"Input.Number",
"Input.Rating",
"Input.Select",
"Input.Signature",
"Input.Slider",
"Input.Text",
"Input.TextArea",
"Input.Upload",
"Map",
"Payment",
"Poll",
"Question.Fill",
"Question.Match",
"Question.Open",
"Question.Select",
"Question.Sort",
"Question.Voice",
"Result",
"Row",
"Row.Item",
"Speech",
"Steps",
"Steps.Item",
"Submit",
"Tabs",
"Tabs.Item",
"Timer",
"Visualization"
],
"type": "string"
},
"maxItems": 51,
"description": "Optional component names for focused schemas and examples. When omitted, the default authoring guide is returned."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"guide"
],
"properties": {
"guide": {
"type": "string"
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}None yet. Changes appear after a server's second daily check.
Search document names and summaries accessible to your connected Docmino account. Returns up to 20 IDs, titles, canonical links, and hasMore; it does not search full page content. Use list_documents for workspace filters or pagination, then get_document for editable content.
| Parameter | Type | Description |
|---|---|---|
| query * | string | Words to match against accessible document names and summaries, not full page bodies. |
{
"name": "search",
"title": "Search",
"description": "Search document names and summaries accessible to your connected Docmino account. Returns up to 20 IDs, titles, canonical links, and hasMore; it does not search full page content. Use list_documents for workspace filters or pagination, then get_document for editable content.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"query"
],
"properties": {
"query": {
"type": "string",
"maxLength": 1000,
"description": "Words to match against accessible document names and summaries, not full page bodies."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"results",
"hasMore"
],
"properties": {
"hasMore": {
"type": "boolean"
},
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"title",
"url"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"title": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Retrieve a document by ID as a text result containing its serialized document snapshot, canonical link, and revision. For large documents, metadata.complete is false and text provides retrieval instructions instead of content; use list_pages and read_page. Use get_document for a structured editable snapshot.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug. |
{
"name": "fetch",
"title": "Fetch",
"description": "Retrieve a document by ID as a text result containing its serialized document snapshot, canonical link, and revision. For large documents, metadata.complete is false and text provides retrieval instructions instead of content; use list_pages and read_page. Use get_document for a structured editable snapshot.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id",
"title",
"url",
"text",
"metadata"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"text": {
"type": "string"
},
"title": {
"type": "string"
},
"metadata": {
"type": "object",
"required": [
"revision",
"complete"
],
"properties": {
"complete": {
"type": "boolean"
},
"revision": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List your personal account and a page of organization workspaces, returning their IDs and names. Use these IDs as workspaceId in document and project tools. Pagination applies to organizations; this tool does not create workspaces or manage membership.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Maximum records in this page, from 1 to 50; defaults to 20. |
| offset | integer | Zero-based number of records to skip. Increase by limit while more results are available. |
{
"name": "list_workspaces",
"title": "List Workspaces",
"description": "List your personal account and a page of organization workspaces, returning their IDs and names. Use these IDs as workspaceId in document and project tools. Pagination applies to organizations; this tool does not create workspaces or manage membership.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum records in this page, from 1 to 50; defaults to 20."
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0,
"description": "Zero-based number of records to skip. Increase by limit while more results are available."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"viewer"
],
"properties": {
"viewer": {
"type": "object",
"required": [
"id",
"name",
"organizations"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"organizations": {
"type": "object",
"required": [
"nodes",
"pageInfo"
],
"properties": {
"nodes": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
},
"pageInfo": {
"type": "object",
"required": [
"hasNextPage"
],
"properties": {
"hasNextPage": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List or search documents accessible in a workspace, returning metadata, canonical links, permissions, and pageInfo rather than page content. Omit workspaceId for your personal account; use an ID from list_workspaces for an organization. Use get_document to read a result and offset/limit to paginate.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Maximum records in this page, from 1 to 50; defaults to 20. |
| query | string | Optional words to match against document names and summaries; omit to browse. |
| offset | integer | Zero-based number of records to skip. Increase by limit while more results are available. |
| workspaceId | string | Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account. |
{
"name": "list_documents",
"title": "List Documents",
"description": "List or search documents accessible in a workspace, returning metadata, canonical links, permissions, and pageInfo rather than page content. Omit workspaceId for your personal account; use an ID from list_workspaces for an organization. Use get_document to read a result and offset/limit to paginate.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum records in this page, from 1 to 50; defaults to 20."
},
"query": {
"type": "string",
"maxLength": 1000,
"description": "Optional words to match against document names and summaries; omit to browse."
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0,
"description": "Zero-based number of records to skip. Increase by limit while more results are available."
},
"workspaceId": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"user"
],
"properties": {
"user": {
"anyOf": [
{
"type": "object",
"required": [
"searchDocs"
],
"properties": {
"searchDocs": {
"type": "object",
"required": [
"nodes",
"pageInfo"
],
"properties": {
"nodes": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
},
"pageInfo": {
"type": "object",
"required": [
"hasNextPage",
"hasPreviousPage"
],
"properties": {
"hasNextPage": {
"type": "boolean"
},
"hasPreviousPage": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List accessible projects, including shared projects, in a personal or organization workspace. Returns project IDs, names, descriptions, instructions, permissions, and pageInfo; omit workspaceId for your account. Use list_project_documents to browse a project’s documents.
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Maximum records in this page, from 1 to 50; defaults to 20. |
| offset | integer | Zero-based number of records to skip. Increase by limit while more results are available. |
| workspaceId | string | Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account. |
{
"name": "list_projects",
"title": "List Projects",
"description": "List accessible projects, including shared projects, in a personal or organization workspace. Returns project IDs, names, descriptions, instructions, permissions, and pageInfo; omit workspaceId for your account. Use list_project_documents to browse a project’s documents.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum records in this page, from 1 to 50; defaults to 20."
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0,
"description": "Zero-based number of records to skip. Increase by limit while more results are available."
},
"workspaceId": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"user"
],
"properties": {
"user": {
"anyOf": [
{
"type": "object",
"required": [
"projects"
],
"properties": {
"projects": {
"type": "object",
"required": [
"nodes",
"pageInfo"
],
"properties": {
"nodes": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"userId",
"name",
"description",
"instructions",
"viewerCanEdit",
"viewerCanManage"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
},
"pageInfo": {
"type": "object",
"required": [
"hasNextPage",
"hasPreviousPage"
],
"properties": {
"hasNextPage": {
"type": "boolean"
},
"hasPreviousPage": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read a project’s metadata, instructions, edit/manage permissions, and canonical link by project ID. Does not include its documents; use list_project_documents for those. Fails if the project is missing or inaccessible.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Project ID returned by list_projects, get_project, or create_project. |
{
"name": "get_project",
"title": "Get Project",
"description": "Read a project’s metadata, instructions, edit/manage permissions, and canonical link by project ID. Does not include its documents; use list_project_documents for those. Fails if the project is missing or inaccessible.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Project ID returned by list_projects, get_project, or create_project."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"project",
"url"
],
"properties": {
"url": {
"type": "string"
},
"project": {
"type": "object",
"required": [
"id",
"userId",
"name",
"description",
"instructions",
"viewerCanEdit",
"viewerCanManage"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List a page of accessible documents in a project by project ID. Returns document metadata, canonical links, permissions, and pageInfo, without page content. Use get_document for a document snapshot and offset/limit for the next page.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Project ID returned by list_projects, get_project, or create_project. |
| limit | integer | Maximum records in this page, from 1 to 50; defaults to 20. |
| offset | integer | Zero-based number of records to skip. Increase by limit while more results are available. |
{
"name": "list_project_documents",
"title": "List Project Documents",
"description": "List a page of accessible documents in a project by project ID. Returns document metadata, canonical links, permissions, and pageInfo, without page content. Use get_document for a document snapshot and offset/limit for the next page.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Project ID returned by list_projects, get_project, or create_project."
},
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum records in this page, from 1 to 50; defaults to 20."
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0,
"description": "Zero-based number of records to skip. Increase by limit while more results are available."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"node"
],
"properties": {
"node": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"docs"
],
"properties": {
"id": {
"type": "string"
},
"docs": {
"type": "object",
"required": [
"nodes",
"pageInfo"
],
"properties": {
"nodes": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
},
"pageInfo": {
"type": "object",
"required": [
"hasNextPage",
"hasPreviousPage"
],
"properties": {
"hasNextPage": {
"type": "boolean"
},
"hasPreviousPage": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read a document by ID, returning its structured MDX content, full nested page tree, metadata, permissions, canonical link, and current revision. Use this before update_document and preserve pages you are not changing. For oversized results use list_pages and read_page; use open_document to display the embedded editor.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug. |
{
"name": "get_document",
"title": "Get Document",
"description": "Read a document by ID, returning its structured MDX content, full nested page tree, metadata, permissions, canonical link, and current revision. Use this before update_document and preserve pages you are not changing. For oversized results use list_pages and read_page; use open_document to display the embedded editor.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
},
"__schema1": {
"type": "object",
"required": [
"id",
"name",
"slug",
"content",
"children"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"content": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"additionalProperties": false
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"document",
"revision",
"permissions",
"scopes",
"url"
],
"properties": {
"url": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"document": {
"type": "object",
"required": [
"id",
"user_id",
"project_id",
"name",
"summary",
"tags",
"slug",
"category",
"sub_category",
"status",
"access_scope",
"listed_publicly",
"language",
"comments_disabled",
"saves_disabled",
"position",
"content",
"pages"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"tags": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"pages": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
},
"status": {
"type": [
"string",
"null"
]
},
"content": {
"type": "string"
},
"summary": {
"type": [
"string",
"null"
]
},
"user_id": {
"type": [
"string",
"null"
]
},
"category": {
"type": [
"string",
"null"
]
},
"language": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"number",
"string",
"null"
]
},
"project_id": {
"type": [
"string",
"null"
]
},
"access_scope": {
"type": [
"string",
"null"
]
},
"sub_category": {
"type": [
"string",
"null"
]
},
"saves_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"listed_publicly": {
"type": [
"boolean",
"number",
"null"
]
},
"comments_disabled": {
"type": [
"boolean",
"number",
"null"
]
}
},
"additionalProperties": false
},
"revision": {
"type": "string"
},
"permissions": {
"type": "object",
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Display a document by ID in the embedded Docmino editor on clients that support MCP Apps. Returns the same document snapshot, revision, permissions, and canonical link as get_document. Opening does not save changes; editing requires write access and an explicit Save. Use get_document for programmatic reading or update_document to save supplied changes.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug. |
{
"name": "open_document",
"title": "Open Document",
"description": "Display a document by ID in the embedded Docmino editor on clients that support MCP Apps. Returns the same document snapshot, revision, permissions, and canonical link as get_document. Opening does not save changes; editing requires write access and an explicit Save. Use get_document for programmatic reading or update_document to save supplied changes.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
},
"__schema1": {
"type": "object",
"required": [
"id",
"name",
"slug",
"content",
"children"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"content": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"additionalProperties": false
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"document",
"revision",
"permissions",
"scopes",
"url"
],
"properties": {
"url": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"document": {
"type": "object",
"required": [
"id",
"user_id",
"project_id",
"name",
"summary",
"tags",
"slug",
"category",
"sub_category",
"status",
"access_scope",
"listed_publicly",
"language",
"comments_disabled",
"saves_disabled",
"position",
"content",
"pages"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"tags": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"pages": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
},
"status": {
"type": [
"string",
"null"
]
},
"content": {
"type": "string"
},
"summary": {
"type": [
"string",
"null"
]
},
"user_id": {
"type": [
"string",
"null"
]
},
"category": {
"type": [
"string",
"null"
]
},
"language": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"number",
"string",
"null"
]
},
"project_id": {
"type": [
"string",
"null"
]
},
"access_scope": {
"type": [
"string",
"null"
]
},
"sub_category": {
"type": [
"string",
"null"
]
},
"saves_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"listed_publicly": {
"type": [
"boolean",
"number",
"null"
]
},
"comments_disabled": {
"type": [
"boolean",
"number",
"null"
]
}
},
"additionalProperties": false
},
"revision": {
"type": "string"
},
"permissions": {
"type": "object",
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}List document page IDs, names, nesting, and content lengths without page bodies. Returns the current revision, rootContentLength, totalCount, and hasMore. Use read_page for root or child content; pass this revision as expectedRevision across subsequent reads to detect concurrent edits.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug. |
| limit | integer | Maximum records in this page, from 1 to 50; defaults to 20. |
| offset | integer | Zero-based number of records to skip. Increase by limit while more results are available. |
| expectedRevision | string | Current document revision from get_document, open_document, list_pages, read_page, or a previous save. A stale revision fails with revision_conflict; retrieve the current snapshot before retrying. |
{
"name": "list_pages",
"title": "List Pages",
"description": "List document page IDs, names, nesting, and content lengths without page bodies. Returns the current revision, rootContentLength, totalCount, and hasMore. Use read_page for root or child content; pass this revision as expectedRevision across subsequent reads to detect concurrent edits.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
},
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum records in this page, from 1 to 50; defaults to 20."
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0,
"description": "Zero-based number of records to skip. Increase by limit while more results are available."
},
"expectedRevision": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Current document revision from get_document, open_document, list_pages, read_page, or a previous save. A stale revision fails with revision_conflict; retrieve the current snapshot before retrying."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"revision",
"rootContentLength",
"pages",
"hasMore",
"totalCount"
],
"properties": {
"pages": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"slug",
"parentId",
"contentLength"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"parentId": {
"type": [
"string",
"null"
]
},
"contentLength": {
"type": "number"
}
},
"additionalProperties": false
}
},
"hasMore": {
"type": "boolean"
},
"revision": {
"type": "string"
},
"totalCount": {
"type": "number"
},
"rootContentLength": {
"type": "number"
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Read a chunk of raw MDX from a document’s root or a child page. Omit pageId for root content; obtain child IDs from list_pages. Returns revision, totalLength, and nextOffset; continue at nextOffset until null and reuse expectedRevision across chunks. A revision conflict requires restarting retrieval.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug. |
| pageId | string | Child page ID from list_pages; omit to read the document’s root content. |
| contentLimit | integer | Maximum characters to return, from 1 to 64000; defaults to 64000. |
| contentOffset | integer | Zero-based character offset; use the previous response’s nextOffset to continue. |
| expectedRevision | string | Current document revision from get_document, open_document, list_pages, read_page, or a previous save. A stale revision fails with revision_conflict; retrieve the current snapshot before retrying. |
{
"name": "read_page",
"title": "Read Page",
"description": "Read a chunk of raw MDX from a document’s root or a child page. Omit pageId for root content; obtain child IDs from list_pages. Returns revision, totalLength, and nextOffset; continue at nextOffset until null and reuse expectedRevision across chunks. A revision conflict requires restarting retrieval.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
},
"pageId": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Child page ID from list_pages; omit to read the document’s root content."
},
"contentLimit": {
"type": "integer",
"default": 64000,
"maximum": 64000,
"minimum": 1,
"description": "Maximum characters to return, from 1 to 64000; defaults to 64000."
},
"contentOffset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0,
"description": "Zero-based character offset; use the previous response’s nextOffset to continue."
},
"expectedRevision": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Current document revision from get_document, open_document, list_pages, read_page, or a previous save. A stale revision fails with revision_conflict; retrieve the current snapshot before retrying."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"revision",
"content",
"totalLength",
"nextOffset"
],
"properties": {
"content": {
"type": "string"
},
"revision": {
"type": "string"
},
"nextOffset": {
"type": [
"number",
"null"
]
},
"totalLength": {
"type": "number"
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Creates a Docmino document with MDX content and an optional nested page tree, returning its ID, canonical link, and metadata. Omit workspaceId for your account and projectId for an ungrouped document. It does not publish or invite recipients; use publish_document or invite_share separately. Supported interactive component syntax and examples are available from get_authoring_guide.
| Parameter | Type | Description |
|---|---|---|
| id | string | Stable client-generated ID for creation retries; omit for a server-generated ID. |
| name | string | Document title; omit on updates to retain its current title. |
| slug | string | Document URL segment; omit on updates to preserve its current slug. |
| tags | array | User-controlled document tags. Omit unless the user explicitly requests a tag change; omitting this field preserves existing tags on updates. |
| pages | array | Complete nested page tree in display order. Omit to preserve all pages; when supplied, existing pages missing from this tree are deleted and require mcp:delete. An empty array removes all child pages. |
| content | string | Raw Docmino MDX body without code fences, <mdx> wrappers, or chat metadata. Supported interactive component syntax and examples are available from get_authoring_guide. |
| summary | string | Short document summary used in search and previews; omit on updates to preserve it. |
| projectId | string | Project ID returned by list_projects, get_project, or create_project. |
| requestId | string | Unique ID for this save. Reuse it with identical inputs when retrying the same write. |
| workspaceId | string | Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account. |
{
"name": "create_document",
"title": "Create Document",
"description": "Creates a Docmino document with MDX content and an optional nested page tree, returning its ID, canonical link, and metadata. Omit workspaceId for your account and projectId for an ungrouped document. It does not publish or invite recipients; use publish_document or invite_share separately. Supported interactive component syntax and examples are available from get_authoring_guide.",
"inputSchema": {
"type": "object",
"$defs": {
"__schema0": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Retain the ID of an existing page. For a new page, supply a fresh ULID or omit the ID to have one assigned."
},
"name": {
"type": "string",
"maxLength": 500,
"description": "Page title shown in navigation."
},
"slug": {
"type": "string",
"maxLength": 255,
"description": "Page URL segment; preserve the existing value when retaining a page."
},
"content": {
"type": "string",
"maxLength": 750000,
"description": "Raw Docmino MDX body without code fences, <mdx> wrappers, or chat metadata. Supported interactive component syntax and examples are available from get_authoring_guide."
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
},
"maxItems": 100,
"description": "Nested child pages in display order. Preserve existing IDs, hierarchy, and order unless the user requests changes."
}
},
"additionalProperties": false
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Stable client-generated ID for creation retries; omit for a server-generated ID."
},
"name": {
"type": "string",
"maxLength": 500,
"description": "Document title; omit on updates to retain its current title."
},
"slug": {
"type": "string",
"maxLength": 255,
"description": "Document URL segment; omit on updates to preserve its current slug."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200
},
"maxItems": 100,
"description": "User-controlled document tags. Omit unless the user explicitly requests a tag change; omitting this field preserves existing tags on updates."
},
"pages": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
},
"maxItems": 100,
"description": "Complete nested page tree in display order. Omit to preserve all pages; when supplied, existing pages missing from this tree are deleted and require mcp:delete. An empty array removes all child pages."
},
"content": {
"type": "string",
"maxLength": 750000,
"description": "Raw Docmino MDX body without code fences, <mdx> wrappers, or chat metadata. Supported interactive component syntax and examples are available from get_authoring_guide."
},
"summary": {
"type": "string",
"maxLength": 6000,
"description": "Short document summary used in search and previews; omit on updates to preserve it."
},
"projectId": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Project ID returned by list_projects, get_project, or create_project."
},
"requestId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Unique ID for this save. Reuse it with identical inputs when retrying the same write."
},
"workspaceId": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"createDoc"
],
"properties": {
"createDoc": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Updates supplied document fields using expectedRevision for conflict detection; omitted fields are preserved. A supplied pages array is authoritative: existing pages absent from it are deleted and require mcp:delete. Returns the saved snapshot and revision, or a saved receipt with complete:false for oversized content. Supported interactive component syntax and examples are available from get_authoring_guide.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug. |
| name | string | Document title; omit on updates to retain its current title. |
| slug | string | Document URL segment; omit on updates to preserve its current slug. |
| tags | array | User-controlled document tags. Omit unless the user explicitly requests a tag change; omitting this field preserves existing tags on updates. |
| pages | array | Complete nested page tree in display order. Omit to preserve all pages; when supplied, existing pages missing from this tree are deleted and require mcp:delete. An empty array removes all child pages. |
| content | string | Raw Docmino MDX body without code fences, <mdx> wrappers, or chat metadata. Supported interactive component syntax and examples are available from get_authoring_guide. |
| summary | string | Short document summary used in search and previews; omit on updates to preserve it. |
| requestId | string | Unique ID for this save. Reuse it with identical inputs when retrying the same write. |
| expectedRevision * | string | Current document revision from get_document, open_document, list_pages, read_page, or a previous save. A stale revision fails with revision_conflict; retrieve the current snapshot before retrying. |
{
"name": "update_document",
"title": "Update Document",
"description": "Updates supplied document fields using expectedRevision for conflict detection; omitted fields are preserved. A supplied pages array is authoritative: existing pages absent from it are deleted and require mcp:delete. Returns the saved snapshot and revision, or a saved receipt with complete:false for oversized content. Supported interactive component syntax and examples are available from get_authoring_guide.",
"inputSchema": {
"type": "object",
"$defs": {
"__schema0": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Retain the ID of an existing page. For a new page, supply a fresh ULID or omit the ID to have one assigned."
},
"name": {
"type": "string",
"maxLength": 500,
"description": "Page title shown in navigation."
},
"slug": {
"type": "string",
"maxLength": 255,
"description": "Page URL segment; preserve the existing value when retaining a page."
},
"content": {
"type": "string",
"maxLength": 750000,
"description": "Raw Docmino MDX body without code fences, <mdx> wrappers, or chat metadata. Supported interactive component syntax and examples are available from get_authoring_guide."
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
},
"maxItems": 100,
"description": "Nested child pages in display order. Preserve existing IDs, hierarchy, and order unless the user requests changes."
}
},
"additionalProperties": false
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id",
"expectedRevision"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
},
"name": {
"type": "string",
"maxLength": 500,
"description": "Document title; omit on updates to retain its current title."
},
"slug": {
"type": "string",
"maxLength": 255,
"description": "Document URL segment; omit on updates to preserve its current slug."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200
},
"maxItems": 100,
"description": "User-controlled document tags. Omit unless the user explicitly requests a tag change; omitting this field preserves existing tags on updates."
},
"pages": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
},
"maxItems": 100,
"description": "Complete nested page tree in display order. Omit to preserve all pages; when supplied, existing pages missing from this tree are deleted and require mcp:delete. An empty array removes all child pages."
},
"content": {
"type": "string",
"maxLength": 750000,
"description": "Raw Docmino MDX body without code fences, <mdx> wrappers, or chat metadata. Supported interactive component syntax and examples are available from get_authoring_guide."
},
"summary": {
"type": "string",
"maxLength": 6000,
"description": "Short document summary used in search and previews; omit on updates to preserve it."
},
"requestId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Unique ID for this save. Reuse it with identical inputs when retrying the same write."
},
"expectedRevision": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Current document revision from get_document, open_document, list_pages, read_page, or a previous save. A stale revision fails with revision_conflict; retrieve the current snapshot before retrying."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
},
"__schema1": {
"type": "object",
"required": [
"id",
"name",
"slug",
"content",
"children"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"content": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"additionalProperties": false
}
},
"anyOf": [
{
"type": "object",
"required": [
"document",
"revision",
"permissions",
"scopes",
"url"
],
"properties": {
"url": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"document": {
"type": "object",
"required": [
"id",
"user_id",
"project_id",
"name",
"summary",
"tags",
"slug",
"category",
"sub_category",
"status",
"access_scope",
"listed_publicly",
"language",
"comments_disabled",
"saves_disabled",
"position",
"content",
"pages"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"tags": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"pages": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
},
"status": {
"type": [
"string",
"null"
]
},
"content": {
"type": "string"
},
"summary": {
"type": [
"string",
"null"
]
},
"user_id": {
"type": [
"string",
"null"
]
},
"category": {
"type": [
"string",
"null"
]
},
"language": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"number",
"string",
"null"
]
},
"project_id": {
"type": [
"string",
"null"
]
},
"access_scope": {
"type": [
"string",
"null"
]
},
"sub_category": {
"type": [
"string",
"null"
]
},
"saves_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"listed_publicly": {
"type": [
"boolean",
"number",
"null"
]
},
"comments_disabled": {
"type": [
"boolean",
"number",
"null"
]
}
},
"additionalProperties": false
},
"revision": {
"type": "string"
},
"permissions": {
"type": "object",
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"saved",
"complete",
"revision",
"url",
"message"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"saved": {
"type": "boolean",
"const": true
},
"message": {
"type": "string"
},
"complete": {
"type": "boolean",
"const": false
},
"revision": {
"type": "string"
}
},
"additionalProperties": false
}
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Move a document to a project, or pass projectId:null to remove its project association. Optional workspaceId changes its owning workspace. Requires the current expectedRevision plus write and sharing access; moving can change inherited access. Returns the saved snapshot or an oversized-save receipt. Use update_document for content changes.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug. |
| projectId * | any | Destination project ID; null removes the current project association. |
| requestId | string | Unique ID for this save. Reuse it with identical inputs when retrying the same write. |
| workspaceId | string | Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account. |
| expectedRevision * | string | Current document revision from get_document, open_document, list_pages, read_page, or a previous save. A stale revision fails with revision_conflict; retrieve the current snapshot before retrying. |
{
"name": "move_document",
"title": "Move Document",
"description": "Move a document to a project, or pass projectId:null to remove its project association. Optional workspaceId changes its owning workspace. Requires the current expectedRevision plus write and sharing access; moving can change inherited access. Returns the saved snapshot or an oversized-save receipt. Use update_document for content changes.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id",
"expectedRevision",
"projectId"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
},
"projectId": {
"anyOf": [
{
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Project ID returned by list_projects, get_project, or create_project."
},
{
"type": "null"
}
],
"description": "Destination project ID; null removes the current project association."
},
"requestId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Unique ID for this save. Reuse it with identical inputs when retrying the same write."
},
"workspaceId": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account."
},
"expectedRevision": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Current document revision from get_document, open_document, list_pages, read_page, or a previous save. A stale revision fails with revision_conflict; retrieve the current snapshot before retrying."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
},
"__schema1": {
"type": "object",
"required": [
"id",
"name",
"slug",
"content",
"children"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"content": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"additionalProperties": false
}
},
"anyOf": [
{
"type": "object",
"required": [
"document",
"revision",
"permissions",
"scopes",
"url"
],
"properties": {
"url": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"document": {
"type": "object",
"required": [
"id",
"user_id",
"project_id",
"name",
"summary",
"tags",
"slug",
"category",
"sub_category",
"status",
"access_scope",
"listed_publicly",
"language",
"comments_disabled",
"saves_disabled",
"position",
"content",
"pages"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"tags": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"pages": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
},
"status": {
"type": [
"string",
"null"
]
},
"content": {
"type": "string"
},
"summary": {
"type": [
"string",
"null"
]
},
"user_id": {
"type": [
"string",
"null"
]
},
"category": {
"type": [
"string",
"null"
]
},
"language": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"number",
"string",
"null"
]
},
"project_id": {
"type": [
"string",
"null"
]
},
"access_scope": {
"type": [
"string",
"null"
]
},
"sub_category": {
"type": [
"string",
"null"
]
},
"saves_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"listed_publicly": {
"type": [
"boolean",
"number",
"null"
]
},
"comments_disabled": {
"type": [
"boolean",
"number",
"null"
]
}
},
"additionalProperties": false
},
"revision": {
"type": "string"
},
"permissions": {
"type": "object",
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"saved",
"complete",
"revision",
"url",
"message"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"saved": {
"type": "boolean",
"const": true
},
"message": {
"type": "string"
},
"complete": {
"type": "boolean",
"const": false
},
"revision": {
"type": "string"
}
},
"additionalProperties": false
}
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}Set a document to DRAFT or PUBLISHED using its current expectedRevision. accessScope controls RESTRICTED versus ANYONE access, and listedPublicly controls public listing; omitted settings are preserved. Requires write and sharing access and can expose content publicly. Returns the saved snapshot or oversized-save receipt; use invite_share for a specific recipient.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug. |
| status * | string | DRAFT removes published status; PUBLISHED publishes using the access settings supplied or retained. |
| requestId | string | Unique ID for this save. Reuse it with identical inputs when retrying the same write. |
| accessScope | string | RESTRICTED requires permitted access; ANYONE allows public access subject to document settings. Omit to retain the current setting. |
| listedPublicly | boolean | Whether the document is listed publicly. Omit to retain its current setting. |
| expectedRevision * | string | Current document revision from get_document, open_document, list_pages, read_page, or a previous save. A stale revision fails with revision_conflict; retrieve the current snapshot before retrying. |
{
"name": "publish_document",
"title": "Publish Document",
"description": "Set a document to DRAFT or PUBLISHED using its current expectedRevision. accessScope controls RESTRICTED versus ANYONE access, and listedPublicly controls public listing; omitted settings are preserved. Requires write and sharing access and can expose content publicly. Returns the saved snapshot or oversized-save receipt; use invite_share for a specific recipient.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id",
"expectedRevision",
"status"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
},
"status": {
"enum": [
"DRAFT",
"PUBLISHED"
],
"type": "string",
"description": "DRAFT removes published status; PUBLISHED publishes using the access settings supplied or retained."
},
"requestId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Unique ID for this save. Reuse it with identical inputs when retrying the same write."
},
"accessScope": {
"enum": [
"RESTRICTED",
"ANYONE"
],
"type": "string",
"description": "RESTRICTED requires permitted access; ANYONE allows public access subject to document settings. Omit to retain the current setting."
},
"listedPublicly": {
"type": "boolean",
"description": "Whether the document is listed publicly. Omit to retain its current setting."
},
"expectedRevision": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Current document revision from get_document, open_document, list_pages, read_page, or a previous save. A stale revision fails with revision_conflict; retrieve the current snapshot before retrying."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
},
"__schema1": {
"type": "object",
"required": [
"id",
"name",
"slug",
"content",
"children"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"content": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"additionalProperties": false
}
},
"anyOf": [
{
"type": "object",
"required": [
"document",
"revision",
"permissions",
"scopes",
"url"
],
"properties": {
"url": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"document": {
"type": "object",
"required": [
"id",
"user_id",
"project_id",
"name",
"summary",
"tags",
"slug",
"category",
"sub_category",
"status",
"access_scope",
"listed_publicly",
"language",
"comments_disabled",
"saves_disabled",
"position",
"content",
"pages"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"tags": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"pages": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
},
"status": {
"type": [
"string",
"null"
]
},
"content": {
"type": "string"
},
"summary": {
"type": [
"string",
"null"
]
},
"user_id": {
"type": [
"string",
"null"
]
},
"category": {
"type": [
"string",
"null"
]
},
"language": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"number",
"string",
"null"
]
},
"project_id": {
"type": [
"string",
"null"
]
},
"access_scope": {
"type": [
"string",
"null"
]
},
"sub_category": {
"type": [
"string",
"null"
]
},
"saves_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"listed_publicly": {
"type": [
"boolean",
"number",
"null"
]
},
"comments_disabled": {
"type": [
"boolean",
"number",
"null"
]
}
},
"additionalProperties": false
},
"revision": {
"type": "string"
},
"permissions": {
"type": "object",
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"saved",
"complete",
"revision",
"url",
"message"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"saved": {
"type": "boolean",
"const": true
},
"message": {
"type": "string"
},
"complete": {
"type": "boolean",
"const": false
},
"revision": {
"type": "string"
}
},
"additionalProperties": false
}
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}Set a document’s status to ARCHIVED using its current expectedRevision. This changes lifecycle status without deleting its content or pages and requires write access. Returns the saved snapshot and revision, or an oversized-save receipt. Use delete_document only when deletion is intended.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug. |
| requestId | string | Unique ID for this save. Reuse it with identical inputs when retrying the same write. |
| expectedRevision * | string | Current document revision from get_document, open_document, list_pages, read_page, or a previous save. A stale revision fails with revision_conflict; retrieve the current snapshot before retrying. |
{
"name": "archive_document",
"title": "Archive Document",
"description": "Set a document’s status to ARCHIVED using its current expectedRevision. This changes lifecycle status without deleting its content or pages and requires write access. Returns the saved snapshot and revision, or an oversized-save receipt. Use delete_document only when deletion is intended.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id",
"expectedRevision"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
},
"requestId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Unique ID for this save. Reuse it with identical inputs when retrying the same write."
},
"expectedRevision": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Current document revision from get_document, open_document, list_pages, read_page, or a previous save. A stale revision fails with revision_conflict; retrieve the current snapshot before retrying."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
},
"__schema1": {
"type": "object",
"required": [
"id",
"name",
"slug",
"content",
"children"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"content": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"additionalProperties": false
}
},
"anyOf": [
{
"type": "object",
"required": [
"document",
"revision",
"permissions",
"scopes",
"url"
],
"properties": {
"url": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"document": {
"type": "object",
"required": [
"id",
"user_id",
"project_id",
"name",
"summary",
"tags",
"slug",
"category",
"sub_category",
"status",
"access_scope",
"listed_publicly",
"language",
"comments_disabled",
"saves_disabled",
"position",
"content",
"pages"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"tags": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"pages": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
},
"status": {
"type": [
"string",
"null"
]
},
"content": {
"type": "string"
},
"summary": {
"type": [
"string",
"null"
]
},
"user_id": {
"type": [
"string",
"null"
]
},
"category": {
"type": [
"string",
"null"
]
},
"language": {
"type": [
"string",
"null"
]
},
"position": {
"type": [
"number",
"string",
"null"
]
},
"project_id": {
"type": [
"string",
"null"
]
},
"access_scope": {
"type": [
"string",
"null"
]
},
"sub_category": {
"type": [
"string",
"null"
]
},
"saves_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"listed_publicly": {
"type": [
"boolean",
"number",
"null"
]
},
"comments_disabled": {
"type": [
"boolean",
"number",
"null"
]
}
},
"additionalProperties": false
},
"revision": {
"type": "string"
},
"permissions": {
"type": "object",
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"id",
"saved",
"complete",
"revision",
"url",
"message"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"saved": {
"type": "boolean",
"const": true
},
"message": {
"type": "string"
},
"complete": {
"type": "boolean",
"const": false
},
"revision": {
"type": "string"
}
},
"additionalProperties": false
}
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Delete a document and its pages by document ID, requiring deletion access. Returns the deleted document ID; it does not return a content backup. Use archive_document when the intent is to retain the content with archived status.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug. |
{
"name": "delete_document",
"title": "Delete Document",
"description": "Delete a document and its pages by document ID, requiring deletion access. Returns the deleted document ID; it does not return a content backup. Use archive_document when the intent is to retain the content with archived status.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"deleteDoc"
],
"properties": {
"deleteDoc": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Create a project to organize documents in your personal or organization workspace. Returns its ID, metadata, instructions, and permissions; omit workspaceId for your account. Does not create documents or invite members. Use create_document with the returned projectId to add a document.
| Parameter | Type | Description |
|---|---|---|
| name * | string | Project display name. Required for creation; optional on update. |
| description | string | Project description; omit on updates to retain its current value. |
| workspaceId | string | Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account. |
| instructions | string | Project instructions for document generation; omit on updates to preserve them. |
{
"name": "create_project",
"title": "Create Project",
"description": "Create a project to organize documents in your personal or organization workspace. Returns its ID, metadata, instructions, and permissions; omit workspaceId for your account. Does not create documents or invite members. Use create_document with the returned projectId to add a document.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Project display name. Required for creation; optional on update."
},
"description": {
"type": "string",
"maxLength": 6000,
"description": "Project description; omit on updates to retain its current value."
},
"workspaceId": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account."
},
"instructions": {
"type": "string",
"maxLength": 6000,
"description": "Project instructions for document generation; omit on updates to preserve them."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"createProject"
],
"properties": {
"createProject": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"userId",
"name",
"description",
"instructions",
"viewerCanEdit",
"viewerCanManage"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": false,
"destructiveHint": false
}
}Update only the supplied name, description, or instructions of an existing project by ID; omitted fields are preserved. Requires write access and returns the updated project metadata and permissions. Use move_project to change its workspace or invite_share to grant access.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Project ID returned by list_projects, get_project, or create_project. |
| name | string | Project display name. Required for creation; optional on update. |
| requestId | string | Unique ID for this save. Reuse it with identical inputs when retrying the same write. |
| description | string | Project description; omit on updates to retain its current value. |
| instructions | string | Project instructions for document generation; omit on updates to preserve them. |
{
"name": "update_project",
"title": "Update Project",
"description": "Update only the supplied name, description, or instructions of an existing project by ID; omitted fields are preserved. Requires write access and returns the updated project metadata and permissions. Use move_project to change its workspace or invite_share to grant access.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Project ID returned by list_projects, get_project, or create_project."
},
"name": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Project display name. Required for creation; optional on update."
},
"requestId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Unique ID for this save. Reuse it with identical inputs when retrying the same write."
},
"description": {
"type": "string",
"maxLength": 6000,
"description": "Project description; omit on updates to retain its current value."
},
"instructions": {
"type": "string",
"maxLength": 6000,
"description": "Project instructions for document generation; omit on updates to preserve them."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"updateProject"
],
"properties": {
"updateProject": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"userId",
"name",
"description",
"instructions",
"viewerCanEdit",
"viewerCanManage"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Move a project and its documents to the workspace identified by workspaceId from list_workspaces. Requires write and sharing access and can change inherited access to the project’s documents. Returns the updated project metadata and permissions. Use update_project for name, description, or instruction changes.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Project ID returned by list_projects, get_project, or create_project. |
| requestId | string | Unique ID for this save. Reuse it with identical inputs when retrying the same write. |
| workspaceId * | string | Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account. |
{
"name": "move_project",
"title": "Move Project",
"description": "Move a project and its documents to the workspace identified by workspaceId from list_workspaces. Requires write and sharing access and can change inherited access to the project’s documents. Returns the updated project metadata and permissions. Use update_project for name, description, or instruction changes.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id",
"workspaceId"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Project ID returned by list_projects, get_project, or create_project."
},
"requestId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Unique ID for this save. Reuse it with identical inputs when retrying the same write."
},
"workspaceId": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"updateProject"
],
"properties": {
"updateProject": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"userId",
"name",
"description",
"instructions",
"viewerCanEdit",
"viewerCanManage"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": true,
"destructiveHint": true
}
}Delete a project by ID while retaining its documents and releasing them from the project. Inherited document access can change. Requires deletion, write, and sharing access and returns the deleted project ID; this does not delete the retained documents.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Project ID returned by list_projects, get_project, or create_project. |
{
"name": "delete_project",
"title": "Delete Project",
"description": "Delete a project by ID while retaining its documents and releasing them from the project. Inherited document access can change. Requires deletion, write, and sharing access and returns the deleted project ID; this does not delete the retained documents.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Project ID returned by list_projects, get_project, or create_project."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"deleteProject"
],
"properties": {
"deleteProject": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}List a page of direct access grants and pending invitations for a document or project. target selects which kind of ID to supply. Returns share IDs, recipient details, roles, statuses, deletion permissions, and pageInfo. Use these share IDs with update_share or remove_share; this is not organization membership management.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Document or project ID selected by target; not a share ID. |
| limit | integer | Maximum records in this page, from 1 to 50; defaults to 20. |
| offset | integer | Zero-based number of records to skip. Increase by limit while more results are available. |
| target * | string | DOC for a document ID; PROJECT for a project ID. |
{
"name": "list_shares",
"title": "List Shares",
"description": "List a page of direct access grants and pending invitations for a document or project. target selects which kind of ID to supply. Returns share IDs, recipient details, roles, statuses, deletion permissions, and pageInfo. Use these share IDs with update_share or remove_share; this is not organization membership management.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"target",
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Document or project ID selected by target; not a share ID."
},
"limit": {
"type": "integer",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum records in this page, from 1 to 50; defaults to 20."
},
"offset": {
"type": "integer",
"default": 0,
"maximum": 9007199254740991,
"minimum": 0,
"description": "Zero-based number of records to skip. Increase by limit while more results are available."
},
"target": {
"enum": [
"DOC",
"PROJECT"
],
"type": "string",
"description": "DOC for a document ID; PROJECT for a project ID."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"node"
],
"properties": {
"node": {
"anyOf": [
{
"type": "object",
"required": [
"id",
"shares"
],
"properties": {
"id": {
"type": "string"
},
"shares": {
"type": "object",
"required": [
"nodes",
"pageInfo"
],
"properties": {
"nodes": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"docId",
"projectId",
"userId",
"email",
"phone",
"role",
"status",
"viewerCanDelete"
],
"properties": {
"id": {
"type": "string"
},
"role": {
"type": [
"string",
"null"
]
},
"docId": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"viewerCanDelete": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
},
"pageInfo": {
"type": "object",
"required": [
"hasNextPage",
"hasPreviousPage"
],
"properties": {
"hasNextPage": {
"type": "boolean"
},
"hasPreviousPage": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}
}Grant document or project access to one recipient identified by exactly one userId, email, or phone value. Requires sharing access and sends invitation notifications. Returns the share ID, recipient, role, and status. Use update_share for an existing grant; this does not add organization members.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Document or project ID selected by target; not a share ID. |
| role * | string | ADMIN grants management access, EDITOR editing access, VIEWER viewing access to the shared target. |
| target * | string | DOC for a document ID; PROJECT for a project ID. |
| recipient * | any | Exactly one recipient identifier: userId, email, or phone. Inviting sends notifications. |
{
"name": "invite_share",
"title": "Invite Share",
"description": "Grant document or project access to one recipient identified by exactly one userId, email, or phone value. Requires sharing access and sends invitation notifications. Returns the share ID, recipient, role, and status. Use update_share for an existing grant; this does not add organization members.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"target",
"id",
"recipient",
"role"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Document or project ID selected by target; not a share ID."
},
"role": {
"enum": [
"ADMIN",
"EDITOR",
"VIEWER"
],
"type": "string",
"description": "ADMIN grants management access, EDITOR editing access, VIEWER viewing access to the shared target."
},
"target": {
"enum": [
"DOC",
"PROJECT"
],
"type": "string",
"description": "DOC for a document ID; PROJECT for a project ID."
},
"recipient": {
"anyOf": [
{
"type": "object",
"required": [
"userId"
],
"properties": {
"userId": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Recipient’s existing Docmino user ID, not a workspace ID."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "Recipient email address for the invitation notification."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"phone"
],
"properties": {
"phone": {
"type": "string",
"maxLength": 40,
"minLength": 5,
"description": "Recipient phone number, including its country calling code."
}
},
"additionalProperties": false
}
],
"description": "Exactly one recipient identifier: userId, email, or phone. Inviting sends notifications."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"createShare"
],
"properties": {
"createShare": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"docId",
"projectId",
"userId",
"email",
"phone",
"role",
"status",
"viewerCanDelete"
],
"properties": {
"id": {
"type": "string"
},
"role": {
"type": [
"string",
"null"
]
},
"docId": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"viewerCanDelete": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": true,
"idempotentHint": false,
"destructiveHint": true
}
}Change the ADMIN, EDITOR, or VIEWER role of a direct access grant or pending invitation by share ID from list_shares. Requires sharing access and returns the updated share metadata. This can expand or reduce recipient access; use invite_share for a new recipient and remove_share to revoke a grant.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Share or invitation ID returned by list_shares or invite_share, not a document, project, or recipient ID. |
| role * | string | ADMIN grants management access, EDITOR editing access, VIEWER viewing access to the shared target. |
{
"name": "update_share",
"title": "Update Share",
"description": "Change the ADMIN, EDITOR, or VIEWER role of a direct access grant or pending invitation by share ID from list_shares. Requires sharing access and returns the updated share metadata. This can expand or reduce recipient access; use invite_share for a new recipient and remove_share to revoke a grant.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id",
"role"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Share or invitation ID returned by list_shares or invite_share, not a document, project, or recipient ID."
},
"role": {
"enum": [
"ADMIN",
"EDITOR",
"VIEWER"
],
"type": "string",
"description": "ADMIN grants management access, EDITOR editing access, VIEWER viewing access to the shared target."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"updateShare"
],
"properties": {
"updateShare": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"docId",
"projectId",
"userId",
"email",
"phone",
"role",
"status",
"viewerCanDelete"
],
"properties": {
"id": {
"type": "string"
},
"role": {
"type": [
"string",
"null"
]
},
"docId": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"viewerCanDelete": {
"type": [
"boolean",
"null"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}Revoke a direct document/project access grant or pending invitation using its share ID from list_shares. Requires sharing access and returns the deleted share ID. Access inherited through another grant or project may remain; this does not remove organization membership.
| Parameter | Type | Description |
|---|---|---|
| id * | string | Share or invitation ID returned by list_shares or invite_share, not a document, project, or recipient ID. |
{
"name": "remove_share",
"title": "Remove Share",
"description": "Revoke a direct document/project access grant or pending invitation using its share ID from list_shares. Requires sharing access and returns the deleted share ID. Access inherited through another grant or project may remain; this does not remove organization membership.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Share or invitation ID returned by list_shares or invite_share, not a document, project, or recipient ID."
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"deleteShare"
],
"properties": {
"deleteShare": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"annotations": {
"readOnlyHint": false,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": true
}
}This MCP server provides document and page content operations, project management, publishing, sharing, and an embedded editor with explicit Save. Payment processing, new media uploads, billing, organization membership administration, comments, form responses, and internal AI assistance are outside this MCP integration. Do not promise an upload flow, charge payments, change organization roles, or substitute document/project shares for organization membership. Direct those requests to the normal Docmino application at https://docmino.com. Existing media and payment components can be preserved as document content; that does not provide upload or payment operations. Before an existing-document save, retrieve its current revision and retain every existing page, nesting, and order unless the user requested deletion. Return canonical Docmino links and verify saved changes. <product_positioning> Docmino is for repeat-use interactive guides: content people come back to use, not just read once. When a request is broad or open-ended, prefer practical guides such as lessons, workout plans, recipes, forms, trackers, planners, and calculators. The strongest first-wave use cases are education, fitness, recipes, and forms. Use calculators, adjusters, timers, questions, inputs, and charts when they make the guide more useful in the moment. </product_positioning> <recommended_patterns> - Lessons and study guides: short teaching sections with interactive visualizations for key concepts and self-checking Question components for practice. - Scored quizzes: self-checking Question.* components with stable IDs, followed by a Result that calculates the grade from checked answers. - Recipes and workouts: step-by-step markdown instructions plus Timer, counters, or simple tables only where they directly support cooking or training. - Forms and workflows: Input.* fields and optional Booking selections followed by clear Submit actions. For an appointment intake form, place the contact fields and required Booking before one Submit labeled "Confirm appointment". - Dashboards and reports: Data first, then Chart components that read from that data. - Calculations and counts: Result paired with the questions, numeric inputs, or checkboxes that provide the values. </recommended_patterns> Before creating or rewriting document or page content, call get_authoring_guide for the shared AI Assistant authoring rules, component schemas, and examples. Omit components for the default guide, or select exact supported component names for focused guidance. Use the guide to choose useful interactions; do not default a worksheet, quiz, calculator, or form to static markdown when its task calls for feedback, calculation, or response collection. Honor explicit requests for plain text or printable content. Send raw MDX in content fields and separate metadata in name and summary; do not send internal AI Assistant response envelopes, <mdx>, <delta>, or fenced source code.
Names, descriptions and schemas were written by the server and are shown as data.