API Docs MCP 8f858544

MCP开发工具

提供方 DucDA177

开发工具 未标注 Token 社区 / 第三方 Claude DesktopClaudeCursorWindsurf

一个基于OpenAPI/Swagger文件的模型上下文协议(MCP)服务器,提供API定义的搜索、探索和查询工具,适用于开发人员快速获取API信息。

一句话选型结论

按资料字段整理

API Docs MCP 8f858544 属于开发工具类 MCP 服务器,传输方式未标注,Token,可直接接入 Claude Desktop、Claude、Cursor 等,没有现成安装命令,需按官方文档接入。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类开发工具 传输方式未标注 鉴权Token 部署方式未标注
GitHub 星标 0 仓库热度,无公开仓库时显示未标注
工具数 8 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

开发工具
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量8暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

API文档JavaScript本地部署OpenAPISwaggerAPI查询开发工具

安装与配置

未标注 Token
上游未给出传输方式
  1. 1
    准备运行环境

    按官方文档确认运行环境(常见为 Node.js 或 Python),装好后再执行安装命令。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后客户端会列出约 8 个工具,随便调一个只读工具确认能返回结果。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
代码与仓库操作

在对话里直接查代码、提 issue、走 PR,省掉来回切工具。

本地命令与脚本

把构建、测试、格式化这类重复命令交给模型执行。

接口联调与测试

让模型调你的接口、跑一遍用例,快速定位问题。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 资料标注 8 个工具,职责相对集中,接入后不容易误操作。
  • 已适配 Claude Desktop、Claude、Cursor,换客户端不用重新研究配置。

先想清楚的地方

  • 没有现成安装命令,需要按官方文档自己填启动命令和参数。
  • 使用前要准备好Token对应的凭据,并按最小权限配置。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在开发工具场景里让模型直接调用外部能力的人。
  • 已经在用 Claude Desktop、Claude 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
API Docs MCP 8f858544当前 8 未标注 未标注 无 2026-05-17
Git 838e2ec1 12 stdio · 本地进程 本地部署 有 2026-05-17
Markitdown MCP 2c653a5f 1 stdio · 本地进程 本地部署 有 2026-05-17
JavaGuide 未标注 stdio · 本地进程 本地部署 有 2026-04-11
awesome-claude-skills 未标注 stdio · 本地进程 本地部署 有 2026-04-26
Context7 831acf40 未标注 stdio · 本地进程 本地部署 有 2026-05-17

服务器档案

开发工具
字段来自项目仓库与公开索引,中文说明由本站标注
提供方DucDA177上游标注的维护方 DucDA177
分类开发工具本站按上游分类展示
连接方式未标注上游未给出传输方式
鉴权方式Token远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · 未标注本地安装时用到的包标识与运行时
部署类型未标注上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

10.8 KB
来自项目仓库与上游目录的原文,未做删改

API Docs MCP Server

A Model Context Protocol (MCP) server that provides tools to explore and query API definitions from OpenAPI/Swagger JSON files.

Overview

This MCP server reads API definition files from the directory D:\My works\DauTuCong\Frontend\src\assets\api-definitions and provides various tools to search, explore, and retrieve information about the APIs defined in those files.

Features

  • List all APIs: Get an overview of all available API definitions
  • Search by tag: Find endpoints grouped by functional tags
  • Search by path: Find endpoints using path pattern matching (supports regex)
  • Get endpoint details: Retrieve complete information about specific endpoints including parameters, request bodies, and responses
  • Get schema details: Explore data models and schemas defined in the API specifications
  • List schemas: View all available schemas in a specific API definition

Installation

  1. Install dependencies:```bash
    npm install

## MCP Setup for AI Agents

This MCP server can be used with various AI coding assistants and agents. Below are setup instructions for common platforms.

### Claude Code (Claude Desktop)

1. Open Claude Desktop settings
2. Navigate to the MCP servers configuration
3. Add the following configuration:```json
{
  "mcpServers": {
    "api-docs": {
      "command": "node",
      "args": ["d:/My works/api-docs-mcp/index.js"],
      "env": {
        "API_DEFINITIONS_DIR": "D:/My works/DauTuCong/Frontend/src/assets/api-definitions"
      }
    }
  }
}
  1. Save the configuration and restart Claude Desktop
  2. The MCP server tools will now be available in Claude Code

