mcp-github-server

GitHub MCP Server 是一个实现了模型上下文协议(MCP)的服务器,提供全面的GitHub集成功能,专为Cursor IDE设计。该服务器提供了强大的API,用于管理代码上下文和执行GitHub操作。

  • by MostafaSwaisy
  • 更新于
在 GitHub 查看 MostafaSwaisy/mcp-github-server

使用说明

基本能力

产品定位

GitHub MCP Server 是一个专为开发者设计的工具,用于在开发环境中集成GitHub功能,提供代码上下文管理和GitHub操作支持。

核心功能

  • MCP协议支持:完整的模型上下文协议实现。
  • GitHub集成:全面的GitHub API集成。
  • 批量操作:支持在单次提交中操作多个文件。
  • Docker支持:可在容器中运行。
  • 自动内容处理:内置内容编码/解码功能。
  • 错误处理:全面的错误处理和日志记录。
  • 健康监控:内置健康检查端点。

适用场景

  • 在IDE中管理代码上下文。
  • 执行批量GitHub操作。
  • 自动化GitHub仓库管理。
  • 开发环境中的GitHub集成。

工具列表

  • Docker:用于容器化部署。
  • npm:用于安装和运行服务器。
  • GitHub API:用于执行GitHub操作。

常见问题解答

  • 错误响应格式:包含错误描述和详细信息。
  • 健康检查:通过/health端点监控服务器状态。

使用教程

使用依赖

  1. 安装Node.js和npm。
  2. 安装Docker(可选)。

安装教程

  1. 使用Docker构建镜像:
    docker build -t mcp-server .
    
  2. 使用Docker Compose运行:
    docker-compose up -d
    
  3. 手动安装依赖:
    npm install
    
  4. 设置环境变量:
    GITHUB_TOKEN=your_github_token
    NODE_ENV=production
    PORT=3000
    
  5. 启动服务器:
    npm start
    

调试方式

  1. 检查服务器健康状态:
    curl http://localhost:3000/health
    
  2. 查看日志:
    docker logs <container_id>
    
  3. 测试API端点:
    curl -X POST http://localhost:3000/v1/init