🚀 GitHub 工具的 MCP 服务器
本项目是一个模型上下文协议（MCP）服务器实现，为开发者提供了与 GitHub 交互的实用工具。服务器基于 TypeScript 和 MCP SDK 构建，可与 GitHub Copilot 等 MCP 客户端在 Visual Studio Code 中无缝集成，极大提升开发效率。
🚀 快速开始
先决条件
- Node.js
- npm（Node.js 包含）
- 已安装并身份验证的 GitHub CLI (gh)
认证
此 MCP 服务器使用 GitHub CLI 为当前认证用户获取令牌，并用于身份验证目的。
在本地运行
启动服务器
npm start
对于开发，自动在文件更改时重建：
npm run dev
用于调试和检查服务器：
npm run inspect
VS Code 集成
运行最新发布的版本
要使用最新发布的版本，可以选择添加新的工具，选择 Command (stdio) 并使用命令 npx @rickardhf/github-security-mcp-server。
如果你只想更改项目的 mcp.json 配置文件，可以使用以下配置：
{
"servers": {
"my-local-mcp-server": {
"type": "stdio",
"command": "npx",
"args": [
"@rickardhf/github-security-mcp-server"
]
}
},
...
}
运行本地版本
要使用你项目中的本地版本，可以运行项目的构建文件。你可以将以下配置添加到 mcp.json 文件中，要么全局，要么针对特定工作区。
{
"servers": {
"my-local-mcp-server": {
"type": "stdio",
"command": "node",
"args": [
"c:\\repos\\private\\mcptest\\dist\\index.js"
]
}
}
}
如果运行本地版本，可以使用以下命令：
npm run build && npm start
✨ 主要特性
当前服务器提供的工具包括：
- GitHub 用户信息：通过用户名获取 GitHub 用户的详细信息
- 安全问题创建：在 GitHub 仓库中创建带有适当格式和标签的安全问题
- 列出安全问题：列出 GitHub 仓库中的所有安全相关问题
- 安全状态报告：获取全面的安全警报，包括 Dependabot、代码扫描和机密扫描
- 分支管理：列出和新建 GitHub 仓库的分支
- 拉取请求管理：
- 在两个分支之间创建拉取请求
- 列出特定仓库的所有拉取请求，包含编号、标题和描述等基本信息
- 获取特定拉取请求的详细信息，包括差异和评论
🔧 技术细节
项目结构
- src/index.ts：主入口点和服务器配置
- src/common/：共享的工具和类型定义
- utils.ts：共享实用函数（GitHub令牌检索）
- types.ts：TypeScript 类型定义
- src/operations/：工具实现
- process.ts：工具注册和映射
- security.ts：安全状态报告功能
- api/：GitHub API 操作
- branch.ts：分支管理操作
- issues.ts：安全问题操作
- pull-requests.ts：拉取请求操作
- repo.ts：仓库操作