Skip to content
SpecifyDocs

Workflows

Keep API docs up to date

Compare code with API explanations and inspect direct updates to linked documents alongside requests, responses, and examples.

When API code and its documented requests or responses diverge, read the current implementation and keep reviewing the linked documentation after changes.

Prepare the sources

Prepare the GitHub repository and branch containing routes, handlers, and schemas. Identify the existing API document and its audience. Keep actual credentials and production secrets out of documentation.

Project overview created from Mamma source code
Inspect source evidence and the main components in a document.

Generate and review

Ask in chat for an API reference based on the repository. If the call flow is difficult to understand, request a diagram of clients, servers, and external services. Compare paths, methods, required fields, status codes, authentication, permissions, pagination, errors, and examples with the actual handlers, schemas, and tests.

Update after code changes

Link the repository and branch to the existing document or canvas you want to keep updated. A push to that branch can start a run that edits the linked content directly. Check the resulting body and history to review the applied changes. Link each additional guide you want to maintain to its repository.

Example chat request

Read the current branch of the API repository and write documentation for order creation.
Include requests, responses, errors, permissions, and examples with source file paths.
Mark unverified behavior as unknown and explain the call flow.
A person must decide migration guidance and communication for breaking changes. To change the implementation, create an improvement document and ask the coding agent to read it over MCP. Review the linked documents again after the push.

GitHub · MCP