Github Security MCP Server

🚀 GitHub 工具的 MCP 服務器

本項目構建了一個模型上下文協議（MCP）服務器，藉助該服務器提供的工具，可與 GitHub 進行交互。服務器基於 TypeScript 和 MCP SDK 開發，能與 Visual Studio Code 中的 GitHub Copilot 等 MCP 客戶端實現集成。

🚀 快速開始

先決條件

• 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：倉庫操作