Api Doc Mcp
What is Api Doc Mcp
api-doc-mcp is a toolkit designed for managing and retrieving OpenAPI documentation efficiently.
Use cases
Use cases include viewing API documentation, managing multiple API groups, retrieving specific API details for debugging, and searching for APIs based on keywords.
How to use
To use api-doc-mcp, run the command ‘npx api-doc-mcp <API_DOC_URL_OR_FILE_PATH>’ in your terminal. You can specify either a remote API documentation URL or a local JSON file path.
Key features
Key features include listing all API groups, listing APIs in a specified group, retrieving API details, searching APIs, supporting both remote and local documentation, and auto-refreshing API documentation on each request.
Where to use
api-doc-mcp can be used in software development environments where OpenAPI specifications are utilized, such as backend development, API management, and documentation generation.
Clients Supporting MCP
The following are the main client software that supports the Model Context Protocol. Click the link to visit the official website for more information.
Overview
What is Api Doc Mcp
api-doc-mcp is a toolkit designed for managing and retrieving OpenAPI documentation efficiently.
Use cases
Use cases include viewing API documentation, managing multiple API groups, retrieving specific API details for debugging, and searching for APIs based on keywords.
How to use
To use api-doc-mcp, run the command ‘npx api-doc-mcp <API_DOC_URL_OR_FILE_PATH>’ in your terminal. You can specify either a remote API documentation URL or a local JSON file path.
Key features
Key features include listing all API groups, listing APIs in a specified group, retrieving API details, searching APIs, supporting both remote and local documentation, and auto-refreshing API documentation on each request.
Where to use
api-doc-mcp can be used in software development environments where OpenAPI specifications are utilized, such as backend development, API management, and documentation generation.
Clients Supporting MCP
The following are the main client software that supports the Model Context Protocol. Click the link to visit the official website for more information.
Content
api-doc-mcp
This is a set of MCP tools for managing and retrieving OpenAPI documentation.
Features
This toolkit provides the following features:
- List all API groups
- List APIs in a specified group
- Get API details
- Search APIs
- Support both remote API docs and local JSON files
- Auto-refresh API documentation on each request
Usage
For cursor
# remote api
npx -y api-doc-mcp http://localhost:8000/swagger.json
# local file
npx -y api-doc-mcp ./swagger.json
Build
npm run build
Usage
Command Format
npx api-doc-mcp <API_DOC_URL_OR_FILE_PATH>
Examples
- View help:
npx api-doc-mcp
- List all API groups (Remote API):
npx api-doc-mcp https://api.example.com/swagger.json
- List all API groups (Local file):
npx api-doc-mcp ./swagger.json
Development
npm run dev
Tool Description
listApiGroups
List all available API groups.
Returns:
- name: Group name
- description: Group description
- apiCount: API count
listGroupApis
List all APIs in a specified group.
Parameters:
- groupName: API group name
Returns:
- path: API path
- method: HTTP method
- summary: API summary
getApiDetail
Get detailed information about a specified API.
Parameters:
- path: API path
- method: HTTP method
Returns:
- Complete API details, including parameters, request body, and response definition
searchApis
Search APIs.
Parameters:
- keyword: Search keyword
Returns:
- path: API path
- method: HTTP method
- summary: API summary
Dev Tools Supporting MCP
The following are the main code editors that support the Model Context Protocol. Click the link to visit the official website for more information.
