README
🚀 GitHub 项目 V2 MCP 服务器
GitHub 项目 V2 MCP 服务器是一个基于模型上下文协议(MCP)的服务器,它提供了一系列管理 GitHub 项目 V2 的工具。用户可借助 Claude 以及其他 MCP 客户端来使用这些工具。此服务器借助 GitHub GraphQL API 与 GitHub 项目 V2 进行交互。
✨ 主要特性
- 🔍 列出和查看用户及其组织的 GitHub 项目 V2。
- 📋 获取项目字段及项目中的条目(问题、拉取请求、草稿问题)。
- ➕ 创建问题并将它们添加到项目中。
- 📝 直接在项目中创建草稿问题。
- ✏️ 更新项目条目的字段值。
- ❌ 从项目中删除条目。
🚀 快速开始
此服务器可以与任何 MCP 客户端一起使用,例如 Claude Desktop。将其添加到您的 MCP 客户端配置文件(例如 claude_desktop_config.json)中。
📦 安装指南
方案 1:使用已发布的包
以下是使用 uvx 命令运行器的示例配置:
{
"mcpServers": {
"github-projects": {
"command": "uvx",
"args": [
"mcp-github-projects"
],
"env": {
"GITHUB_TOKEN": "your_pat_here"
}
}
}
}
⚠️ 重要提示
请将
your_pat_here替换为您的实际 GitHub 个人访问令牌。
方案 2:从源代码运行
要直接从源代码运行该项目,请按照以下步骤操作:
环境搭建
- 克隆仓库:
git clone git@github.com:Arclio/github-projects-mcp.git
cd github-projects-mcp
- 创建并激活虚拟环境:
uv venv
source venv/bin/activate
- 安装依赖项:
uv pip install -e .
- 设置您的 GitHub 令牌为环境变量:
创建一个 GitHub 个人访问令牌,并授予必要的权限:
repo、project和read:org。 运行以下命令将令牌添加到.env文件中:
cp .env.example .env
然后在 .env 文件中添加以下内容:
export GITHUB_TOKEN=your_personal_access_token
从源代码使用
当从源代码使用时,请按如下方式配置您的 MCP 客户端:
{
"mcpServers": {
"github-projects": {
"command": "uv",
"args": [
"--directory",
"/path/to/github-projects-mcp",
"run",
"mcp-github-projects"
],
"env": {
"GITHUB_TOKEN": "your_pat_here"
}
}
}
}
⚠️ 重要提示
请将
/path/to/github-projects-mcp和your_pat_here替换为您的实际仓库路径和 GitHub 个人访问令牌。
💻 使用示例
基础用法
此服务器提供了一系列可用工具,以下是各工具的功能说明:
list_projects:列出用户或组织的 GitHub 项目 V2get_project_fields:获取 GitHub 项目 V2 中可用的字段get_project_items:获取项目中的条目(支持按状态或自定义单选字段过滤)create_issue:创建新的 GitHub 问题add_issue_to_project:将现有 GitHub 问题添加到项目中create_draftIssue:直接在项目中创建草稿问题update_field:更新项目条目的字段值remove_item:从项目中删除条目
📚 详细文档
⚠️ 重要提示
请确保您的 GitHub 账户具有必要的权限以执行上述操作,并且始终遵循 GitHub 的 API 使用政策。
微信扫一扫