Github Enterprise MCP

🚀 GitHub 企業版 MCP 服務器文檔

GitHub 企業版 MCP（管理控制檯協議）服務器是一款強大的工具，它能夠與 GitHub 企業版實例進行交互。藉助 Cursor 的 AI 聊天功能，用戶可以直接使用 GitHub 企業版的各類功能，涵蓋倉庫管理、代碼審查、問題跟蹤等多個方面，極大地提升了操作的便捷性和效率。

🚀 快速開始

安裝與配置

若要安裝並配置 GitHub 企業版 MCP 服務器，請依照以下步驟操作：

1. 下載服務器
   • 從 GitHub 倉庫 下載服務器的最新版本。
2. 環境變量配置
   • 設置必要的環境變量：

export GHE_HOST=your-enterprise-host.com
export GHE_PORT=443
export GITHUB_TOKEN=your PAT token

3. 啟動服務器
   • 使用以下命令啟動服務器：

npm start --prefix path/to/mcp-server

✨ 主要特性

環境變量和命令行參數

• 環境變量：
  • GHE_HOST：GitHub 企業版實例的主機名。
  • GHE_PORT：GitHub 企業版實例使用的端口，默認值為 443。
  • GITHUB_TOKEN：用於身份驗證的個人訪問令牌（PAT）。
• 命令行參數：
  • --host：可自定義服務器綁定地址，例如 --host 0.0.0.0。
  • --port：可自定義服務器端口，例如 --port 3000。
  • --config：指定配置文件路徑，例如 --config ./config.json。

企業級功能

GitHub 企業版 MCP 服務器支持以下企業級功能：

• 代碼審查
• 依賴管理
• 安全掃描
• 存儲庫策略

💻 使用示例

基礎用法

在 Cursor 中使用工具

以下是在 Cursor 的 AI 聊天中使用 GitHub 企業版工具的示例：

// 列出倉庫
mcp_github_enterprise_列出倉庫(owner="octocat")

// 獲取倉庫信息
mcp_github_enterprise_獲取倉庫(owner="octocat", repo="hello-world")

// 列出拉取請求
mcp_github_enterprise_列出拉取請求(owner="octocat", repo="hello-world", state="open")

// 管理問題
// 列出問題
mcp_github_enterprise_列出問題(owner="octocat", repo="hello-world", state="all")
// 獲取問題詳情
mcp_github_enterprise_獲取問題(owner="octocat", repo="hello-world", issue_number=1)
// 獲取問題/拉取請求評論
mcp_github_enterprise_列出問題評論(owner="octocat", repo="hello-world", issue_number=1)

// 創建新問題
mcp_github_enterprise_創建問題(
  owner="octocat",
  repo="hello-world",
  title="發現了一個錯誤",
  body="這裡是對錯誤的描述",
  labels=["bug", "important"]
)

// 操作倉庫內容
mcp_github_enterprise_獲取內容(owner="octocat", repo="hello-world", 路徑="README.md")

// 管理倉庫設置
// 創建新倉庫
mcp_github_enterprise_創建倉庫(
  name="new-project",
  description="這是一個新項目",
  private=true,
  auto_init=true
)
// 更新倉庫設置
mcp_github_enterprise_更新倉庫(
  owner="octocat",
  repo="hello-world",
  description="更新後的描述",
  has_issues=true
)

高級用法

示例：設置倉庫策略

// 設置倉庫策略
mcp_github_enterprise_設置倉庫策略(
  owner="octocat",
  repo="hello-world",
  required_linear_history=true,
  required_signatures=true
)

📚 詳細文檔

注意事項

1. 權限要求
   • 所有企業級功能都需要有效的個人訪問令牌（PAT）。
   • 部分功能需要站點管理員權限。
2. 錯誤處理
   • 如果出現任何錯誤，請檢查日誌文件並確保令牌權限正確。
3. 性能優化
   • 建議在高負載情況下使用反向代理和負載均衡器。

貢獻指南

1. 問題報告
   • 若發現問題，請提交到 GitHub 倉庫 的問題部分。
2. 代碼貢獻
   • Fork 倉庫並在您的分支上進行修改，然後創建 Pull Request。
3. 反饋
   • 歡迎通過郵件或 GitHub 貢獻您的意見和建議。

📄 許可證

GitHub 企業版 MCP 服務器遵循 MIT 許可證，允許個人和商業用途。