项目介绍
<div align="center">
</div>
<div align="center">
███╗ ███╗ ██████╗██████╗ ██╗ ██╗██╗ ██╗
████╗ ████║██╔════╝██╔══██╗██║ ██║╚██╗ ██╔╝
██╔████╔██║██║ ██████╔╝███████║ ╚████╔╝
██║╚██╔╝██║██║ ██╔═══╝ ██╔══██║ ╚██╔╝
██║ ╚═╝ ██║╚██████╗██║ ██║ ██║ ██║
╚═╝ ╚═╝ ╚═════╝╚═╝ ╚═╝ ╚═╝ ╚═╝
🚀 将任何API转变为对话式AI的强大工具
无需更改代码即可将您的REST API转换为智能的、基于聊天的MCP服务器
🚀 准备尝试吗？ npm install -g mcphy • 🎯 快速开始 • 📖 API 文档 • 🎨 示例 • ⭐ 点赞
</div>
要求
- Node.js >= 18.0.0
- npm >= 9.0.0
- 一个API规范文件（Swagger/OpenAPI或Postman集合）
- OpenAI API密钥（可选，用于增强AI驱动的理解）
安装
# 选项1：全局安装
npm install -g mcphy
# 选项2：不安装试用
npx mcphy --help
快速开始
# 1. 使用您的API规范初始化
mcphy init
# 2. 启动对话式服务器
mcphy serve
# 3. 打开浏览器
open http://localhost:3000
就这样！ 开始用简单的英语与您的API进行对话。
🚨 初始化问题？
如果mcphy init失败，请尝试以下快速修复：
❌ 没有找到API规范？
# 显式指定您的API规范文件
mcphy init -f path/to/your/swagger.yaml
❌ 规范无效？
# 验证您的规范
mcphy validate path/to/your/api.yaml
❌ 文件未找到？
# 检查文件是否存在并使用绝对路径
mcphy init -f /full/path/to/api.yaml
📖 查看详细解决方案的全面故障排除指南
立即试用
想立即测试MCPhy？使用我们包含的示例：
# 克隆并使用示例API测试
git clone https://github.com/sehmim/mcphy.git
cd mcphy
npm install
npm run build
npm link
# 使用示例测试
cd examples
mcphy init -f sample-swagger.yaml
mcphy serve
然后打开http://localhost:3000并尝试：
- "显示所有宠物"
- "创建一个名为Max的新宠物"
- "获取ID为1的宠物"
它做了什么
- 🧠 自然语言处理 - 用简单的英语提问
- 🔌 实际API调用 - 实际向后端发出请求
- ⚠️ 智能引导 - 当信息缺失时提供帮助
- 💬 Web界面 - 带实时响应的漂亮聊天UI
- 📦 导出就绪 - 创建独立包
- 🤖 智能增强 - 可选的AI驱动的API理解 🆕
- LLM驱动 - GPT-4增强描述、参数和示例
- 基于模式的回退 - 即使没有AI也能实现智能增强
- OpenAPI/Swagger & Postman - 支持所有主要的API格式
示例
您: "为John Doe创建2025-01-15的机油更换预约"
MCPhy: ✅ 匹配POST /bookings
📤 正在进行API调用...
📋 响应: {"id": "booking-123", "status": "created"}
为什么开发者喜欢这个
- 零代码更改 - 适用于现有的API
- 自然语言 - 不需要记住端点名称
- 实际响应 - 实际调用您的后端
- 智能引导 - 当信息缺失时提供帮助
- 漂亮的UI - 专业的聊天界面
- 易于导出 - 创建独立包
命令
| 命令 | 描述 |
|---|---|
mcphy init | 使用API规范初始化项目 |
mcphy serve | 启动MCP服务器 |
mcphy validate <file> | 验证API规范 |
mcphy export | 创建独立包 |
支持的格式
- ✅ OpenAPI 3.0+
- ✅ Swagger 2.0
- ✅ Postman集合（带有LLM驱动的解析） 🆕
🚀 新功能：LLM驱动的API解析
MCPhy现在使用GPT-4来智能地理解和增强所有API规范！
OpenAPI/Swagger增强
- 📝 增强的描述 - 生成用户友好的API描述
- 🔍 更好的参数文档 - 为参数添加上下文和示例
- 💡 使用示例 - 提供端点的实际使用指导
- 🎯 智能摘要 - 创建清晰简洁的操作摘要
- 🔗 工作流发现 - 识别常见的API模式
Postman集合支持
- 🤖 深入理解 - 分析集合结构和意图
- 📦 自动转换 - 转换为与OpenAPI兼容的格式
- 🔍 智能检测 - 自动检测项目中的集合
- 📝 丰富的解析 - 提取参数、头部、主体模式
- 🌐 基础URL提取 - 从变量中查找API基础URL
使用方法：
# 适用于任何格式 - OpenAPI、Swagger 或 Postman
mcphy init -f api-spec.yaml
mcphy init -f swagger.json
mcphy init -f postman_collection.json
# 验证任何格式
mcphy validate your-api-file
💡 OpenAI API密钥的好处（可选）：
- 🤖 增强的理解 - 驱动智能API分析
- 📝 丰富的描述 - 生成详尽的文档
- 🔍 智能参数文档 - 添加上下文感知的解释
- 💡 使用示例 - 提供端点的实际指导
- 🚀 无需它也可运行 - 基础解析完全可用
文档
开发
git clone https://github.com/sehm
im/mcphy.git
cd mcphy
npm install
npm run build
npm link
许可证
MIT © 2025 MCPhy
贡献
- 分叉仓库
- 创建功能分支
- 进行更改
- 提交拉取请求
<div align="center">
由开发者为开发者制作 ❤️
</div>