List all available AFFiNE workspaces

Get details of a specific workspace

Create a new workspace with initial document (accessible in UI)

Update workspace settings

Delete a workspace permanently

List documents in a workspace (GraphQL). Each doc includes an inTrash flag.

Fast search for documents by title using workspace metadata. Much faster than exporting each doc. Returns docId, title, direct URL, and inTrash for each match.

Resolve docs by exact title. Returns ALL matches up to limit (callers handle ambiguity). Case-sensitive by default; pass caseInsensitive: true to fold case. Reads workspace metadata — fast, no per-doc fetch. Unlike search_docs (which is always case-insensitive and capped at limit 20), this tool defaults to case-sensitive matching and returns up to limit matches (default 50, max 200). Prefer this over search_docs when you know the exact title and want every match. Returns: { query, caseInsensitive, matches: [{ id, title, createdAt, updatedAt, inTrash }], workspaceDocCount, truncated }.

List all workspace-level tags and the number of documents attached to each tag. Use this before tag mutation when the exact tag name or id is unknown.

List documents that contain the requested tag. This is read-only and each result includes title metadata and an inTrash flag.

Create a workspace-level tag entry for future reuse. This does not attach the tag to a document; use add_tag_to_doc for that.

Attach a workspace tag to a document, creating the workspace tag option if needed. This updates workspace metadata and attempts to sync the document's own metadata.

Detach a tag from one document without deleting the workspace-level tag. Use delete_tag only when the tag should be removed from every document.

Delete a workspace-level tag and remove it from every document that references it. Accepts a tag id or name; an ambiguous name is rejected with the candidate ids.

Read GraphQL metadata for one document, such as title, summary, public state, roles, and timestamps. Use read_doc when you need block content.

Read document block content via WebSocket snapshot (blocks + plain text). Set includeMarkdown: true to also get the rendered markdown — useful when you need to read content without a separate export_doc_markdown call.

Return machine-readable capability flags for this MCP server, including block, database, collaboration, and export support.

Inspect a document for markdown export fidelity risk, including unsupported AFFiNE block flavours and risky content paths.

Move a doc in the AFFiNE sidebar by embedding it under a new parent. Optionally removes it from the old parent (fromParentDocId). If fromParentDocId is omitted, the doc is added to the new parent but not removed from the old one.

Make a document publicly accessible through AFFiNE public sharing. This changes sharing state; use revoke_doc to disable public access later.

Disable public sharing for a document without deleting the document. Use delete_doc only when the document itself should be removed.

Create a new AFFiNE document with optional content. If parentDocId is provided, the new doc is linked into the sidebar tree immediately. If folderId is provided, the doc is placed inside that folder in the sidebar.

Create an AFFiNE-native page with intentional section structure and native block composition.

Append a semantic section to an existing AFFiNE document by heading title and native block composition.

Append document blocks with canonical types and legacy aliases (supports placement + strict validation).

Export AFFiNE document content to markdown.

Export document markdown together with a structured fidelity report that highlights markdown loss risk and unsupported AFFiNE-native content.

Create a new AFFiNE document and import markdown content. Use parentDocId to automatically embed the new doc into a parent, making it visible in the sidebar instead of being an orphan.

Append markdown content to an existing AFFiNE document.

Replace the main note content of a document with markdown content.

Delete a document by removing its workspace metadata entry and sending the AFFiNE WebSocket delete request for its content. This is destructive; use revoke_doc when you only need to remove public access.

Returns the full document hierarchy as a tree (roots → children → grandchildren). Use depth to limit nesting (default: 3). Note: loads all docs — may be slow on large workspaces. Each node includes an inTrash flag.

Find all documents that have no parent (not linked from any other doc via embed_linked_doc / embed_synced_doc blocks or inline LinkedPage references). Useful for workspace hygiene. Note: scans all docs — O(n). Each doc includes an inTrash flag.

List the direct children of a document in the sidebar (embed_linked_doc / embed_synced_doc blocks and inline LinkedPage references). Returns docId, title, URL, and inTrash for each child.

Rename a document — updates both the sidebar title (workspace metadata) and the doc's internal page block title.

Inspect a template doc's native structure, tags, and fallback risk before instantiation.

Instantiate a template using native AFFiNE block cloning when supported, falling back to markdown materialization only when necessary.

Add a row to an AFFiNE database block. Provide cell values mapped by column name or column ID. Title column text is stored on the row paragraph block. Select columns auto-create options by label.

Delete a row from an AFFiNE database block.

Read row titles and database cell values from an AFFiNE database block.

Read schema metadata for an AFFiNE database block, including columns, select options, and view column mappings. Useful for empty databases before any rows exist.

Batch update multiple cells on an existing AFFiNE database row. Include title in the cells map to update the Kanban row title.

Create a useful AFFiNE database/data-view from declarative intent. Supports task_board and issue_tracker presets with starter schema, kanban view, and optional starter rows.

Add a column to an existing AFFiNE database block. Supports rich-text, select, multi-select, number, checkbox, link, date types.

Add a shape, connector, text, or group to the AFFiNE edgeless canvas surface. Shapes support rect/ellipse/diamond/triangle with fill, stroke, and text. Connectors draw arrows between shapes (by id) or between absolute points. Use for building diagrams programmatically. Style fields that don't apply to the chosen element type are reported in the response 'ignored' list (mirrors update_surface_element).

List all shape/connector/text/group elements on the AFFiNE edgeless canvas surface. Returns raw xywh strings plus parsed {x,y,width,height} bounds, with Y.Text fields serialized to plain strings. Optional filters by element type or id.

Partially update a surface element by id. x/y/width/height merge with the element's current xywh (move without resizing, or vice versa). text/label/title replace their Y.Text wholesale. Fields that don't apply to the element's type are reported in the response 'ignored' list.