Cline (VS Code Extension)

  1. Install the Cline extension from the VS Code Marketplace
  2. Open VS Code settings (Ctrl/Cmd + ,)
  3. Search for "Cline: MCP Servers"
  4. Add the MCP server configuration:```json
    {
    "cline.mcpServers": [
    {
    "name": "api-docs",
    "command": "node",
    "args": ["d:/My works/api-docs-mcp/index.js"],
    "env": {
    "API_DEFINITIONS_DIR": "D:/My works/DauTuCong/Frontend/src/assets/api-definitions"
    }
    }
    ]
    }

5. Save the settings and reload VS Code
6. The MCP tools will be available in Cline

### Kilo Code

1. Open Kilo Code settings
2. Navigate to MCP servers configuration
3. Add the server configuration:```json
{
  "mcpServers": {
    "api-docs": {
      "command": "node",
      "args": ["d:/My works/api-docs-mcp/index.js"],
      "env": {
        "API_DEFINITIONS_DIR": "D:/My works/DauTuCong/Frontend/src/assets/api-definitions"
      }
    }
  }
}
  1. Save and restart Kilo Code
  2. The MCP server will be automatically connected

Windsurf (Codeium)

  1. Open Windsurf settings
  2. Navigate to Extensions → MCP
  3. Add a new MCP server with the following configuration:
  • Name: api-docs
  • Command: node
  • Arguments: d:/My works/api-docs-mcp/index.js
  • Environment Variables:
  • API_DEFINITIONS_DIR = D:/My works/DauTuCong/Frontend/src/assets/api-definitions
  1. Save the configuration
  2. Restart Windsurf to activate the MCP server

Cursor

  1. Open Cursor settings (Ctrl/Cmd + ,)
  2. Navigate to the MCP servers section
  3. Add the following configuration:```json
    {
    "cursor.mcpServers": {
    "api-docs": {
    "command": "node",
    "args": ["d:/My works/api-docs-mcp/index.js"],
    "env": {
    "API_DEFINITIONS_DIR": "D:/My works/DauTuCong/Frontend/src/assets/api-definitions"
    }
    }
    }
    }

4. Save the settings
5. Reload Cursor to apply the changes

### General MCP Configuration Notes

- **Path Adjustments**: Update the file paths in the configurations above to match your actual project location
- **Environment Variable**: The `API_DEFINITIONS_DIR` environment variable should point to your API definitions directory
- **Permissions**: Ensure the AI agent has permission to execute the MCP server
- **Troubleshooting**: If the MCP server doesn't connect, check:
  - Node.js is installed and accessible
  - The file paths are correct
  - The API definitions directory exists and contains valid JSON files
  - Check the agent's logs for connection errors

### Verifying MCP Connection

After setting up the MCP server with any AI agent, you can verify the connection by:

1. Asking the AI agent to list available tools
2. Requesting to list all APIs using the `list_apis` tool
3. Checking if the agent can access API definitions and schemas

If successful, the AI agent should be able to query API definitions, search endpoints, and retrieve schema information using the MCP tools.

## Usage

### Running the Server

Start the MCP server:```bash
npm start

The server runs on stdio and can be connected to by any MCP-compatible client.

Available Tools

1. list_apis

List all available API definitions with their titles and versions.

Parameters: None

Example Response:```json
[
{
"name": "auth",
"title": "Authentication API",
"version": "v1",
"filename": "auth.swagger.json"
}
]


#### 2. `get_api_details`
Get detailed information about a specific API definition.

**Parameters:**
- `name` (required): API name (e.g., "auth", "projects", "users")

**Example:**```json
{
  "name": "auth"
}

3. list_tags

List all tags across all API definitions.

Parameters: None

Example Response:```json
["Auth", "Projects", "Users"]


#### 4. `search_by_tag`
Search for endpoints by tag name.

**Parameters:**
- `tag` (required): Tag name to search for

**Example:**```json
{
  "tag": "Auth"
}

5. search_by_path

Search for endpoints by path pattern (supports regex).

Parameters:
- pattern (required): Path pattern to search for (e.g., "/api/Auth", "/api/.*")

Example:```json
{
"pattern": "/api/Auth"
}


#### 6. `get_endpoint`
Get detailed information about a specific endpoint.

**Parameters:**
- `api` (required): API name (e.g., "auth", "projects")
- `path` (required): Endpoint path (e.g., "/api/Auth/login")
- `method` (required): HTTP method (GET, POST, PUT, DELETE, etc.)

**Example:**```json
{
  "api": "auth",
  "path": "/api/Auth/login",
  "method": "POST"
}

7. get_schema

Get detailed information about a specific schema.

Parameters:
- api (required): API name (e.g., "auth", "projects")
- schemaName (required): Schema name (e.g., "LoginCommand", "AuthResponseDto")

