Docmino
Create, edit, organize, and share interactive guides, lessons, forms, and client plans in Docmino.
Sollte ich dies verwenden
Qualität und Sicherheit
A
Befunde (1)
- LOWTool 'fetch' suggests web access but openWorldHint=falsein fetch
Basierend auf einer automatisierten Analyse der Tool-Definitionen und der Einhaltung des Protokolls.
Kontextkosten
~14,121Tokens (Tool-Definitionen)
~5.6 KBTypische Antwortgröße
Erhebliche Auswirkung auf die Aufmerksamkeit (11.03% von 128k Kontext)
Dies ist die ungefähre Anzahl der Tokens, die jedes Mal verbraucht werden, wenn die Tools des Servers in den Kontext eines Modells geladen werden. Höhere Werte verringern die Aufmerksamkeit, die für andere Aufgaben verfügbar ist.
Installieren
Installation mit einem Klick
Fügen Sie dies Ihrer Datei `claude_desktop_config.json` hinzu:
{
"mcpServers": {
"docmino": {
"url": "https://mcp.docmino.com/mcp"
}
}
}Remote-Endpunkte
https://mcp.docmino.com/mcpstreamable-httpWas es kann
Tool-Inventar
Tools (26)
🟢 Nur lesen🟡 Schreiben🔴 Löschen⚪ Unbekannt
🟢get_authoring_guide(components)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"components": {
"description": "Optional component names for focused schemas and examples. When omitted, the default authoring guide is returned.",
"maxItems": 51,
"type": "array",
"items": {
"type": "string",
"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"
]
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"guide": {
"type": "string"
}
},
"required": [
"guide"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢search(query)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"query": {
"type": "string",
"maxLength": 1000,
"description": "Words to match against accessible document names and summaries, not full page bodies."
}
},
"required": [
"query"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"id",
"title",
"url"
],
"additionalProperties": false
}
},
"hasMore": {
"type": "boolean"
}
},
"required": [
"results",
"hasMore"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢fetch(id)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"text": {
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"revision": {
"type": "string"
},
"complete": {
"type": "boolean"
}
},
"required": [
"revision",
"complete"
],
"additionalProperties": false
}
},
"required": [
"id",
"title",
"url",
"text",
"metadata"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢list_workspaces(offset, limit)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"offset": {
"default": 0,
"description": "Zero-based number of records to skip. Increase by limit while more results are available.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"default": 20,
"description": "Maximum records in this page, from 1 to 50; defaults to 20.",
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"viewer": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"organizations": {
"type": "object",
"properties": {
"nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"pageInfo": {
"type": "object",
"properties": {
"hasNextPage": {
"type": "boolean"
}
},
"required": [
"hasNextPage"
],
"additionalProperties": false
}
},
"required": [
"nodes",
"pageInfo"
],
"additionalProperties": false
}
},
"required": [
"id",
"name",
"organizations"
],
"additionalProperties": false
}
},
"required": [
"viewer"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢list_documents(workspaceId, query, offset, limit)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account."
},
"query": {
"description": "Optional words to match against document names and summaries; omit to browse.",
"type": "string",
"maxLength": 1000
},
"offset": {
"default": 0,
"description": "Zero-based number of records to skip. Increase by limit while more results are available.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"default": 20,
"description": "Maximum records in this page, from 1 to 50; defaults to 20.",
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"user": {
"anyOf": [
{
"type": "object",
"properties": {
"searchDocs": {
"type": "object",
"properties": {
"nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"additionalProperties": false
}
},
"pageInfo": {
"type": "object",
"properties": {
"hasNextPage": {
"type": "boolean"
},
"hasPreviousPage": {
"type": "boolean"
}
},
"required": [
"hasNextPage",
"hasPreviousPage"
],
"additionalProperties": false
}
},
"required": [
"nodes",
"pageInfo"
],
"additionalProperties": false
}
},
"required": [
"searchDocs"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"user"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢list_projects(workspaceId, offset, limit)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account."
},
"offset": {
"default": 0,
"description": "Zero-based number of records to skip. Increase by limit while more results are available.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"default": 20,
"description": "Maximum records in this page, from 1 to 50; defaults to 20.",
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"user": {
"anyOf": [
{
"type": "object",
"properties": {
"projects": {
"type": "object",
"properties": {
"nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"userId": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"id",
"userId",
"name",
"description",
"instructions",
"viewerCanEdit",
"viewerCanManage"
],
"additionalProperties": false
}
},
"pageInfo": {
"type": "object",
"properties": {
"hasNextPage": {
"type": "boolean"
},
"hasPreviousPage": {
"type": "boolean"
}
},
"required": [
"hasNextPage",
"hasPreviousPage"
],
"additionalProperties": false
}
},
"required": [
"nodes",
"pageInfo"
],
"additionalProperties": false
}
},
"required": [
"projects"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"user"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢get_project(id)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Project ID returned by list_projects, get_project, or create_project."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"project": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"userId": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"id",
"userId",
"name",
"description",
"instructions",
"viewerCanEdit",
"viewerCanManage"
],
"additionalProperties": false
},
"url": {
"type": "string"
}
},
"required": [
"project",
"url"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢list_project_documents(id, offset, limit)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Project ID returned by list_projects, get_project, or create_project."
},
"offset": {
"default": 0,
"description": "Zero-based number of records to skip. Increase by limit while more results are available.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"default": 20,
"description": "Maximum records in this page, from 1 to 50; defaults to 20.",
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"node": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"docs": {
"type": "object",
"properties": {
"nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"additionalProperties": false
}
},
"pageInfo": {
"type": "object",
"properties": {
"hasNextPage": {
"type": "boolean"
},
"hasPreviousPage": {
"type": "boolean"
}
},
"required": [
"hasNextPage",
"hasPreviousPage"
],
"additionalProperties": false
}
},
"required": [
"nodes",
"pageInfo"
],
"additionalProperties": false
}
},
"required": [
"id",
"docs"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"node"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢get_document(id)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"document": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"user_id": {
"type": [
"string",
"null"
]
},
"project_id": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"tags": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"slug": {
"type": [
"string",
"null"
]
},
"category": {
"type": [
"string",
"null"
]
},
"sub_category": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"access_scope": {
"type": [
"string",
"null"
]
},
"listed_publicly": {
"type": [
"boolean",
"number",
"null"
]
},
"language": {
"type": [
"string",
"null"
]
},
"comments_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"saves_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"position": {
"type": [
"number",
"string",
"null"
]
},
"content": {
"type": "string"
},
"pages": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"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"
],
"additionalProperties": false
},
"revision": {
"type": "string"
},
"permissions": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"additionalProperties": false
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
}
},
"required": [
"document",
"revision",
"permissions",
"scopes",
"url"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"$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",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"content": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"required": [
"id",
"name",
"slug",
"content",
"children"
],
"additionalProperties": false
}
}
}🟢open_document(id)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"document": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"user_id": {
"type": [
"string",
"null"
]
},
"project_id": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"tags": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"slug": {
"type": [
"string",
"null"
]
},
"category": {
"type": [
"string",
"null"
]
},
"sub_category": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"access_scope": {
"type": [
"string",
"null"
]
},
"listed_publicly": {
"type": [
"boolean",
"number",
"null"
]
},
"language": {
"type": [
"string",
"null"
]
},
"comments_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"saves_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"position": {
"type": [
"number",
"string",
"null"
]
},
"content": {
"type": "string"
},
"pages": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"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"
],
"additionalProperties": false
},
"revision": {
"type": "string"
},
"permissions": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"additionalProperties": false
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
}
},
"required": [
"document",
"revision",
"permissions",
"scopes",
"url"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"$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",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"content": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"required": [
"id",
"name",
"slug",
"content",
"children"
],
"additionalProperties": false
}
}
}🟢list_pages(id, expectedRevision, offset, limit)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
},
"expectedRevision": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"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."
},
"offset": {
"default": 0,
"description": "Zero-based number of records to skip. Increase by limit while more results are available.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"default": 20,
"description": "Maximum records in this page, from 1 to 50; defaults to 20.",
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"revision": {
"type": "string"
},
"rootContentLength": {
"type": "number"
},
"pages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"parentId": {
"type": [
"string",
"null"
]
},
"contentLength": {
"type": "number"
}
},
"required": [
"id",
"name",
"slug",
"parentId",
"contentLength"
],
"additionalProperties": false
}
},
"hasMore": {
"type": "boolean"
},
"totalCount": {
"type": "number"
}
},
"required": [
"revision",
"rootContentLength",
"pages",
"hasMore",
"totalCount"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢read_page(id, pageId, expectedRevision, contentOffset, contentLimit)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
},
"pageId": {
"description": "Child page ID from list_pages; omit to read the document’s root content.",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"expectedRevision": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"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."
},
"contentOffset": {
"default": 0,
"description": "Zero-based character offset; use the previous response’s nextOffset to continue.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"contentLimit": {
"default": 64000,
"description": "Maximum characters to return, from 1 to 64000; defaults to 64000.",
"type": "integer",
"minimum": 1,
"maximum": 64000
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"revision": {
"type": "string"
},
"content": {
"type": "string"
},
"totalLength": {
"type": "number"
},
"nextOffset": {
"type": [
"number",
"null"
]
}
},
"required": [
"revision",
"content",
"totalLength",
"nextOffset"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟡create_document(name, content, pages, tags, slug, ...)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"name": {
"description": "Document title; omit on updates to retain its current title.",
"type": "string",
"maxLength": 500
},
"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."
},
"pages": {
"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.",
"maxItems": 100,
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"tags": {
"description": "User-controlled document tags. Omit unless the user explicitly requests a tag change; omitting this field preserves existing tags on updates.",
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
},
"slug": {
"description": "Document URL segment; omit on updates to preserve its current slug.",
"type": "string",
"maxLength": 255
},
"summary": {
"description": "Short document summary used in search and previews; omit on updates to preserve it.",
"type": "string",
"maxLength": 6000
},
"id": {
"description": "Stable client-generated ID for creation retries; omit for a server-generated ID.",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Project ID returned by list_projects, get_project, or create_project."
},
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"$defs": {
"__schema0": {
"type": "object",
"properties": {
"id": {
"description": "Existing page ID when retaining or updating a page. Omit for a new page.",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"name": {
"description": "Page title shown in navigation.",
"type": "string",
"maxLength": 500
},
"slug": {
"description": "Page URL segment; preserve the existing value when retaining a page.",
"type": "string",
"maxLength": 255
},
"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": {
"description": "Nested child pages in display order. Preserve existing IDs, hierarchy, and order unless the user requests changes.",
"maxItems": 100,
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
}
},
"additionalProperties": false
}
}
}Ausgabe-Schema
{
"type": "object",
"properties": {
"createDoc": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"additionalProperties": false
}
}
},
"required": [
"createDoc"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🔴update_document(id, expectedRevision, name, content, pages, ...)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
},
"expectedRevision": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"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."
},
"name": {
"description": "Document title; omit on updates to retain its current title.",
"type": "string",
"maxLength": 500
},
"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."
},
"pages": {
"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.",
"maxItems": 100,
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"tags": {
"description": "User-controlled document tags. Omit unless the user explicitly requests a tag change; omitting this field preserves existing tags on updates.",
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"maxLength": 200
}
},
"slug": {
"description": "Document URL segment; omit on updates to preserve its current slug.",
"type": "string",
"maxLength": 255
},
"summary": {
"description": "Short document summary used in search and previews; omit on updates to preserve it.",
"type": "string",
"maxLength": 6000
}
},
"required": [
"id",
"expectedRevision"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"$defs": {
"__schema0": {
"type": "object",
"properties": {
"id": {
"description": "Existing page ID when retaining or updating a page. Omit for a new page.",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"name": {
"description": "Page title shown in navigation.",
"type": "string",
"maxLength": 500
},
"slug": {
"description": "Page URL segment; preserve the existing value when retaining a page.",
"type": "string",
"maxLength": 255
},
"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": {
"description": "Nested child pages in display order. Preserve existing IDs, hierarchy, and order unless the user requests changes.",
"maxItems": 100,
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
}
},
"additionalProperties": false
}
}
}Ausgabe-Schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"document": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"user_id": {
"type": [
"string",
"null"
]
},
"project_id": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"tags": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"slug": {
"type": [
"string",
"null"
]
},
"category": {
"type": [
"string",
"null"
]
},
"sub_category": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"access_scope": {
"type": [
"string",
"null"
]
},
"listed_publicly": {
"type": [
"boolean",
"number",
"null"
]
},
"language": {
"type": [
"string",
"null"
]
},
"comments_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"saves_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"position": {
"type": [
"number",
"string",
"null"
]
},
"content": {
"type": "string"
},
"pages": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"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"
],
"additionalProperties": false
},
"revision": {
"type": "string"
},
"permissions": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"additionalProperties": false
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
}
},
"required": [
"document",
"revision",
"permissions",
"scopes",
"url"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"saved": {
"type": "boolean",
"const": true
},
"complete": {
"type": "boolean",
"const": false
},
"revision": {
"type": "string"
},
"url": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"id",
"saved",
"complete",
"revision",
"url",
"message"
],
"additionalProperties": false
}
],
"$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",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"content": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"required": [
"id",
"name",
"slug",
"content",
"children"
],
"additionalProperties": false
}
}
}🔴move_document(id, expectedRevision, projectId, workspaceId)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
},
"expectedRevision": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"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."
},
"projectId": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Project ID returned by list_projects, get_project, or create_project."
},
{
"type": "null"
}
],
"description": "Destination project ID; null removes the current project association."
},
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account."
}
},
"required": [
"id",
"expectedRevision",
"projectId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"document": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"user_id": {
"type": [
"string",
"null"
]
},
"project_id": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"tags": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"slug": {
"type": [
"string",
"null"
]
},
"category": {
"type": [
"string",
"null"
]
},
"sub_category": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"access_scope": {
"type": [
"string",
"null"
]
},
"listed_publicly": {
"type": [
"boolean",
"number",
"null"
]
},
"language": {
"type": [
"string",
"null"
]
},
"comments_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"saves_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"position": {
"type": [
"number",
"string",
"null"
]
},
"content": {
"type": "string"
},
"pages": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"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"
],
"additionalProperties": false
},
"revision": {
"type": "string"
},
"permissions": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"additionalProperties": false
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
}
},
"required": [
"document",
"revision",
"permissions",
"scopes",
"url"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"saved": {
"type": "boolean",
"const": true
},
"complete": {
"type": "boolean",
"const": false
},
"revision": {
"type": "string"
},
"url": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"id",
"saved",
"complete",
"revision",
"url",
"message"
],
"additionalProperties": false
}
],
"$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",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"content": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"required": [
"id",
"name",
"slug",
"content",
"children"
],
"additionalProperties": false
}
}
}🔴publish_document(id, expectedRevision, status, accessScope, listedPublicly)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
},
"expectedRevision": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"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."
},
"status": {
"type": "string",
"enum": [
"DRAFT",
"PUBLISHED"
],
"description": "DRAFT removes published status; PUBLISHED publishes using the access settings supplied or retained."
},
"accessScope": {
"description": "RESTRICTED requires permitted access; ANYONE allows public access subject to document settings. Omit to retain the current setting.",
"type": "string",
"enum": [
"RESTRICTED",
"ANYONE"
]
},
"listedPublicly": {
"description": "Whether the document is listed publicly. Omit to retain its current setting.",
"type": "boolean"
}
},
"required": [
"id",
"expectedRevision",
"status"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"document": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"user_id": {
"type": [
"string",
"null"
]
},
"project_id": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"tags": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"slug": {
"type": [
"string",
"null"
]
},
"category": {
"type": [
"string",
"null"
]
},
"sub_category": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"access_scope": {
"type": [
"string",
"null"
]
},
"listed_publicly": {
"type": [
"boolean",
"number",
"null"
]
},
"language": {
"type": [
"string",
"null"
]
},
"comments_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"saves_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"position": {
"type": [
"number",
"string",
"null"
]
},
"content": {
"type": "string"
},
"pages": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"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"
],
"additionalProperties": false
},
"revision": {
"type": "string"
},
"permissions": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"additionalProperties": false
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
}
},
"required": [
"document",
"revision",
"permissions",
"scopes",
"url"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"saved": {
"type": "boolean",
"const": true
},
"complete": {
"type": "boolean",
"const": false
},
"revision": {
"type": "string"
},
"url": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"id",
"saved",
"complete",
"revision",
"url",
"message"
],
"additionalProperties": false
}
],
"$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",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"content": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"required": [
"id",
"name",
"slug",
"content",
"children"
],
"additionalProperties": false
}
}
}🔴archive_document(id, expectedRevision)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
},
"expectedRevision": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"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."
}
},
"required": [
"id",
"expectedRevision"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"document": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"user_id": {
"type": [
"string",
"null"
]
},
"project_id": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"tags": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"slug": {
"type": [
"string",
"null"
]
},
"category": {
"type": [
"string",
"null"
]
},
"sub_category": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"access_scope": {
"type": [
"string",
"null"
]
},
"listed_publicly": {
"type": [
"boolean",
"number",
"null"
]
},
"language": {
"type": [
"string",
"null"
]
},
"comments_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"saves_disabled": {
"type": [
"boolean",
"number",
"null"
]
},
"position": {
"type": [
"number",
"string",
"null"
]
},
"content": {
"type": "string"
},
"pages": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"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"
],
"additionalProperties": false
},
"revision": {
"type": "string"
},
"permissions": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"accessScope": {
"type": [
"string",
"null"
]
},
"listedPublicly": {
"type": [
"boolean",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"id",
"name",
"summary",
"slug",
"userId",
"projectId",
"status",
"accessScope",
"listedPublicly",
"viewerCanEdit",
"viewerCanManage",
"url"
],
"additionalProperties": false
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
}
},
"required": [
"document",
"revision",
"permissions",
"scopes",
"url"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"saved": {
"type": "boolean",
"const": true
},
"complete": {
"type": "boolean",
"const": false
},
"revision": {
"type": "string"
},
"url": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"id",
"saved",
"complete",
"revision",
"url",
"message"
],
"additionalProperties": false
}
],
"$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",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"content": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema1"
}
}
},
"required": [
"id",
"name",
"slug",
"content",
"children"
],
"additionalProperties": false
}
}
}🔴delete_document(id)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Document ID returned by search, list_documents, list_project_documents, or create_document; not its URL or slug."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"deleteDoc": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"additionalProperties": false
}
}
},
"required": [
"deleteDoc"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟡create_project(name, description, instructions, workspaceId)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 500,
"description": "Project display name. Required for creation; optional on update."
},
"description": {
"description": "Project description; omit on updates to retain its current value.",
"type": "string",
"maxLength": 6000
},
"instructions": {
"description": "Project instructions for document generation; omit on updates to preserve them.",
"type": "string",
"maxLength": 6000
},
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account."
}
},
"required": [
"name"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"createProject": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"userId": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"id",
"userId",
"name",
"description",
"instructions",
"viewerCanEdit",
"viewerCanManage"
],
"additionalProperties": false
}
}
},
"required": [
"createProject"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🔴update_project(id, name, description, instructions)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Project ID returned by list_projects, get_project, or create_project."
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 500,
"description": "Project display name. Required for creation; optional on update."
},
"description": {
"description": "Project description; omit on updates to retain its current value.",
"type": "string",
"maxLength": 6000
},
"instructions": {
"description": "Project instructions for document generation; omit on updates to preserve them.",
"type": "string",
"maxLength": 6000
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"updateProject": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"userId": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"id",
"userId",
"name",
"description",
"instructions",
"viewerCanEdit",
"viewerCanManage"
],
"additionalProperties": false
}
}
},
"required": [
"updateProject"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🔴move_project(id, workspaceId)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Project ID returned by list_projects, get_project, or create_project."
},
"workspaceId": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Personal account or organization ID returned by list_workspaces. Omit when optional to use your personal account."
}
},
"required": [
"id",
"workspaceId"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"updateProject": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"userId": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"viewerCanEdit": {
"type": [
"boolean",
"null"
]
},
"viewerCanManage": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"id",
"userId",
"name",
"description",
"instructions",
"viewerCanEdit",
"viewerCanManage"
],
"additionalProperties": false
}
}
},
"required": [
"updateProject"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🔴delete_project(id)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Project ID returned by list_projects, get_project, or create_project."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"deleteProject": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"additionalProperties": false
}
}
},
"required": [
"deleteProject"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🟢list_shares(target, id, offset, limit)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"target": {
"type": "string",
"enum": [
"DOC",
"PROJECT"
],
"description": "DOC for a document ID; PROJECT for a project ID."
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Document or project ID selected by target; not a share ID."
},
"offset": {
"default": 0,
"description": "Zero-based number of records to skip. Increase by limit while more results are available.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"default": 20,
"description": "Maximum records in this page, from 1 to 50; defaults to 20.",
"type": "integer",
"minimum": 1,
"maximum": 50
}
},
"required": [
"target",
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"node": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"shares": {
"type": "object",
"properties": {
"nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"docId": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"role": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"viewerCanDelete": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"id",
"docId",
"projectId",
"userId",
"email",
"phone",
"role",
"status",
"viewerCanDelete"
],
"additionalProperties": false
}
},
"pageInfo": {
"type": "object",
"properties": {
"hasNextPage": {
"type": "boolean"
},
"hasPreviousPage": {
"type": "boolean"
}
},
"required": [
"hasNextPage",
"hasPreviousPage"
],
"additionalProperties": false
}
},
"required": [
"nodes",
"pageInfo"
],
"additionalProperties": false
}
},
"required": [
"id",
"shares"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"node"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🔴invite_share(target, id, recipient, role)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"target": {
"type": "string",
"enum": [
"DOC",
"PROJECT"
],
"description": "DOC for a document ID; PROJECT for a project ID."
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Document or project ID selected by target; not a share ID."
},
"recipient": {
"anyOf": [
{
"type": "object",
"properties": {
"userId": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Recipient’s existing Docmino user ID, not a workspace ID."
}
},
"required": [
"userId"
],
"additionalProperties": false
},
{
"type": "object",
"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."
}
},
"required": [
"email"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"phone": {
"type": "string",
"minLength": 5,
"maxLength": 40,
"description": "Recipient phone number, including its country calling code."
}
},
"required": [
"phone"
],
"additionalProperties": false
}
],
"description": "Exactly one recipient identifier: userId, email, or phone. Inviting sends notifications."
},
"role": {
"type": "string",
"enum": [
"ADMIN",
"EDITOR",
"VIEWER"
],
"description": "ADMIN grants management access, EDITOR editing access, VIEWER viewing access to the shared target."
}
},
"required": [
"target",
"id",
"recipient",
"role"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"createShare": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"docId": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"role": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"viewerCanDelete": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"id",
"docId",
"projectId",
"userId",
"email",
"phone",
"role",
"status",
"viewerCanDelete"
],
"additionalProperties": false
}
}
},
"required": [
"createShare"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🔴update_share(id, role)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Share or invitation ID returned by list_shares or invite_share, not a document, project, or recipient ID."
},
"role": {
"type": "string",
"enum": [
"ADMIN",
"EDITOR",
"VIEWER"
],
"description": "ADMIN grants management access, EDITOR editing access, VIEWER viewing access to the shared target."
}
},
"required": [
"id",
"role"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"updateShare": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"docId": {
"type": [
"string",
"null"
]
},
"projectId": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"role": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"viewerCanDelete": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"id",
"docId",
"projectId",
"userId",
"email",
"phone",
"role",
"status",
"viewerCanDelete"
],
"additionalProperties": false
}
}
},
"required": [
"updateShare"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}🔴remove_share(id)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Share or invitation ID returned by list_shares or invite_share, not a document, project, or recipient ID."
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Ausgabe-Schema
{
"type": "object",
"properties": {
"deleteShare": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"additionalProperties": false
}
}
},
"required": [
"deleteShare"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false
}Community
Nachweis
Aktuelle Beobachtungen
verifiziertVersion nicht aufgezeichnet26 Tools