Docker 化的 GitHub MCP 服务器

目录

• 简介
• 功能概述
• 安装与运行
• 支持的工具
• 注意事项
• 许可协议

简介

GitHub MCP 服务器是一个 Docker 化的解决方案，用于通过 GitHub 的 API 提供 Model Context Protocol (MCP) 支持。该服务器功能强大，支持多种操作，如文件管理、仓库创建、问题跟踪和代码搜索。

功能概述

主要功能

1. 文件操作：

   • create_or_update_file: 创建或更新单个文件。
   • push_files: 一次提交多个文件。
   • get_file_contents: 获取文件内容。

2. 仓库管理：

   • create_repository: 创建新仓库。
   • fork_repository: 复制仓库。

3. 问题跟踪：

   • create_issue: 创建新问题。
   • update_issue: 更新现有问题。
   • add_issue_comment: 添加问题评论。
   • search_issues: 搜索问题和拉取请求。

4. 代码搜索:

   • search_code: 在 GitHub 上搜索代码片段。

5. 协作开发：

   • create_pull_request: 创建新的拉取请求。
   • merge_pull_request: 合并拉取请求。
   • get_pull_request_files: 获取拉取请求中的文件变更列表。

安装与运行

安装依赖

1. 确保你已安装 Docker 和 Docker Compose。
2. 克隆本仓库：

   git clone https://github.com/modelcontextprotocol/servers.git
   cd servers/docker/github
   

构建镜像

docker build -t gh-mcp-server .

运行服务器

docker run -p 3000:3000 --name mcp-gh-server gh-mcp-server

支持的工具

GitHub MCP 服务器支持以下功能：

1. create_or_update_file - 在仓库中创建或更新单个文件。
2. push_files - 一次提交多个文件。
3. search_repositories - 搜索 GitHub 仓库。
4. create_repository - 创建新的 GitHub 仓库。
5. get_file_contents - 获取文件或目录内容。
6. create_issue - 创建新问题。
7. create_pull_request - 创建新的拉取请求。
8. fork_repository - 复制仓库。
9. create_branch - 创建新的分支。
10. list_commits - 获取分支的提交记录。
11. list_issues - 获取仓库中的问题列表。
12. update_issue - 更新现有问题。
13. add_issue_comment - 向问题添加评论。
14. search_code - 搜索代码片段。
15. search_issues - 搜索问题和拉取请求。
16. search_users - 搜索 GitHub 用户。
17. get_issue - 获取特定问题的详细信息。
18. get_pull_request - 获取特定拉取请求的详细信息。
19. merge_pull_request - 合并拉取请求。

注意事项

• 访问令牌：确保使用具有适当权限的个人访问令牌（PAT）。建议授予最小必要的权限。
• API 速率限制：注意 GitHub API 的速率限制，特别是在高负载情况下。
• 错误处理：在生产环境中实现适当的错误捕捉和重试逻辑。

许可协议

本项目遵循 MIT 许可证。请查看 LICENSE 文件以获取详细信息。