What is docfy-mcp

What it is

docfy-mcp is an MCP (Model Context Protocol) server: it exposes an OpenAPI catalog (ideally one nestjs-docfy already documented, but any valid OpenAPI 3.0/3.1 spec works) as tools a connected coding agent can call directly.

Five tools: list_endpoints and get_endpoint to discover and inspect endpoints, lint_spec to check spec quality, diff_specs to compare against another version, and contract_test to validate a live server against the spec.

Why it exists

Without it, an agent implementing a client against your API has two options: guess the shape from context, or ask a human to open a browser, find the Swagger UI, and paste the relevant bit back into the chat. Both are slower and less reliable than a direct tool call.

How it fits with nestjs-docfy

docfy-mcp is built on the same document-model engine docfy-ui uses: the shared package docfy-core.

get_endpoint's output is the exact same text docfy-ui's Copy for AI button copies, generated by the same operationToAiText() function. The two projects are two different front ends onto the same model: one for a human in a browser, one for an agent over stdio.