Openapi Client MCP

通用OpenAPI MCP

](https://badge.fury.io/js/openapi-client-mcp) ](https://www.npmjs.com/package/openapi-client-mcp) 

一个强大的模型上下文协议（MCP）服务器，提供通用的OpenAPI集成。 一个适用于任何OpenAPI规范的MCP安装 -不再为每个API生成单独的MCP！

🚀 主要特点

• 🌐 通用兼容性：适用于任何有效的OpenAPI 2.0/3.0/3.1规范
• 🔧 动态操作：无需预生成-实时解析和执行API
• 🔐 身份验证和会话持久性：安全处理身份验证和会话持久性
• 🌍 远程API：支持本地文件和远程OpenAPI URL
• 📖 丰富的文档：详细的操作说明和使用示例

📦 安装

npm install -g openapi-client-mcp

⚡ 快速使用

配置后，只需告诉你的AI助手你想做什么：

对话示例：

“我的API位于https://petstore.swagger.io/v2/swagger.jsonOR“./schema.yml”

• MCP将发现OpenAPI规范并调用相应的端点

“使用名称'John'和电子邮件'呼叫POST/users端点”john@example.com'"

• 自动查找端点并格式化请求

“列出我的Stripe API中的所有可用终结点”

• 发现并显示API规范中的所有操作

“使用API密钥'sk-123…'为我的API设置身份验证”

• 配置身份验证并记住它以备将来调用

自然语言→ API调用

用简单的英语描述你想要什么：

• ✅ “通过ID 123获取用户”
• ✅ “创建一个有名称和价格的新产品”
• ✅ “更新客户电子邮件地址”
• ✅ “删除订单456”

无需知道确切的端点名称或参数格式！

🔐 智能会话管理

MCP帮助您进行身份验证和 即使在重新启动后也会记住您的登录信息:

• 登录一次：“帮助我使用OAuth/API密钥登录到我的API”
• 持续会话：您的身份验证已安全存储
• 自动重新连接：会话在MCP重新启动时工作
• 多个API：同时管理不同API的会话

⚙️ 安装

添加到您的MCP客户端（例如，Claude Desktop、Cursor、VS Code）：

{
  "mcpServers": {
    "openapi-client-mcp": {
      "command": "openapi-client-mcp"
    }
  }
}

替代方案（无需安装）：

{
  "mcpServers": {
    "openapi-client-mcp": {
      "command": "npx",
      "args": ["openapi-client-mcp"]
    }
  }
}

🔍 支持的OpenAPI功能

• ✅ OpenAPI 2.0（Swagger）
• ✅ OpenAPI 3.0.x 版本
• ✅ OpenAPI 3.1.x 版本
• ✅ JSON和YAML格式
• ✅ 路径参数
• ✅ 查询参数
• ✅ 标头参数
• ✅ 请求机构
• ✅ 多种内容类型
• ✅ 响应模式
• ✅ 认证方案
• ✅ 标签和操作分组
• ✅ 服务器定义

🛡️ 安全功能

• 使用Zod模式进行输入验证
• 安全参数处理
• 无任意代码执行

🤝 贡献

1. 叉起 仓库
2. 创建要素分支
3. 进行更改
4. 提交拉取请求

🔗 链接

• 报告问题

📄 许可证

MIT许可证-有关详细信息，请参阅许可证文件。

🆘 故障排除

未找到MCP服务器：

• 确保全局安装： npm install -g openapi-client-mcp
• 改用npx：使用上面的npx配置
• 检查是否安装了Node.js>=18.0.0

未检测到OpenAPI文件：

• 文件必须具有 .yaml, .yml，或 .json 扩展
• 文件必须包含有效的OpenAPI规范

API调用失败：

• 检查OpenAPI规范中的基本URL
• 使用 manage_auth 身份验证工具
• 验证是否提供了所需的参数