MCP Tools

Find and cite source pages, save decisions and handoffs, and work with files and documents in the same MindWiki vault you use in your apps. The tables cover the standard vault tools at https://api.mindwiki.io/mcp. Check tools/list in your client for its current catalog and complete input schemas. Use mindwiki_get_capabilities to inspect connection scopes, account permissions, and feature availability.

Access and availability

OAuth access	What it permits
`mcp:read`	Core retrieval and inspection.
`mcp:capture`	Retrieval and new inbox notes.
`mcp:write`	Retrieval, capture, and supported page and folder writes.
`mcp:operate`	The above plus advanced workflows, subject to plan and account permissions.
Legacy `mcp`	Retrieval, capture, and supported writes. Advanced workflows use the explicit `mcp:operate` grant.

Free includes one external AI connection with core search, read, capture, and page editing. Pro and Power can use advanced workflows as available. A tool can appear in discovery before the connected account has authority to use it. The credential, MindWiki plan, vault permissions, and the client's own tool controls determine what succeeds. See MCP Server for connection and troubleshooting steps.

Vault app and host extensions

The standard server also exposes interactive vault tools to authenticated connections. There are 11 registrations across vault launch and navigation, note search and preview, capture, the Markdown file viewer, composer note mentions, and preview preferences. Some are called by the app or by a host launcher. Native capture confirmation uses the host's form capability through modern MCP discovery. Permission to capture or save settings is checked when the action runs. See ChatGPT for how to use these features.

Search and read

Tool	Main inputs	Access	Purpose
`search`	`query`	Read	Find matching vault pages for assistant retrieval and citations.
`fetch`	`id`	Read	Load the text and URL of a page identified by search.
`mindwiki_search`	`query`, optional `limit`	Read	Search by keyword and meaning.
`mindwiki_read_page`	`path`	Read	Read a page and obtain its current content hash.
`mindwiki_read_page_slice`	`path`, optional `offset`, `limit`, `expected_hash`	Read	Read part of a long page with offsets and revision information.
`mindwiki_list_pages`	Optional `prefix`, `cursor`, `limit`	Read	List page paths and titles. Follow `next_cursor` for more pages.
`mindwiki_ask`	`question`, optional `max_pages`	Read	Ask a vault-grounded question and receive an answer with its sources.
`mindwiki_similar`	`path`, optional `limit`	Read	Find pages related to a known page.
`mindwiki_graph`	Optional `limit`	Read	Inspect a bounded set of graph nodes and links.
`mindwiki_get_relevant_context`	`goal`, optional `constraints`, `limit`	Read	Retrieve relevant pages for a specific task.

Read relevant sources before making detailed claims. Include page titles and links so users can verify the answer.

text

Search MindWiki for our homepage audience research. Read the strongest sources, summarize the findings, and distinguish recorded decisions from open questions.

Save and maintain knowledge

Tool	Main inputs	Access	Purpose
`mindwiki_capture`	`content`, optional `title`, `idempotency_key`	Capture	Save a new inbox note under `capture/`.
`mindwiki_write_page`	`path`, `content`, optional `base_hash`, `message`, `idempotency_key`	Write	Create a page or replace the complete Markdown of an existing page.
`mindwiki_edit_page`	`path`, `base_hash`, `old_text`, `new_text`, `idempotency_key`	Write	Replace one exact, unique passage at the expected revision.
`mindwiki_create_folder`	`path`, `idempotency_key`	Write	Create a folder by saving its initial README.
`mindwiki_lint`	None	Read	Report orphan pages and unresolved indexed wikilinks.
`mindwiki_update_index`	Optional `batch_size`, `rebuild_index_page`	Write	Refresh a bounded batch of search embeddings and optionally refresh the generated index. Preserves owner-authored indexes.

Create without overwriting

Omit base_hash or pass an empty string to create a new page. If a page already exists at that path, MindWiki returns a conflict.

json

{
  "path": "projects/website-launch/handoff.md",
  "content": "# Website Launch Handoff\n\n## Next action\nReview the audience brief.\n",
  "message": "Record the launch handoff",
  "idempotency_key": "website-launch-handoff-initial-save"
}

