项目简介

'dev-kit-gh-mcp-server' 是一个基于 Model Context Protocol (MCP) 实现的 GitHub 服务器,旨在为大型语言模型(LLM)客户端提供标准化的接口,以执行 GitHub 仓库相关的各种操作。它允许 LLM 以工具调用的方式,方便地列出、创建和评论 GitHub 议题与拉取请求,以及获取仓库的提交历史和标签信息。

主要功能点

  • 议题管理: 列出、创建和评论 GitHub 仓库中的议题。
  • 拉取请求管理: 列出、创建、评论和查看拉取请求的评审。
  • 仓库信息查询: 获取仓库的提交历史、标签列表。
  • 自动化与AI集成: 专为自动化任务、机器人和 AI 代理设计,简化 GitHub 操作的集成。

安装步骤

通过 Python 包管理器 pip 进行安装:

pip install dev-kit-gh-mcp-server

服务器配置

MCP 客户端需要以下配置信息来连接并使用此 GitHub MCP 服务器。请确保您的环境中设置了 'GITHUB_TOKEN' 环境变量,以便服务器能够访问 GitHub API。

{
  "server_name": "GitHub MCP Server",
  "command": "python",
  "args": [
    "-m",
    "dev_kit_gh_mcp_server",
    "--root-dir",
    "DanielAvdar/pandas-pyarrow"
  ],
  "comment_args": {
     "--root-dir": "要操作的GitHub仓库路径,格式为 '所有者/仓库名',例如 'DanielAvdar/pandas-pyarrow'。如果此参数指向一个本地Git仓库路径,服务器会尝试从中提取远程GitHub URL;否则,它会直接将此参数解释为GitHub仓库的URL。",
     "GITHUB_TOKEN": "GitHub个人访问令牌,用于身份验证。建议作为环境变量设置,例如在启动服务器前执行 'export GITHUB_TOKEN='YOUR_TOKEN''。"
  }
}

基本使用方法

安装后,您可以通过命令行启动此 MCP 服务器,然后 LLM 客户端即可通过 JSON-RPC 协议与之通信,调用其提供的各种工具。

例如,要启动服务器并指定一个 GitHub 仓库:

# 确保已设置 GITHUB_TOKEN 环境变量
export GITHUB_TOKEN='YOUR_GITHUB_PERSONAL_ACCESS_TOKEN'
python -m dev_kit_gh_mcp_server --root-dir DanielAvdar/pandas-pyarrow

服务器启动后,您的 LLM 客户端可以通过标准输入/输出或其他支持的传输协议(如 WebSocket, SSE)与其交互,调用如 'ListIssuesOp'、'CreatePROp' 等工具,执行对应的 GitHub 操作。例如,LLM 客户端可能会发送一个 JSON-RPC 请求来列出指定仓库的议题。

信息

分类

开发者工具