Example:```json
{
"api": "auth",
"schemaName": "LoginCommand"
}


#### 8. `list_schemas`
List all schemas in a specific API definition.

**Parameters:**
- `api` (required): API name (e.g., "auth", "projects")

**Example:**```json
{
  "api": "auth"
}

Configuration

The API definitions directory can be configured via environment variable:```bash
export API_DEFINITIONS_DIR="path/to/your/api-definitions"
npm start


Or set it inline:```bash
API_DEFINITIONS_DIR="path/to/your/api-definitions" npm start

If not set, it defaults to D:\My works\DauTuCong\Frontend\src\assets\api-definitions.

API Definitions Structure

The MCP server expects OpenAPI/Swagger JSON files in the configured directory. Each file should follow the OpenAPI 3.0 specification format.

Directory Structure Example```

api-definitions/
├── auth.swagger.json
├── projects.swagger.json
├── users.swagger.json
└── ...


### Sample API Definition File Structure

Each API definition file should contain the following structure:```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Authentication API",
    "version": "v1",
    "description": "API for authentication operations"
  },
  "tags": [
    {
      "name": "Auth",
      "description": "Authentication endpoints"
    }
  ],
  "paths": {
    "/api/Auth/login": {
      "post": {
        "tags": ["Auth"],
        "summary": "User login",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LoginCommand"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful login",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuthResponseDto"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "LoginCommand": {
        "type": "object",
        "properties": {
          "username": {
            "type": "string"
          },
          "password": {
            "type": "string"
          }
        },
        "required": ["username", "password"]
      },
      "AuthResponseDto": {
        "type": "object",
        "properties": {
          "token": {
            "type": "string"
          },
          "user": {
            "$ref": "#/components/schemas/UserDto"
          }
        }
      },
      "UserDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "username": {
            "type": "string"
          },
          "email": {
            "type": "string"
          }
        }
      }
    }
  }
}

Key Components

  1. Info Section: Contains API metadata (title, version, description)
  2. Tags: Categorize endpoints for better organization
  3. Paths: Define all API endpoints with their HTTP methods
  4. Components/Schemas: Define reusable data models and request/response structures

File Naming Convention

  • Use descriptive names: auth.swagger.json, projects.swagger.json
  • Keep names lowercase and use hyphens for multi-word names
  • The filename is used as the API identifier (without the .swagger.json extension)

Supported Features

The MCP server supports:
- Multiple HTTP methods (GET, POST, PUT, DELETE, PATCH, etc.)
- Path parameters (e.g., /api/users/{id})
- Query parameters
- Request bodies with schema references
- Response schemas
- Multiple response status codes
- Tag-based endpoint categorization

Example Workflows

Find all authentication endpoints

  1. Use list_tags to see available tags
  2. Use search_by_tag with tag "Auth" to find all authentication endpoints
  3. Use get_endpoint to get detailed information about specific endpoints

Explore a specific API

  1. Use list_apis to see all available APIs
  2. Use get_api_details to get an overview of a specific API
  3. Use list_schemas to see all data models in that API
  4. Use get_schema to get detailed information about specific schemas

Search for endpoints by path

  1. Use search_by_path with pattern "/api/Auth" to find all auth-related endpoints
  2. Use search_by_path with pattern "/api/.*" to find all endpoints
  3. Use get_endpoint to get detailed information about specific endpoints

Error Handling

The server returns error messages in the following cases:
- API definition not found
- Endpoint not found
- Schema not found
- Invalid file format
- File read errors

All errors are returned with an isError: true flag in the response.

License

MIT

常见问题

6 问
答案由本站依据条目字段整理,不引用上游原文
API Docs MCP 8f858544 怎么安装?

资料没有给出安装命令,请到官方仓库或文档按说明接入;这类条目多数是生态应用,或尚未发布可安装包。

API Docs MCP 8f858544 怎么在 Claude Desktop、Claude、Cursor 里配置?

它的传输方式未标注,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

API Docs MCP 8f858544 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

API Docs MCP 8f858544 需要 API Key 吗?

资料标注需要Token认证,使用前准备好对应凭据,并按最小权限配置。

API Docs MCP 8f858544 支持哪些客户端?

资料标注支持 Claude Desktop、Claude、Cursor、Windsurf、Cline;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

API Docs MCP 8f858544 能提供哪些能力?

资料显示约 8 个工具;能力标签包括 API文档、开发工具、JavaScript、Claude。具体工具清单以官方文档为准。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。