Update from the current revision

Read the existing page.
Retain the returned content_hash.
Compose the complete updated document, preserving material outside the intended change.
Call mindwiki_write_page with that hash as base_hash.
Inspect the outcome and saved path.

If the revision is stale, read again and reconcile the newer content. Use mindwiki_edit_page for one exact passage when you know its current text. mindwiki_write_page replaces the complete Markdown body.

After a timeout, reuse the same idempotency_key with identical arguments for the same intended save. A different or revised save needs a new key. Check the destination when the result is uncertain.

Account, setup, and activity

Tool	Main inputs	Access	Purpose
`mindwiki_get_capabilities`	None	Read	Inspect credential scopes, account permissions, and supported features and limits.
`mindwiki_account_status`	None	Read	Inspect account, capture, and starter readiness.
`mindwiki_complete_setup`	`username`	Write	Assign a capture name to an account with incomplete setup.
`mindwiki_initialize_starter`	None	Write	Initialize starter pages for an eligible new vault while preserving existing content.
`mindwiki_request_recovery`	None	Write	Record a pending request for the owner to finish on MindWiki.
`mindwiki_get_agent_operating_guide`	`file` (optional)	Read	Read the vault's optional guide or one section when the user's vault conventions affect the task.
`mindwiki_get_agent_activity`	Optional `limit`	Read	Inspect recent recorded MCP activity if that permission is enabled.
`mindwiki_list_agent_sessions`	Optional `limit`	Read	Inspect recent connected-client sessions if that permission is enabled.

Advanced workflows

The tools below require mcp:operate. The tables list required inputs or required alternatives. Inspect the client schema for optional filters, paging, supported enum values, and the properties of typed inputs such as input or design.

Pixel conversations, tasks, and memory

Use the latest turn and a fresh request ID for each new message. Follow mindwiki_pixel_wait or mindwiki_pixel_get_task until the task reports a terminal state or asks for input. Report a queued or running task as pending. Reuse a request ID only when retrying the identical action.

Tool	Required inputs	Purpose
`mindwiki_pixel_converse`	`conversation_id`, `request_id`, `message`, `expected_turn`	Submit one turn in a saved conversation. Continue with the returned state and current turn.
`mindwiki_pixel_list_conversations`	None	List accessible conversations.
`mindwiki_pixel_get_conversation`	`conversation_id`	Read a conversation transcript and its current turn.
`mindwiki_pixel_start_task`	`request_id`, `conversation_id`, `prompt`	Start durable work and receive a task ID.
`mindwiki_pixel_list_tasks`	None	List tasks, optionally for one conversation.
`mindwiki_pixel_get_task`	`task_id`	Read progress, pending input, and verified results.
`mindwiki_pixel_wait`	`task_id`	Wait briefly for a task update. It can return while work is still running.
`mindwiki_pixel_control_task`	`task_id`, `action`, `request_id`	Pause, resume, cancel, or steer a task.
`mindwiki_pixel_get_artifact`	`task_id`, `index`, `sha256`	Retrieve verified artifact metadata and an authorized delivery reference.
`mindwiki_pixel_list_memory`	None	List advisory entries in the selected account or folder profile.
`mindwiki_pixel_recall_memory`	`query`	Search advisory entries in the selected profile.
`mindwiki_pixel_remember`	`content`, `request_id`	Save an explicitly requested preference or instruction.
`mindwiki_pixel_forget_memory`	`memory_id`	Remove one advisory memory entry while preserving its source pages.

Folder agents and assignments

A folder question starts a task even when the question only reads files. Use the task status tools to retrieve its answer. A draft or revised schedule needs the applicable owner approval before it can run automatically.

