MCP Http Proxy

🚀 MCP代理使用文档

本MCP代理脚本为用户提供了一个统一的接口，用于与MCP（矿工控制协议）进行交互。它通过HTTP提供多种端点，支持使用GET和POST请求发送命令，并能实时接收响应，极大地简化了与MCP服务的交互流程。

✨ 主要特性

1. 启动子进程：代理启动后，会自动开启一个子进程来运行MCP服务。
2. 多端点支持：提供多个HTTP端点，可处理不同类型的请求。
3. 参数验证：对所有用户输入进行严格的安全检查，有效防止潜在的攻击。
4. 错误处理：遇到问题时，能够优雅地处理并返回友好的错误信息。

📦 安装指南

启动代理

# 在终端中运行代理脚本
node mcp-proxy.js

💻 使用示例

基础用法

发送命令

方式一：使用POST /rpc/raw/command（适合程序化调用）

将完整的JSON - RPC请求放在请求体中发送。 示例curl请求 (Linux/macOS):

curl -X POST -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","method":"tools/list","id":1}' \
  http://localhost:3005/rpc/raw/command

示例curl请求 (Windows命令提示符):

curl -X POST -H "Content-Type: application/json" -d "{\"jsonrpc\":\"2.0\",\"method\":\"tools/list\",\"id\":1}" http://localhost:3005/rpc/raw/command

PowerShell示例：

$rpcBody = @{
    jsonrpc = "2.0"
    method = "tools/call"
    id = 2
    params = @{
        name = "your_tool_name"
        arguments = @{
            param1 = "value1"
            count = 10
        }
    }
} | ConvertTo-Json -Depth 5

Invoke-RestMethod -Uri http://localhost:3005/rpc/raw/command -Method Post -ContentType 'application/json' -Body $rpcBody

高级用法

方式二：使用GET /tool/:toolName（适合简单的GET请求）

通过URL的查询参数传递参数。 示例curl请求：

# 假设有一个名为'worker_get'的工具，接受'name'参数
curl "http://localhost:3005/tool/worker_get?name=my-worker"

实时事件推送

SSE流

通过GET /sse端点可以建立Server - Sent Events流，实时接收服务器推送的消息。 示例curl请求：

curl http://localhost:3005/sse

调试界面

访问http://localhost:3005/debug可以看到更全面的调试信息，包括：

• 当前活动的SSE连接数量
• 最近的代理日志
• 请求历史记录
• 原始消息交换记录

📚 详细文档

错误处理

代理在遇到错误时会尽量优雅地处理并提供友好的反馈：

1. HTTP错误：返回标准的HTTP状态码（例如404表示未知工具或端点，400表示无效参数）。
2. 参数验证：/tool/:toolName端点会对查询参数进行严格的模式匹配检查，任何格式错误都会被拦截并返回详细的错误信息。
3. MCP错误：如果底层MCP进程返回错误（例如工具执行失败），代理会捕获这些错误信息并通过HTTP响应返回给客户端，并在SSE流中推送事件通知。

停止代理

要停止代理，可以按下Ctrl + C或发送SIGINT信号。代理会在退出前执行以下清理操作：

1. 终止子进程：调用MCPWorker.mcpProcess.kill()结束正在运行的MCP服务。
2. 关闭连接：断开所有活动的SSE客户端连接，确保资源被正确释放。

附加功能

MCP管理端点（可选）

如果启用了mcp - manager.js，代理还会提供一些额外的管理端点：

• /mcp/install：安装新的MCP实例
• /mcp/start：启动指定的MCP服务
• /mcp/stop：停止运行中的MCP服务
• /mcp/list：列出所有可用的MCP实例 这些功能允许用户动态地管理多个MCP服务，提高了系统的灵活性和可扩展性。

安全注意事项

1. 输入验证：代理对所有用户输入都进行了严格的验证，防止注入攻击。
2. 访问控制：默认情况下，所有端点都是公开的。建议在生产环境中配置基本认证或使用更高级的身份验证机制来保护敏感功能。
3. 日志记录：建议启用详细的日志记录功能，以便于审计和故障排除。

日志和监控

代理提供了内置的日志系统，支持记录所有的请求、响应以及内部状态变化。通过分析日志，可以有效监控系统的运行状况，及时发现潜在问题。

总结

该MCP代理提供了一个强大而灵活的接口，简化了与MCP服务的交互。无论是简单的命令执行还是复杂的任务调度，代理都能很好地满足需求。通过合理配置和使用其提供的各种功能，用户可以高效地管理和控制自己的矿工资源。