Peterparker57 Github MCP Server

🚀 GitHub MCP 服務器

本項目是一個提供 GitHub 集成功能的 Model Context Protocol (MCP) 服務器。該服務器藉助 MCP 工具與 GitHub 倉庫進行交互，具備倉庫管理、文件操作和提交處理等實用功能，能有效提升開發者在 GitHub 上的操作效率。

🚀 快速開始

本服務器可通過 MCP 工具與 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;       // 文件在倉庫中的路徑
  outputPath: string; // 本地保存文件的路徑
}

• sync_directory：實現本地和遠程目錄之間的雙向同步。

{
  owner?: string;    // 倉庫所有者
  repo: string;      // 倉庫名稱
  path: string;      // 倉庫中的目標路徑
  outputDir: string; // 本地同步的目標目錄
}

提交操作

• create_commit：在倉庫中創建一個新的提交。

{
  owner?: string;       // 倉庫所有者
  repo: string;         // 倉庫名稱
  branch: string;       // 分支名稱
  message: string;      // 提交信息
  author_name: string;  // 提交作者的姓名
  author_email: string; // 提交作者的電子郵件
}

開發

使用以下命令進行開發：

npm run dev

環境變量

📄 許可證

[此處插入許可證信息]