MCP Rest

🚀 MCP REST API 文档

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

🚀 快速开始

本项目可通过以下两种方式进行安装和使用：

安装

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

# 或使用npx运行
npx mcp-rest

使用方法

npx mcp-rest [选项]

选项

✨ 主要特性

• 无需恒连接即可与 MCP 交互。
• 提供丰富的命令行选项，可灵活配置连接信息。
• 支持多种 API 终端点，可进行连接状态检查、工具列表查看和工具调用等操作。

📦 安装指南

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

# 或使用npx运行
npx mcp-rest

💻 使用示例

基础用法

# 连接到默认的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 许可证。