Installation & usage

npx docfy-mcp --spec/--url, registrando o .mcp.json, --header para specs autenticadas.

Requisitos

Publicado no npm — sem clone, sem build. O único requisito é o próprio Node; o npx busca o docfy-mcp no primeiro uso.

Início rápido

bash
# from a static file
npx docfy-mcp --spec ./openapi.json

# from a locally running NestJS server
npx docfy-mcp --url http://localhost:3000/docs-json

--url busca a spec diretamente em vez de delegar ao resolver HTTP próprio do swagger-parser — esse resolver tem uma proteção SSRF que bloqueia localhost/IPs privados por padrão, o que quebraria o caso mais comum aqui: apontar pro dev server NestJS local.

Registrando como servidor MCP

json
{
  "mcpServers": {
    "docfy": {
      "command": "npx",
      "args": ["-y", "docfy-mcp", "--url", "http://localhost:3000/docs-json"]
    }
  }
}

Pra specs atrás de auth, repita --header quantas vezes precisar.

bash
npx docfy-mcp --url https://api.example.com/api-json --header "Authorization: Bearer xyz"

Options

OptionDefaultDescription
--spec <path>—Local OpenAPI JSON/YAML file
--url <url>—URL to fetch the spec from
--header <name: value>noneRepeatable — extra header sent with --url requests

Resolvendo um 404

O path do JSON OpenAPI não é uma convenção fixa — depende do que seu projeto passou pra SwaggerModule.setup().

Se --url der 404, o docfy-mcp sonda um punhado de paths-irmãos comuns na mesma origem (/api-json, /docs-json, /swagger-json…) e sugere qualquer um que parseie como um documento OpenAPI de verdade.