BBQ Party GitHub App MCP 服务端

使用说明(简要)

  • 项目简介
    • 该仓库实现了一个 MCP 服务器,用于向 LLM 客户端提供对 GitHub 的上下文信息、工具调用能力以及相关操作的封装。服务器通过 STDIO 传输与客户端通信,接收 JSON-RPC 请求并返回 JSON-RPC 响应。
  • 主要功能点
    • 注册并暴露一组可以被调用的工具(如创建/获取 PR、Issue、评论、查询仓库信息等)。
    • 处理工具调用请求,执行对应的 GitHub API 操作(通过 Octokit 和 GraphQL)。
    • 提供工具列表查询(ListTools)和调用工具的响应格式,返回结构化文本/JSON。
    • 内置安全与会话相关的能力声明(通过 MCP Server 提供的能力结构)。
    • 支持 STDIO 传输(服务启动后通过标准输入输出与客户端沟通)。
  • 安装步骤
    1. 在具备 Node.js 环境的机器上获取代码:将本仓库克隆/下载到本地。
    2. 安装依赖(示例):
      • npm install
      • 或根据仓库的实际构建方式执行相应的构建步骤(如 Docker 构建)。
    3. 启动服务:
      • 直接在仓库内通过 Node 运行对应入口(如经过编译后的 JS 文件),或使用容器镜像启动。
      • 运行后服务器将监听 STDIO,供 MCP 客户端通过标准输入/输出连接。
  • 服务器配置(MCP 客户端使用的示例配置信息,客户端不需要写入此处内容) 以下为示例配置(以 JSON 形式呈现,供 MCP 客户端在连接服务器时使用的参数说明;请勿直接在代码中写入敏感信息): { "server_name": "github-app-mcp", "command": "docker", "args": [ "run", "-i", "--rm", "bbqparty/github-app-mcp" ], "env": { "GITHUB_APP_ID": "<你的 GitHub 应用 App ID>", "GITHUB_APP_INSTALLATION_ID": "<你的应用安装 ID>", "GITHUB_APP_PRIVATE_KEY": "<Base64 编码的私钥,或 PEM 文件内容,按实际部署要求提供>" }, "notes": "若使用本地直接运行入口,请将 command 替换为 node,并将 args 指向实际的入口脚本路径(如 dist/index.js 或 src/index.ts 的编译目标)。" }
  • 基本使用方法
    • MCP 客户端启动并连接到该服务器后,发送标准的 MCP 请求(包含 ListTools、CallTool 等)。服务器将返回相应的 Tool 列表、执行结果或错误信息。
    • 使用工具示例:列出可用工具、调用具体工具(如创建 PR、获取 PR、列出分支等),处理返回的文本/JSON 结果。

服务器信息