api-doc-mcp v1.0.5

api-doc-mcp

This is a set of MCP tools for managing and retrieving OpenAPI documentation.

Features

This toolkit provides the following features:

1. List all API groups
2. List APIs in a specified group
3. Get API details
4. Search APIs

Installation

npm install api-doc-mcp

Build

npm run build

Usage

Command Format

npx api-doc-mcp [API_DOC_URL] <command> [parameters]

Examples

1. View help:

npx api-doc-mcp

2. List all API groups:

npx api-doc-mcp https://api.example.com/swagger.json listApiGroups

3. List APIs in a specified group:

npx api-doc-mcp https://api.example.com/swagger.json listGroupApis --groupName user

4. Get API details:

npx api-doc-mcp https://api.example.com/swagger.json getApiDetail --path /users --method get

5. Search APIs:

npx api-doc-mcp https://api.example.com/swagger.json searchApis --keyword user

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