MCP tools

Generation

Start, check, and cancel documentation generations for a project through the MCP server

What these tools do

Three MCP tools let a connected agent run documentation generations for your projects. A generation is one run of Doxabot, which reads the GitHub repository connected to a project, writes MDX pages, and stores the result as a new docs version. Your agent can start a run, check its state, and cancel it.

ToolWhat it doesScope needed
start_generationStarts a generation for a project.generation:run
get_generationReturns the current state of a generation.projects:read
cancel_generationCancels a generation.generation:run

The generation:run scope implies projects:read. For how scopes are chosen and limited, see MCP Scopes and Approval Requests.

Before you start

  • Connect a repository first. A generation reads a GitHub repository. Doxa returns a repository-required error for a project that has no repository connected.

  • Grant the right scope. Give the agent generation:run when it should start or cancel runs. Give projects:read alone when it only needs to check status.

  • Check your role on the project. Tools use your role on the project. If your role does not allow an action, the tool reports the project as not found.

Start a generation

Ask your agent in plain language. The agent calls start_generation for the project you name.

text
Start a docs generation for my "Acme API" project and tell me when it finishes.

After the run starts, the agent can call get_generation to read its state. You can follow the same run on the Generations page of the dashboard. See Generations and Doxabot Instructions for what a generation produces.

Check progress

Ask the agent for the status of a run:

text
What is the status of the latest generation for "Acme API"?

The agent calls get_generation and reports the result. Use the Generations page in the dashboard for the full history.

Cancel a generation

Ask the agent to stop a run that is still in progress:

text
Cancel the running generation for "Acme API".

cancel_generation stops a generation through the generation:run scope. Check the Generations page to confirm the run has stopped.

Note:

A generation can replace pages that a person wrote or approved. Before you start a run on a project with hand-written pages, review the output on a branch before you publish it. See Branches, Previews, Publishing, and Restore.