Yonaka15 MCP Server Runner

🚀 MCP 服务器运行器

MCP 服务器运行器是一个用于运行 Model Context Protocol (MCP) 服务器的 WebSocket 服务器实现。它能让 MCP 服务器通过 WebSocket 连接被访问，极大地促进了与网络客户端和 Web 应用程序的集成。

⚠️ 重要提示

该项目目前处于积极开发阶段，并且是 WIP（未完成）状态。功能和 API 可能会发生显著变化。

🚀 快速开始

先决条件

• Rust 1.70 或更高版本
• MCP 服务器实现可执行文件

配置

通过环境变量配置应用程序：

PROGRAM=        # MCP 服务器可执行文件的路径（必需）
ARGS=           # MCP 服务器的参数，以逗号分隔的列表
HOST=0.0.0.0    # 绑定到的主机地址（默认：0.0.0.0）
PORT=8080       # 监听的端口（默认：8080）

其他环境变量将传递给 MCP 服务器进程。

使用步骤

1. 设置环境变量：

export PROGRAM=npx
export ARGS=-y,@modelcontextprotocol/server-github
export PORT=8080
export GITHUB_PERSONAL_ACCESS_TOKEN=github_pat_***

2. 运行服务器：

cargo run

3. 连接到 WebSocket 服务器：

const ws = new WebSocket("ws://localhost:8080");

Docker 支持

提供 Dockerfile 和 docker-compose.yml 用于容器化部署：

docker-compose up --build

✨ 主要特性

• 具有单客户端支持的 WebSocket 服务器实现
• MCP 服务器实例的过程管理
• 客户端与服务器之间的双向消息传递
• 优雅关闭处理
• 全面错误记录
• 跨平台支持（Unix/Windows）

📚 详细文档

概述

MCP 服务器运行器充当 WebSocket 客户端与 MCP 服务器实现之间的桥梁。它具备以下功能：

• 启动 MCP 服务器进程
• 管理 WebSocket 连接
• 处理客户端和服务器之间的双向通信
• 支持优雅关闭和错误处理

开发状态

• 🚧 进行中：该软件正在积极开发
• ⚠️ API 稳定性：API 和功能可能会发生变化，恕不另行通知
• 🧪 测试：目前正在进行测试和改进
• 📝 文档：文档正在积极更新

架构

应用程序遵循模块化架构：

• main.rs：应用程序入口点和服务器设置
• process/：进程管理和 I/O 处理
• websocket/：WebSocket 连接管理
• state.rs：全局状态管理
• shutdown.rs：优雅关闭处理

错误处理

• 标准错误输出从 MCP 服务器记录但不转发给客户端
• WebSocket 连接错误会得到优雅处理
• 进程错误会详细记录

局限性

• 只支持一个客户端连接
• 不支持 WebSocket SSL/TLS（请使用反向代理进行安全连接）
• 没有内置的身份验证机制

贡献

1. 分叉仓库
2. 创建功能分支 (git checkout -b feature/amazing-feature)
3. 提交更改 (git commit -m 'Add amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 打开 Pull Request

📄 许可证

该项目遵循 MIT 许可证，详情请见 LICENSE 文件。

额外资源

• Model Context Protocol 规范
• WebSocket 协议 (RFC 6455)