███╗ ███╗ ██████╗██████╗ ██╗ ██╗██╗ ██╗
████╗ ████║██╔════╝██╔══██╗██║ ██║╚██╗ ██╔╝
██╔████╔██║██║ ██████╔╝███████║ ╚████╔╝
██║╚██╔╝██║██║ ██╔═══╝ ██╔══██║ ╚██╔╝
██║ ╚═╝ ██║╚██████╗██║ ██║ ██║ ██║
╚═╝ ╚═╝ ╚═════╝╚═╝ ╚═╝ ╚═╝ ╚═╝🚀 将任何API转化为对话式人工智能引擎
将您的REST API转换为智能、聊天驱动的MCP服务器,无需更改任何代码
](https://www.npmjs.com/package/mcphy)  ](https://nodejs.org)
______________________________________________________________________
需求
- Node.js >= 18.0.0
- npm >= 9.0.0
- API规范文件(Swagger/OpenAPI或Postman Collection)
- OpenAI API密钥 (可选,用于增强人工智能驱动的理解)
安装
# Option 1: Install globally
npm install -g mcphy
# Option 2: Try without installing
npx mcphy --help快速开始
# 1. Initialize with your API spec
mcphy init
# 2. Start the conversational server
mcphy serve
# 3. Open your browser
open http://localhost:3000就是这样! 开始用简单的英语与API聊天。
🚨 初始化问题?
如果 mcphy init 如果失败,以下是快速修复:
❌ 找不到API规范?
# Specify your API spec file explicitly
mcphy init -f path/to/your/swagger.yaml❌ 规范无效?
# Validate your spec first
mcphy validate path/to/your/api.yaml❌ 找不到文件?
# Check the file exists and use absolute path
mcphy init -f /full/path/to/api.yaml📖 看 完整故障排除指南 详细解决方案
立即尝试
想立即测试MCPhy吗?使用我们附带的示例:
# Clone and test with example API
git clone https://github.com/sehmim/mcphy.git
cd mcphy
npm install
npm run build
npm link
# Test with example
cd examples
mcphy init -f sample-swagger.yaml
mcphy serve然后打开 http://localhost:3000 并尝试:
- “显示所有宠物”
- “创建一个名为Max的新宠物”
- “获得ID为1的宠物”
它做什么
- 🧠 自然语言处理 -用简单的英语提问
- 🔌 真实的API调用 -实际上向后端发出请求
- ⚠️ 智能引导 -信息丢失时提供帮助
- 💬 web界面 -漂亮的聊天界面,实时响应
- 📦 出口就绪 -创建独立包
- 🤖 智能增强 -可选AI驱动API理解🆕
- LLM供电 -GPT-4增强了描述、参数和示例 - 基于模式的回退 -即使没有人工智能,也能实现智能增强 - OpenAPI/Swagger&邮差 -适用于所有主要的API格式
示例
You: "create booking for John Doe for oil change for 2025-01-15"
MCPhy: ✅ Matched POST /bookings
📤 Making API call...
📋 Response: {"id": "booking-123", "status": "created"}为什么开发者喜欢这个
- 零代码更改 -与现有API配合使用
- 自然语言 -无需记住端点名称
- 真实回应 -实际上调用您的后端
- 智能引导 -信息丢失时提供帮助
- 漂亮的UI -专业聊天界面
- 轻松导出 -创建独立包
命令
| 命令 | 描述 |
|---|---|
mcphy init | 使用API规范初始化项目 |
mcphy serve | 启动MCP服务器 |
mcphy validate | 验证API规范 |
mcphy export | 创建独立包 |
支持格式
- ✅ OpenAPI 3.0+
- ✅ Swagger 2.0
- ✅ 邮差收藏(具有LLM支持的解析) 🆕
🚀 新增:LLM-Powered API解析
MCPhy现在使用GPT-4智能地理解和增强 全部 API规范!
OpenAPI/Swagger增强
- 📝 增强的描述 -生成用户友好的API说明
- 🔍 更好的参数文档 -为参数添加上下文和示例
- 💡 使用示例 -提供实用的端点使用指南
- 🎯 智能摘要 -创建清晰简洁的操作摘要
- 🔗 工作流发现 -识别常见的API模式
邮差收藏支持
- 🤖 深入理解 -分析收集结构和意图
- 📦 自动转换 -转换为OpenAPI兼容格式
- 🔍 智能检测 -自动检测项目中的集合
- 📝 丰富的解析 -提取参数、标头、正文模式
- 🌐 基本URL提取 -从变量中查找API基URL
用途:
# Works with any format - OpenAPI, Swagger, or Postman
mcphy init -f api-spec.yaml
mcphy init -f swagger.json
mcphy init -f postman_collection.json
# Validate any format
mcphy validate your-api-file💡 OpenAI API的主要优势(可选):
- 🤖 增强理解 -支持API智能分析
- 📝 丰富的描述 -生成全面的文档
- 🔍 智能参数文档 -添加上下文感知解释
- 💡 使用示例 -为端点提供实用指导
- 🚀 没有它也能工作 -基本解析功能齐全
文档
发展
git clone https://github.com/sehmim/mcphy.git
cd mcphy
npm install
npm run build
npm link许可证
麻省 理工© 2025 年 MCPhy
贡献
- 复刻仓库
- 创建要素分支
- 进行更改
- 提交拉取请求
______________________________________________________________________
由...制作❤️ 由开发者,为开发者
• 问题 •
