使用说明
OpenAPI MCP服务器
允许LLM检查OpenAPI规范并与之交互的MCP服务器。
特性
- 从URL或文件加载OpenAPI规范(OpenAPI 2.0&3.x)
- 列出和搜索端点
- 获取请求/响应模式(完全取消引用)
- 根据模式验证有效载荷
- 生成示例请求有效载荷
- 从模式生成TypeScript类型
- 提取身份验证方案
安装
通过npm(推荐)
npm install -g @blackkspydo/openapi-mcp
或者直接使用npx运行:
npx --yes @blackkspydo/openapi-mcp
来源
git clone https://github.com/blackkspydo/openapi-mcp.git
cd openapi-mcp
bun install
bun run build
用法
使用Claude CLI
claude mcp add openapi-mcp -- npx --yes @blackkspydo/openapi-mcp
使用克劳德桌面
增添 ~/Library/Application Support/Claude/claude_desktop_config.json:
{
"mcpServers": {
"openapi-mcp": {
"command": "npx",
"args": ["--yes", "@blackkspydo/openapi-mcp"]
}
}
}
或者,如果全局安装:
{
"mcpServers": {
"openapi-mcp": {
"command": "openapi-mcp"
}
}
}
独立
openapi-mcp
# or
npx --yes @blackkspydo/openapi-mcp
可用工具
| 工具 | 说明 |
|---|---|
load_spec |
从URL或文件加载OpenAPI规范 |
list_endpoints |
列出所有具有可选筛选的端点 |
search_endpoints |
按关键字搜索端点 |
get_endpoint_details |
获取端点的完整详细信息 |
get_request_schema |
获取请求正文架构 |
get_response_schema |
根据状态代码获取响应模式 |
validate_payload |
根据模式验证JSON |
generate_sample |
生成示例请求有效负载 |
generate_typescript_types |
从模式生成TypeScript接口 |
generate_curl |
生成即用型cURL命令 |
get_auth_schemes |
获取安全方案 |
get_servers |
获取可用的API服务器 |
示例
You: Load the Petstore API spec from https://petstore.swagger.io/v2/swagger.json
You: List all POST endpoints
You: Generate TypeScript types for the Pet schema
You: Generate a cURL command for POST /pet
You: Generate a sample request for POST /pet
许可证
麻省理工学院