Tool	Required inputs	Purpose
`mindwiki_list_folder_agents`	None	List folders and their enrollment, pause, and catch-up status.
`mindwiki_get_folder_agent`	`folder_id`	Read a folder's instructions, source coverage, and current revision.
`mindwiki_ask_folder_agent`	`folder_id`, `request_id`, `question`	Start a folder-scoped question and follow it by task ID for sources and results.
`mindwiki_update_folder_agent`	`folder_id`, `revision`	Change instructions or pause status using the current folder revision.
`mindwiki_list_folder_assignments`	None	List assignments for the vault or a selected folder.
`mindwiki_get_folder_assignment`	`assignment_id`	Inspect an assignment, its schedule, and recent outcomes.
`mindwiki_draft_folder_assignment`	`folder_id`, `assignment_id`, `input`	Save a disabled assignment for owner review.
`mindwiki_update_folder_assignment`	`assignment_id`, `input`	Revise an assignment. The owner reviews and re-enables the updated schedule.
`mindwiki_run_folder_assignment`	`assignment_id`, `request_id`	Start one authorized occurrence of an existing assignment.
`mindwiki_control_folder_assignment`	`assignment_id`, `revision`, `action`. Stop also requires `run_id`.	Pause future runs, start re-enablement review, or stop a specific run.
`mindwiki_list_folder_runs`	`assignment_id`	Inspect occurrences, failures, source coverage, and saved outputs.

Rich documents and collaboration

Check the current document revision before submitting changes. Sharing, accepting a suggestion, and restoring a revision each change a specific document. Verify the resulting permission, revision, or state.

Tool	Required inputs	Purpose
`mindwiki_list_documents`	None	List documents available to the connected account.
`mindwiki_get_document`	`document_id` or `path`	Read a rich document by ID or path, or read a plain Markdown page by path without enrolling it.
`mindwiki_write_document`	`input`. Use `document_id` with the current revision to update, or `path` to create. To enroll an existing plain note, also pass `expected_page_hash` and the unchanged Markdown.	Save rich structure and Markdown in one revision.
`mindwiki_copy_document`	`document_id`, `input`	Copy a document without copying its sharing grants or recurring assignments.
`mindwiki_move_document`	`document_id`, `input`	Move or rename a document while preserving its identity.
`mindwiki_list_document_revisions`	`document_id`	List available revision metadata.
`mindwiki_get_document_revision`	`document_id`, `revision_id`	Read one historical revision and its scoped assets.
`mindwiki_restore_document_revision`	`document_id`, `input`	Roll back an active document or recover a trashed document from a selected revision. Requires the current base revision.
`mindwiki_list_document_annotations`	`document_id`	Read comments, suggested edits, and their resolution state.
`mindwiki_add_document_comment`	`document_id`, `input`	Add a comment anchored to a current revision.
`mindwiki_resolve_document_comment`	`document_id`, `comment_id`, `resolved`	Resolve or reopen a comment.
`mindwiki_suggest_document_edit`	`document_id`, `input`	Record a suggested edit anchored to its source.
`mindwiki_review_document_suggestion`	`document_id`, `suggestion_id`, `input`	Accept or reject a specific suggested edit with revision checks.
`mindwiki_list_document_grants`	`document_id`	Inspect a document's sharing roles.
`mindwiki_set_document_grant`	`document_id`, `role`. Use `recipient` to grant or `actor_id` to update or revoke.	Grant, change, or revoke a particular recipient's role.
`mindwiki_list_document_trash`	None	List recoverable documents in Trash.
`mindwiki_trash_document`	`document_id`, `input`	Move an explicitly selected document to Trash.

Import, export, and PDF

Use the preview before converting DOCX, ODT, RTF, or EPUB. PDF export returns a renderer job for an existing document or a structured report. Wait for a verified completed job before downloading or saving its output.

