MCP capabilities and task reference
Use this reference to choose the right operation when working through an external assistant. The connected server supplies its current tool schemas; use those schemas for exact arguments rather than relying on a fixed tool count.
Find and read documentation
| Task | Tools |
|---|---|
| Identify your account and available Spaces | get-user-info, list-spaces |
| Browse pages in a Space | list-space-documents |
| Search one Space or all accessible Spaces | search-space-documents, global-search |
| Read a complete page | get-space-document |
Start with search, then read the relevant document before proposing changes. A search excerpt is not the whole page. Space identifiers are numeric IDs, not public URL slugs.
Create and organize content
Use create-space-document or update-space-document for Markdown page content, with type: "markdown" where required by the tool. Space-item tools manage folders, links, movement, copying, sharing, and deletion. Space tools manage the container itself. Deleting a Space is different from deleting one item inside it.
export-space-items-markdown returns selected content to the assistant. Use DocuWriter’s browser export controls for downloadable PDF or ZIP files. Creating a share link exposes content through a public URL; review the intended audience first.
Generate documentation
list-generators describes available operations. Supplied-code tools cover documentation, tests, comments, optimization, diagrams, OpenAPI, and language conversion. Repository README and selected-file documentation require an imported repository. Codebase generation creates a Space with queued documentation work.
Full Tree generation has a review step: retrieve an existing preview with get-full-tree-documentation-preview, inspect it, and submit generate-full-tree-documentation only after accepting that tree. Pass the returned acceptance hash. Creating the first preview and editing its structure remain browser tasks. A queued workflow is not a completed document.
Existing generation tools list, read, rename, archive, restore, select a definitive version, add results to a Space, and create share links. Use archive/restore for generation history rather than assuming a delete operation exists.
Review documentation against repository changes
Use this workflow to check an existing repository-backed Space against its connected branch. A request to revise prose belongs to update-space-document; Autopilot configuration uses repository-link tools; new documentation uses generators. Clarify a vague request such as “update docs” before choosing the workflow.
| Operation | Tool and inputs | Result |
|---|---|---|
| Inspect scope and cost | inspect-documentation-update: space_id, optional selected_page_ids |
Eligibility, repository/branch, baseline and target commits, review mode, selected/affected pages and rationale, maximum credits, available credits and a review quote |
| Start an approved review | start-documentation-update: space_id, accepted review_quote |
Run ID, actual status, reserved maximum and browser review URL |
| Check progress | get-documentation-update-status: space_id, optional run_id |
Requested or latest run, progress, pending-change counts, credit usage and browser review URL |
Inspect before approving paid work
Resolve the intended numeric Space ID using list-spaces. Preserve any page scope the user already specified and resolve the actual page IDs through authorized discovery. A current page, repository name or attached document does not establish permission to manage the Space.
Inspection may read the connected repository provider, but invokes no models, queues no work and reserves no credits. Show the Space, branch, selected or affected pages and reasons before the maximum credit cost. Inspection does not authorize paid work.
Page selection applies only to first/full reviews. Omitting it includes all reviewable pages; diff reviews reject page selection rather than silently ignoring it. A partial review does not advance the Space’s shared reviewed-commit baseline.
Start only after explicit approval
Obtain explicit user authorization for the inspected scope and maximum cost before calling start-documentation-update with the returned quote. MCP clients control their own confirmation interfaces; do not expect a second DocuWriter approval card. A quote or tool annotation is not proof of human consent.
Quotes expire after 30 minutes and bind the requester, effective payer, Space, repository source/branch, commits, review mode, page scope/content and maximum credits. If permissions, payer, source, scope, content or price change, inspect again and obtain approval for the new facts. Never silently broaden scope or increase the approved cost.
Submitting the same accepted quote again returns the same authorized run, including after completion or failure. It does not start or resume another paid attempt. If a different review is already active, use the returned conflict and browser link instead of queueing another review.
A paid plan, permission to manage the Space and an available Git provider connection are required. One-time ZIP sources are excluded. Follow returned guidance for reconnection, busy work, eligibility or insufficient credits.
Check status and finish in the browser
Status reads persisted state only; it does not poll providers, invoke models, queue work or return proposal bodies/diffs. Report the actual state, such as “review queued,” “running,” “paused,” “failed” or “ready for review.” Starting analysis does not mean documentation has been updated.
Preserve the run’s actual page scope, especially when an existing run covers more pages than the latest request. Run-level settled credit usage is not the account balance. The maximum review cost covers analysis; it is not an allowance for generating new pages. Unused review reservation is released when the review settles.
Open the returned browser review URL to inspect diffs, apply or reject changes, approve new pages, resume or end the run. These decisions remain browser actions; Autopilot suggestion tools are a separate workflow. Explain paused/failed states and link the browser rather than automatically retrying.
Example request: “Check the Engineering Space against repository changes. Show the affected pages and maximum credits before starting a review.” After approval and analysis, ask: “Check that review’s progress and give me its browser review link.”
Maintain the workspace
Other tool families cover Autopilot links and suggestions, team members and invitations, webhook subscriptions and delivery logs, AI preferences, and provider-connection status. Read the target resource before a change and verify the result afterward. Autopilot access still follows your plan and team permissions.
Complete browser-only steps
Provider consent, repository import and initial selection, local uploads, billing, password/security settings, API-token secrets, and browser downloads use DocuWriter’s UI. An assistant can guide you there without claiming it completed the action. External clients control MCP tool confirmations; see approval behavior.