使用说明
🚀 MCP REST API 服务器
🔧 修理工具或螺丝刀的象征 一个强大、类型安全且可配置的命令行界面(CLI)工具 该工具可将任何REST API转换为LLM代理的MCP(模型上下文协议)工具
🌟 这是什么?
这个(或:该) MCP REST API服务器 这是一个通用的桥梁,允许你进行封装 任何REST API 并且通过模型上下文协议将其作为可调用工具暴露给AI助手和大型语言模型代理。只需提供一个JSON配置文件,您的API即可立即被AI工具访问!
✨ 开始的最简单方法就是 npx -y mcp-rest-api - 无需安装!
🤖 基于人工智能的配置生成器
🚀 新功能:利用AI即时生成配置! 访问 api-mcp-generator.vercel.app 翻译为中文可以是:“Vercel 上的 API-MCP 生成器网站”。这里,“Vercel”是一个用于部署和托管静态网站及服务器端渲染应用的平台,“API-MCP 生成器”则指的是该网站提供的用于生成 API-MCP(可能是指某种特定类型的API或配置文件)的工具或服务 根据任何REST API文档自动生成JSON配置。只需粘贴您的API文档,让AI为您创建完美的MCP配置!
🎯 关键特性
- 🔄 翻译成中文可以是“🔄(循环/重复)”。不过,通常“🔄”这个符号本身在中文中没有直接的对应词汇,它更多地被用作一个图形符号来表示循环、重复或刷新等概念。在实际应用中,可以根据上下文将其翻译为相应的中文表达,如“循环”、“重复”、“刷新”等。 通用REST API封装器 与任何REST API配合使用
- 📝 JSON 配置驱动 - 无需编程,只需配置
- 🛡️ 翻译成中文是:盾牌 类型安全且经过验证 - 完全支持TypeScript,具备运行时验证功能
- 🔑 翻译成中文是:钥匙 智能参数绑定 - 支持
{args.param}并且{env.VAR}表达式 - 🚀 表情符号“🚀”通常被用来表示火箭、快速上升或加速等概念,在中文中没有直接对应的文字描述,但可以根据其含义进行意译,如“火箭发射”、“快速上升”或“加速前进”等。不过,直接使用该表情符号在中文语境中也是被广泛接受的,无需刻意翻译。 CLI Ready(CLI即命令行界面,Ready表示已准备好) - 全局安装或使用 npx 来运行
- 🔧(扳手,或表示修理、维护的意思) 开发者友好 - 热重载、代码检查和全面的工具支持
- 🌍 代表地球,常用于表示全球、世界等含义。 环境感知 - 无缝集成环境变量
- 📋(清单/待办事项列表) 灵活的日志记录 - 静默、控制台或基于文件的日志记录选项
- ✅ 稳健验证 - 全面的配置验证,附带有用的错误信息
📦 安装与使用
- 访问: api-mcp-generator.vercel.app(该网址可直接翻译为“API-MCP生成器.vercel.app”,但通常网址保持原样不翻译,这里仅为说明其含义)
- 输入描述你的REST API,通过在提示中粘贴URL/文档测试
- 生成AI分析文档并生成完美的JSON配置
- 复制并运行复制MCP配置,并在您偏好的AI工具(如Claude代码、Cursor、Windsurf等)中使用它
✨(这个符号在中文里通常没有直接对应的翻译,它常用于表示闪耀、光亮或特别的时刻,根据上下文可以灵活翻译为“闪闪发光”、“光芒四射”或保持原样作为表情符号使用) 非常适合任何已有文档的API——该AI能够理解各种API文档格式,并生成全面且可投入生产的配置。
🚀 使用 npx 快速入门(推荐)
# Run directly without installation (most convenient)
npx -y mcp-rest-api --config /path/to/your/config.json
# The -y flag skips confirmation prompts for faster execution
全局安装(备选方案)
npm install -g mcp-rest-api
mcp-rest-api --config /path/to/your/config.json
开发环境设置
git clone https://github.com/MCP-Generator/mcp-rest-api.git
cd mcp-rest-api
npm install
npm run build
命令行界面选项
# Required: Specify configuration file
npx -y mcp-rest-api --config /path/to/config.json
# Optional: Control logging output
npx -y mcp-rest-api --config config.json --log stdio # Log to console
npx -y mcp-rest-api --config config.json --log /path/file # Log to file
npx -y mcp-rest-api --config config.json --log none # No logging (default)
🚀 创建配置的两种方法
✍️ 方法2:手动配置
手动创建一个JSON配置文件以进行完全控制。请参阅 深入配置解析 以下部分提供了详细示例和参数绑定选项。
🏗️ 架构概述
该系统遵循简洁(或“干净”)的设计原则 三层架构:
┌─────────────────────────┐
│ 🎯 CLI/Config Layer │ ← Entry point & config loading (cli.ts)
├─────────────────────────┤
│ 🔧 MCP Server Layer │ ← Protocol implementation & tool registry (McpServer.ts)
├─────────────────────────┤
│ 📡 HTTP Client Layer │ ← REST API communication & parameter binding (RequestHandler.ts)
└─────────────────────────┘
🔧 深入配置详解
参数绑定魔法 ✨
该系统支持强大的表达式绑定:
{
"pathParams": {
"id": "{args.user_id}" // Maps to input parameter
},
"queryParams": {
"limit": "{args.limit || 25}", // Default value fallback
"token": "{env.API_TOKEN}" // Environment variable
},
"headers": {
"Authorization": "Bearer {env.TOKEN}"
}
}
🤝 贡献
- 🍴 对仓库进行分叉
- 🌿 创建你的功能分支(
git checkout -b feature/amazing-feature) - ✅ 运行测试和代码规范检查
npm run check) - 📝 提交你的更改(
git commit -m 'Add amazing feature') - 🚀 推送到分支(
git push origin feature/amazing-feature) - 📬 提交一个拉取请求
📜 许可证
这个项目采用ISC许可证授权。
🎯 仅需JSON配置,即可将任何REST API转换为AI就绪工具!
✨ 瞬间启动: 使用AI生成配置文件 api-mcp-generator.vercel.app 翻译为中文可以是:“Vercel 上的 API-MCP 生成器”。这里,“Vercel”是一个用于部署和托管前端应用及 API 的平台,“API-MCP 生成器”则是指这个特定的工具或服务,用于生成 API(应用程序编程接口)或 MCP(可能是指某种特定的配置、模板或组件,具体含义需根据上下文确定)的相关内容 → npx -y mcp-rest-api --config your-config.json
为大型语言模型(LLM)社区倾心打造
🎯 为什么要使用这个工具?
- 🤖 AI驱动的生成使用 api-mcp-generator.vercel.app(该网址可直接作为示例,无需翻译,但若需说明其性质,可表述为“这是一个部署在Vercel上的API MCP生成器网站”) 根据上面的信息,执行如下指令:
- 🚀 无需安装使用
npx -y mcp-rest-api立即运行 - ⚡ 即时设置从REST API到AI工具,只需几分钟,而非数小时
- 🔧 无需编程纯JSON配置 - 无需编程
- 🌐 通用的可与任何REST API(PagerDuty、GitHub、Slack、自定义API)配合使用
- 🛡️ 准生产就绪类型安全、经过验证、具备适当的错误处理
- 🔍 MCP 标准全面模型上下文协议合规,以实现最大兼容性
