🚀 GitHub MCP 服务器

本项目是一个用于 GitHub 仓库的模型上下文协议 (MCP) 服务器，借助 Python SDK 构建而成。它能让 AI 助手访问仓库上下文，如文件、提交历史、问题和拉取请求等，为开发者提供了便利。

🚀 快速开始

此服务器实现了 模型上下文协议 (MCP)，专门用于 GitHub 仓库，可使 AI 助手访问仓库的各类上下文信息。它基于 MCP Python SDK 构建，并设计为可部署在 Heroku 上。

✨ 主要特性

• 🔍 可访问 GitHub 仓库文件和内容
• 📜 能够检索提交历史
• 🐞 支持访问问题和拉取请求
• 🔒 具备安全身份验证和访问控制功能
• ⚙️ 对 GitHub API 进行速率限制和缓存处理
• 🤝 与 MCP 支持的 AI 助手兼容

📦 安装指南

1. 克隆仓库：

   git clone https://github.com/FixingPixels/mcp-server.git
   cd mcp-server
   

2. 创建虚拟环境：

   python -m venv venv
   source venv/bin/activate  # 在 Windows 上：venv\Scripts\activate
   

3. 安装依赖项：

   pip install -r requirements.txt
   

4. 设置环境变量：

   cp .env.example .env
   # 使用你的 GitHub API 令牌和其他设置编辑 .env 文件
   

💻 使用示例

基础用法

在本地进行开发时，可使用以下命令启动服务器：

uvicorn src.mcp_server.main:app --reload

高级用法

此服务器设计为部署在 Heroku 上。若要进行部署，请参阅 部署文档 了解详细信息。

📚 详细文档

• API 文档
• 配置指南
• 部署指南
• 故障排除

🤝 贡献

欢迎大家为项目贡献力量！请随意提交 Pull Request。

📄 许可证

此项目遵循 MIT 许可证 - 详情请查看 LICENSE 文件。