🚀 MCP 服务器运行器
MCP 服务器运行器是一个 WebSocket 服务器实现，用于运行 模型上下文协议 (MCP) 服务器。借助它，MCP 服务器可通过 WebSocket 连接被访问，进而实现与网络客户端（如 Web 应用程序）的集成。不过要注意，此项目目前处于积极开发阶段，功能和 API 可能会有重大变化。
🚀 快速开始
先决条件
- Rust 1.70 或更高版本
- 一个 MCP 服务器实现可执行文件
配置
环境变量
该应用程序可通过环境变量进行配置：
PROGRAM= # MCP 服务器可执行文件的路径（必需，如果未指定配置文件）
ARGS= # 传递给 MCP 服务器的参数
HOST= # 监听的主机地址，默认为 0.0.0.0
PORT= # 监听的端口号，默认为 3000
配置文件
可以通过以下命令生成默认配置文件：
mcp-server-runner init-config > config.yml
使用说明
环境变量配置示例
export PROGRAM=/path/to/mcp-server
export ARGS=--some-argument
export HOST=127.0.0.1
export PORT=8080
启动服务器：
mcp-server-runner start
命令行配置示例
mcp-server-runner --program /path/to/mcp-server --args --some-argument --host 127.0.0.1 --port 8080 start
✨ 主要特性
- 单客户端支持的 WebSocket 服务器实现
- MCP 服务器实例的过程管理
- 客户端与服务器之间的双向消息传递
- 优雅的关闭处理
- 全面的错误日志记录
- Unix/Windows 平台通用支持
📚 详细文档
概述
MCP 服务器运行器充当 WebSocket 客户端与 MCP 服务器实现之间的桥梁。它具备以下功能：
- 启动一个 MCP 服务器进程
- 管理 WebSocket 连接
- 处理客户端和 MCP 服务器之间的双向通信
- 支持优雅的关闭处理和错误处理
开发状态
- 🚧 开发中：该软件正在积极开发
- ⚠️ API 稳定性：API 和功能可能会发生变化，恕不另行通知
- 🧪 测试：当前正在进行测试和优化
- 📝 文档：文档正在积极更新
架构
MCP 服务器运行器由以下几个主要模块组成：
main.rs：程序的入口点config/：配置相关的实现server/：WebSocket 服务器的核心逻辑logger/：日志记录和错误处理
错误处理
错误类型
ConfigurationError：配置相关错误ConnectionError：连接相关错误ProtocolError：协议相关错误
已知限制
- 当前版本仅支持单个客户端连接
- 不支持 WebSocket 协议的压缩和代理
- 未实现完整的 MCP 协议规范
贡献指南
如何贡献
- 克隆仓库
git clone git@github.com:your-repository.git
- 创建功能分支
git checkout -b feature/your-feature-name
- 提交更改
git commit -m '添加 awesome 功能'
- 推送到远程仓库
git push origin feature/your-feature-name
- 创建拉取请求 通过 GitHub Pull Request 提交您的更改。
📄 许可证
此项目根据 MIT 许可证发布，具体内容请参阅 LICENSE 文件。
🔗 额外资源
⚠️ 重要提示
此项目目前处于积极开发阶段，并且处于 WIP（未完成）状态。功能和 API 可能会发生重大变化。