Tool	Required inputs	Purpose
`mindwiki_preview_document_import`	`path`, `format`	Inspect conversion warnings, assets, and the source hash.
`mindwiki_import_document`	`source_path`, `format`, `path`, `request_id`, `source_hash`, `input_hash`, `source_generation`	Import a reviewed conversion as a new private document.
`mindwiki_preview_document_export`	`input`	Preview export and inspect hashes and warnings.
`mindwiki_export_document_format`	`input`	Export the reviewed source in the requested editable format.
`mindwiki_preview_pdf`	`input`	Preview the source, layout, and conversion warnings.
`mindwiki_export_pdf`	`input`	Queue a private PDF of the source page, or provide a structured `report` with verified sources.
`mindwiki_get_pdf_job`	`request_id`	Inspect renderer status and request authorized delivery when ready.
`mindwiki_control_pdf_job`	`request_id`, `action`	Cancel a pending private PDF job.
`mindwiki_save_pdf`	`request_id`, `task_id`, `name`	Store a completed PDF privately in the vault with verification.

Attachments and vault archives

Upload binary parts through the private transfer URL and verify completion before using the file. Review the archive manifest and destination before confirming a restore. A ready preview shows what would be restored. A completed restore reports its new destination.

Tool	Required inputs	Purpose
`mindwiki_list_attachments`	None	List stored files with metadata about preview and extraction support.
`mindwiki_get_attachment`	`path`	Read bounded metadata or obtain an authorized file reference.
`mindwiki_start_file_upload`	`id`, `name`, `bytes`	Start a resumable binary upload and obtain a part-transfer ticket.
`mindwiki_get_file_upload`	`upload_id`	Inspect committed parts, checksum verification, and upload state.
`mindwiki_control_file_upload`	`upload_id`, `action`	Renew transfer access, finish verification, or cancel.
`mindwiki_start_vault_export`	`request_id`	Queue a private vault archive export.
`mindwiki_prepare_vault_restore`	`request_id`, `bytes`	Prepare an archive upload and preview the proposed restore.
`mindwiki_get_vault_archive`	`archive_id`	Inspect archive progress, preview details, or completed output.
`mindwiki_confirm_vault_restore`	`archive_id`, `expected_manifest_hash`, `expected_destination`	Commit the reviewed archive into its new restore folder.
`mindwiki_control_vault_archive`	`archive_id`, `action`	Renew transfer access, finish upload, retry, or cancel. Use the archive status tool to download a completed export.

Publications and profile photos

Review the preview, target, and public visibility before publishing. Review the effects of a photo change on the public notebook avatar. Editing the private source and publishing an article are separate actions.

Tool	Required inputs	Purpose
`mindwiki_get_publication`	None	Inspect the publication profile and authorized article state.
`mindwiki_preview_publication`	`input`	Preview a specific article revision privately.
`mindwiki_publish_document`	`input`	Publish the exact reviewed article and options.
`mindwiki_unpublish_document`	`publication_id`	Remove the public article while retaining its private source.
`mindwiki_get_publication_design`	None	Read saved typography, background, and design version.
`mindwiki_preview_publication_design`	`design`, `expected_version`	Preview a design and share card privately.
`mindwiki_save_publication_design`	`design`, `expected_version`, `preview_hash`	Apply a reviewed design after revision and preview checks.
`mindwiki_update_publication_profile`	`handle`, `title`, `author`, `bio`	Change the public handle, name, or profile fields.
`mindwiki_list_publication_revisions`	`publication_id`	List revisions of the selected publication.
`mindwiki_restore_publication_revision`	`publication_id`, `revision_id`, `version`	Restore a specific public revision.
`mindwiki_get_share_card`	None	Get the saved public notebook or published article share-card URL.
`mindwiki_get_account_photo`	None	Inspect the current avatar version and authorized image reference.
`mindwiki_set_account_photo`	`path`, `request_id`, `expected_version`	Apply a validated cropped photo to the account and public notebook avatar.
`mindwiki_remove_account_photo`	`request_id`, `expected_version`	Remove the current avatar using an expected version.

Older integrations and guides

Use mindwiki_restore_document_revision for both document revision rollback and Trash recovery. Use mindwiki_export_pdf for both source-page PDF exports and structured PDF reports.

Context Pack and vault proposal MCP tools have retired. Existing packs, proposals, and user-authored guide files are preserved. Use mindwiki_get_relevant_context or search and read for task background. For document collaboration, use the current document comments and suggested-edit tools when your connection permits them.

Next: MCP Server, Vault Health & Permissions, and API Access.