MCP Rest

🚀 MCP REST API 文档

这是一个围绕模型上下文协议（Model Context Protocol，MCP）客户端构建的REST API封装器，它能让你在不必保持恒连接的情况下与MCP进行交互。不过需要注意的是，本项目仅供测试使用，请勿用于实际场景。

🚀 快速开始

本项目提供了便捷的安装和使用方式，帮助你快速开启与MCP的交互。

📦 安装指南

你可以选择全局安装或者使用 npx 运行：

# 全局安装
npm install -g mcp-rest

# 或使用npx运行
npx mcp-rest

💻 使用示例

基础用法

使用以下命令运行，并可根据需求添加选项：

npx mcp-rest [选项]

选项说明

高级用法

SSE 模式

# 连接到默认的SSE服务器地址
npx mcp-rest

# 连接到自定义的SSE服务器地址和端口
npx mcp-rest --type sse --url http://localhost:9000/sse --port 4000

📚 详细文档

API 终端点

示例 API 使用方法

# 获取连接状态
curl http://localhost:3000/status

# 列出所有可用工具
curl http://localhost:3000/tools

# 调用一个工具
curl -X POST http://localhost:3000/tools/exampleTool \
  -H "Content-Type: application/json" \
  -d '{"arguments": {"param1": "value1"}}'

🔧 技术细节

如果遇到连接问题，你可以按照以下步骤进行故障排除：

1. 使用 --debug 标志查看详细日志
2. 检查 /status 终端点以验证连接状态
3. 确保你的 MCP 服务器/进程正在运行且可访问

📄 许可证

本项目采用 MIT 许可证。