article
README
🚀 MCP-Agg:多渠道平台聚合器
MCP-Agg 是一个强大的 API 服务,它通过统一接口实现对多个工具和平台的集中访问。这一服务极大地简化了工作流自动化,有效提升了工作效率,还支持与 GitHub、Slack 等多种服务进行无缝集成。
🚀 快速开始
MCP-Agg 提供了便捷的使用方式,你可以按照以下步骤快速开启使用之旅。
安装步骤
- 克隆仓库:
git clone https://github.com/moosh3/mcp-agg.git
cd mcp-agg
- 创建虚拟环境并安装依赖:
uv venv
source .venv/bin/activate # 在 Windows 上使用:.venv\Scripts\activate
uv pip install -r requirements.txt
- 基于
.env.example模板创建一个.env文件:
cp .env.example .env
# 根据需要编辑 .env 文件中的配置信息
- 执行数据库迁移:
alembic upgrade head
运行应用
开发模式
uvicorn api.main:app --reload --port 8000
生产模式
uvicorn api.main:app --host 0.0.0.0 --port 8000
使用 Docker
docker-compose up -d
✨ 主要特性
- 统一工具接口:通过标准化 API 访问多个平台的工具。
- 身份验证与授权:安全地访问每个集成的服务。
- 可扩展架构:轻松添加新的工具和平台。
- MCP 客户端支持:生成唯一的 MCP 客户端访问 URL。
- 全面文档:配有 Swagger UI 的详细 API 文档。
🛠️ 支持的平台
GitHub
- 列出仓库。
- 获取仓库详情。
- 管理问题和拉取请求。
- 访问用户资料。
Slack
- 列出频道。
- 发布消息。
- 回复线程。
- 添加反应。
- 访问频道历史记录。
- 获取用户资料。
📋 依赖项
- Python 3.12+
- PostgreSQL 数据库
- uv 包管理器
💻 使用示例
基础用法
MCP-Agg 的使用示例可以参考以下步骤,这里以启动应用为例:
# 开发模式
uvicorn api.main:app --reload --port 8000
# 生产模式
uvicorn api.main:app --host 0.0.0.0 --port 8000
# 使用 Docker
docker-compose up -d
📚 详细文档
启动应用后,你可以访问以下交互式 API 文档:
- Swagger UI:http://localhost:8000/docs
- ReDoc:http://localhost:8000/redoc
🔌 使用 MCP 客户端
通过 MCP 客户端访问所有工具:
- 注册并登录到 MCP-Agg 服务。
- 绑定各个支持平台的账户(GitHub、Slack 等)。
- 访问 MCP URL 生成功能端点。
- 将生成的 URL 配置到 MCP 客户端中。
🧪 测试
使用 pytest 运行测试:
python -m pytest
获取覆盖率信息:
python -m pytest --cov=api
🤝 贡献指南
欢迎贡献!请随意提交 Pull Request。
- 叉仓库。
- 创建功能分支(
git checkout -b feature/amazing-feature)。 - 提交更改(
git commit -m '添加一些很棒的功能')。 - 推送到分支(
git push origin feature/amazing-feature)。 - 提交 Pull Request。
📄 许可证
本项目采用 MIT License,具体内容请参考 LICENSE 文件。
📞 联系方式
若有任何问题,请联系开发者。
微信扫一扫