Github MCP Server

🚀 GitHub MCP 服務器

GitHub MCP 服務器是一個集成了 GitHub 功能的模型上下文協議（MCP）服務器。它藉助 MCP 工具與 GitHub 倉庫進行交互，支持倉庫管理、文件操作和提交處理等一系列功能。

🚀 快速開始

本服務器提供了豐富的功能，可幫助您高效地管理 GitHub 倉庫。您可以通過以下步驟開始使用。

✨ 主要特性

• 賬戶管理和身份驗證
• 倉庫創建和管理
• 文件操作（讀取、寫入、推送、拉取）
• 提交操作
• 目錄同步
• 倉庫比較和差異分析

📦 安裝指南

使用以下命令安裝服務器：

npm install @modelcontextprotocol/server-github

📚 詳細文檔

配置

將服務器添加到您的 MCP 設置文件（cline_mcp_settings.json）中：

{
  "mcpServers": {
    "github": {
      "command": "node",
      "args": ["/path/to/github-mcp-server/dist/index.js"],
      "env": {
        "GITHUB_TOKEN_1": "your-github-token",
        "GITHUB_OWNER_1": "your-github-username"
      },
      "disabled": false,
      "alwaysAllow": []
    }
  }
}

可用工具

賬戶管理

• list_accounts：列出服務器中配置的 GitHub 賬戶。
• select_account：選擇用於後續操作的 GitHub 賬戶。

倉庫管理

• create_repository：創建新的 GitHub 倉庫。

{
  owner?: string;        // 倉庫所有者（可選，若已選賬戶）
  name: string;          // 倉庫名稱
  description: string;   // 倉庫描述
  private?: boolean;     // 是否為私有倉庫
}

• clone_repository：將 GitHub 倉庫克隆到本地目錄。

{
  owner?: string;    // 倉庫所有者
  repo: string;      // 倉庫名稱
  branch?: string;   // 分支名稱（默認：main）
  outputDir: string; // 克隆到的本地目錄
}

• rename_repository：重命名現有 GitHub 倉庫。

{
  owner?: string;    // 倉庫所有者
  repo: string;      // 當前倉庫名稱
  new_name: string;  // 新倉庫名稱
}

文件操作

• push_file：將文件推送到 GitHub 倉庫。

{
  owner?: string;     // 倉庫所有者
  repo: string;       // 倉庫名稱
  path: string;       // 倉庫中的目標路徑
  message: string;    // 提交信息
  sourcePath: string; // 待推送的本地文件路徑
}

• pull_file：從 GitHub 倉庫拉取文件。

{
  owner?: string;     // 倉庫所有者
  repo: string;       // 倉庫名稱
  path: string;       // 倉庫中的文件路徑
  outputDir: string;  // 拉取到的本地目錄
}

• delete_file：從 GitHub 倉庫刪除文件。

{
  owner?: string;     // 倉庫所有者
  repo: string;       // 倉庫名稱
  path: string;       // 倉庫中的文件路徑
}

提交操作

• create_commit：向 GitHub 倉庫創建提交。

{
  owner?: string;         // 倉庫所有者
  repo: string;           // 倉庫名稱
  branch: string;         // 分支名稱
  changes: {              // 待提交的更改列表
    path: string;        // 文件路徑
    content: string;      // 文件內容
    mode?: string;       // 文件模式（可選）
  }[]
}

開發

依賴項安裝

使用以下命令安裝開發依賴項：

npm install

構建

構建項目以生成發行版本：

npm run build

環境變量

• GITHUB_TOKEN_<N>：用於身份驗證的 GitHub 個人訪問令牌。
• GITHUB_OWNER_<N>：GitHub 用戶名或組織名稱。

📄 許可證

本項目採用 MIT 許可證。