article
README
🚀 主MCP服务器
主MCP服务器可将多个MCP服务器聚合到一个安全的端点之后。它提供基于配置的模块加载、统一的能力发现、具备弹性的请求路由,以及用于多后端认证的一流OAuth流程。
✨ 主要特性
- 通过工具/资源发现和命名空间聚合多个MCP服务器
- 支持OAuth:主令牌传递、委托提供者流程、代理刷新
- 通过JSON/YAML进行配置驱动的设置,具备模式验证和密钥解析功能
- 弹性路由:负载均衡、带退避/抖动的重试机制、断路器
- 跨平台:支持Node.js服务器和Cloudflare Workers运行时
- 支持生产级部署:可通过Docker、Cloudflare Workers、Koyeb进行部署
- 具备测试策略和支持持续集成(CI)的结构
🚀 快速开始(Node.js)
- 安装依赖(需要网络):
npm ci
- 配置环境(复制并编辑):
cp .env.example .env
- 以开发模式运行:
npm run dev
- 健康检查和指标:
GET /health→{ ok: true }GET /metrics→ 基本系统指标
- MCP端点(HTTP网关):
POST /mcp/tools/listPOST /mcp/tools/call并附带{ name, arguments }POST /mcp/resources/listPOST /mcp/resources/read并附带{ uri }
完整指南和端到端示例请参阅 docs/ 目录。
📚 详细文档
- 文档索引:
docs/index.md - 入门指南:
docs/getting-started/overview.md - 操作指南:
docs/guides/* - API参考:生成到
docs/api/reference/目录(见下文) - 配置参考:
docs/configuration/* - 部署指南:
docs/deployment/* - 故障排除:
docs/troubleshooting/* - 贡献指南:
docs/contributing/*
💻 使用示例 - 生成API文档
我们使用TypeDoc(Markdown)从TypeScript生成API文档。
基础用法
# 安装(需要网络)
npm i -D typedoc typedoc-plugin-markdown
高级用法
# 生成文档
npm run docs:api
输出到 docs/api/ 目录。
💻 使用示例 - 实际示例
实际示例位于 examples/ 目录:
- 基础Node示例:
examples/basic-node - Cloudflare Worker示例:
examples/cloudflare-worker - 高级路由示例:
examples/advanced-routing - OAuth委托示例:
examples/oauth-delegation - 测试模式示例:请参阅
/tests和docs/examples/testing.md
每个示例都有一个包含运行说明的README文件。
📦 安装指南 - 部署
- Docker:
deploy/docker/*以及顶级的Dockerfile/docker-compose.yml - Cloudflare Workers:
deploy/cloudflare/*并使用wrangler.toml - Koyeb:
deploy/koyeb/koyeb.yaml - CI/CD示例:请参阅
docs/deployment/cicd.md
🔧 技术细节
📄 许可证
请参阅 LICENSE。此仓库目前使用UNLICENSED许可证,仅供私有/内部使用。
贡献与支持
- 开发工作流程和指南请参阅
docs/contributing/* - 解决方案请参阅
docs/troubleshooting/index.md - 如有需要或想法,请开启一个issue或讨论。
微信扫一扫