返回 MCP 目录
public公开dns本地运行

github-mcp-server

一个用于GitHub的模型上下文协议(MCP)服务器,提供与GitHub的集成,允许LLM通过MCP与GitHub交互,支持搜索仓库、问题、提交、代码、用户、主题、标签等功能。

article

README

🚀 Github MCP 服务器

Github MCP 服务器是一个为 Github 提供的 Model Context Protocol 服务器。它通过 MCP 与 Github 集成,允许大语言模型(LLMs)与 Github 进行交互。

Github REST Api 文档

🚀 快速开始

本服务器允许大语言模型(LLMs)通过 MCP 与 Github 进行交互。下面将为你介绍如何安装、配置和运行该服务器。

📦 安装指南

1. 安装依赖项

pnpm install

2. 配置 Github 访问令牌

.env 中配置 Github 访问令牌:

GITHUB_PERSONAL_ACCESS_TOKEN=<your_personal_github_access_token>

3. 本地运行并进行热重载

pnpm dev

4. 构建服务器

pnpm build

5. 使用调试器进行本地调试

pnpm inspector

💻 使用示例

基础用法

以下是一些与 Github 交互的示例提示:

  1. "modelcontextprotocol" → 执行 search_repositories 工具以查找提及 modelcontextprotocol 的仓库。
  2. "什么是 modelcontextprotocol 服务器 repo 中的 739 号问题?" → 执行 get_issue 工具以查找 modelcontextprotocol 服务器 repo 中的 739 号问题。
  3. "什么是 modelcontextprotocol 服务器 repo 中的 717 号拉取请求?" → 执行 get_pull_request 工具以查找 modelcontextprotocol 服务器 repo 中的 717 号拉取请求。

📚 详细文档

开发步骤

1. 安装依赖项

pnpm install

2. 配置 Github 访问令牌

.env 中配置 Github 访问令牌:

GITHUB_PERSONAL_ACCESS_TOKEN=<your_personal_github_access_token>

3. 本地运行并进行热重载

pnpm dev

4. 构建服务器

pnpm build

5. 使用调试器进行本地调试

pnpm inspector
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端