API Doc

You can manage and retrieve OpenAPI documentation with this MCP toolset, supporting both remote APIs and local JSON files. It lets you list API groups, inspect APIs in a group, fetch detailed API information, and search APIs, with auto-refresh on each request to keep your docs up to date.

How to use

To use the API documentation MCP, run it with either a remote Swagger URL or a local swagger.json file. You can access all tooling from the command line via these patterns:

How to install

Prerequisites: ensure Node.js and npm are installed on your system.

Install Node.js and npm if they are not already present. Then you can use the MCP client commands shown below.

Install and run the MCP client examples:

1. Install dependencies (if needed) and run the client directly with npx.

Examples and configuration

{
  "mcpServers": [
    {
      "type": "http",
      "name": "api_doc_mcp_http",
      "url": "http://localhost:8000/swagger.json",
      "args": []
    },
    {
      "type": "stdio",
      "name": "api_doc_mcp_cli_remote",
      "command": "npx",
      "args": ["-y", "api-doc-mcp", "http://localhost:8000/swagger.json"]
    },
    {
      "type": "stdio",
      "name": "api_doc_mcp_cli_local",
      "command": "npx",
      "args": ["-y", "api-doc-mcp", "./swagger.json"]
    }
  ]
}

Additional notes

The toolset supports listing API groups, listing APIs in a group, obtaining API details, and searching APIs. It handles both remote and local sources and automatically refreshes documentation when you request it.

Tools and capabilities

• listApiGroups: List all available API groups with name, description, and API count.

• listGroupApis: List all APIs in a specific group by group name, returning path, method, and summary.

• getApiDetail: Retrieve complete details for a specific API, including parameters, request body, and responses.

• searchApis: Find APIs by keyword, returning path, method, and summary.

Available tools

listApiGroups

List all available API groups with name, description, and API count.

listGroupApis

List all APIs in a specified group, returning path, method, and summary.

getApiDetail

Get detailed information about a specified API, including parameters, request body, and response definition.

searchApis

Search APIs by keyword, returning path, method, and summary.