Delete a surface element by id. Set pruneConnectors=true to also delete any connectors whose source or target referenced the deleted element.

Replace a frame block's contents wholesale. Accepts ids of surface elements (shapes/connectors/groups) AND edgeless blocks (notes/frames/edgeless-text) — all go into BlockSuite's prop:childElementIds map, matching what the editor writes when you drag members into a frame. Dragging the frame drags every owned member. Ids that don't resolve come back under 'missing'. By default the frame is resized to fit its new contents (plus padding + title band); set resizeToFit=false to leave xywh untouched. Pass [] to clear ownership (resize is skipped in that case).

Partially update a note/frame/edgeless-text block by id. x/y/width/height merge with current prop:xywh (move without resizing, or vice versa). background replaces prop:background (AFFiNE token or {light, dark} hex object). Fields that don't apply to the block's flavour come back under ignored.

Delete a block by id. Removes descendants and unlinks from the parent's sys:children by default; set deleteChildren=false to keep descendants orphaned (for re-parenting), or pruneConnectors=true to also drop surface connectors referencing any deleted id. Refuses affine:page — use delete_doc for whole docs.

Read the full edgeless canvas: all edgeless-positioned blocks (notes, frames, edgeless-text) with their xywh, plus all surface elements (shapes, connectors, text, groups). Includes aggregate bounding box and per-type element counts. Use this when you need to understand canvas layout end-to-end before placing new elements.

List paginated comments for a document, including nested replies and resolution state. Use this before update_comment, delete_comment, or resolve_comment when you need the existing comment ids.

Create a new comment on an existing document. This writes collaboration state; use update_comment when editing an existing comment instead.

Replace the content of an existing comment. This preserves the comment thread; use create_comment for a new thread.

Delete an existing comment by id. This is destructive for that comment; use resolve_comment when you only want to mark a thread resolved.

Set a comment thread's resolved state without changing its content. Use delete_comment only when the comment should be removed.

List doc histories (timestamps) for a doc.

List AFFiNE sidebar collections and their rules. Use this read-only tool before updating, deleting, or adding documents to a collection.

Read one AFFiNE sidebar collection by id, including rules and allow-list. Use list_collections first when the id is unknown.

Create a new AFFiNE sidebar collection with optional rules. This writes workspace sidebar metadata but does not create documents.

Replace an AFFiNE collection's rules and rebuild its allow-list from current workspace documents. This can change which docs appear in the collection.

Rename an existing AFFiNE sidebar collection without changing its rules or allow-list.

Delete an AFFiNE sidebar collection. This removes the collection metadata but does not delete the documents it referenced.

Add an existing document id to an AFFiNE collection allow-list. Use update_collection_rules instead when membership should be rule-driven.

Remove a document id from an AFFiNE collection allow-list. This does not delete the document or change collection rules.

Experimental: list AFFiNE sidebar organize folder and link nodes from the folders workspace DB. Use this before moving or deleting organize nodes.

Experimental: create an AFFiNE organize folder node in the sidebar tree. This only changes sidebar organization, not document content.

Create a simple AFFiNE organize folder blueprint with one root folder and optional child folders. This is a convenience wrapper around create_folder.

Experimental: rename an AFFiNE organize folder node. This changes sidebar metadata only and does not rename documents inside the folder.

Experimental: delete an AFFiNE organize folder and every nested folder or link node. This is destructive for sidebar organization but does not delete target documents, tags, or collections.

Experimental: move an AFFiNE organize folder or link node to another folder or root. This preserves the target document, tag, or collection and changes only sidebar placement.

Experimental: add a doc, tag, or collection link under an AFFiNE organize folder. Use move_organize_node for an existing link node instead of creating a duplicate link.

Experimental: delete an AFFiNE organize doc, tag, or collection link node. This removes only the sidebar link, not the target resource.

List the workspace custom-property definitions and a document's current values for them.

Create a workspace-wide custom property definition (text, number, checkbox, or date). Returns its propertyId.

Soft-delete a workspace custom property definition (by propertyId or name). Existing values are hidden.

Set a document's custom property value (property by id or name). Value is validated against the property type (text/number/checkbox/date).

Remove a custom property value from a document (property by id or name).

Set or clear the sidebar icon (the Notion-style emoji slot) on a document. Pass an emoji string, a full icon object, or null to remove it.

Set or clear the sidebar icon on an organize folder. Pass an emoji string, a full icon object, or null to remove it. Experimental.

Read the current sidebar icon of a document. Returns null when none is set.

Read the current sidebar icon of an organize folder. Returns null when none is set. Experimental.

Return the currently authenticated AFFiNE user profile. Use this read-only check to verify credentials before workspace or document operations.

Update current user's profile information.

Update user settings and preferences.

Sign in to AFFiNE using email and password; sets session cookies for subsequent calls.

List metadata for the current user's personal access tokens. Token secrets are not returned; use generate_access_token only when a new secret is needed.

Generate a new personal access token and return its one-time secret. This creates a credential; store the returned token securely because it may not be shown again.

Revoke an existing personal access token by id. This is destructive for API clients using that token; list tokens first if the id is unknown.

Upload a file or blob into AFFiNE workspace storage and return its blob key. This creates stored content but does not attach it to a document by itself.

Delete a blob from AFFiNE workspace storage. Set permanently only when the blob should bypass recoverable deletion.

Permanently release blobs that were already marked deleted in a workspace. This is destructive cleanup and should be used only after confirming deleted blobs are no longer needed.

List the current user's AFFiNE notifications with optional unread filtering. This is read-only and returns notification ids, read state, level, and timestamps.

Mark every current-user notification as read. This mutates notification state; use list_notifications first when you need to inspect unread items.