Github MCP Server 020

🚀 GitHub MCP API 文檔

本項目的 GitHub MCP API 提供了一系列操作 GitHub 倉庫的接口，涵蓋拉取請求管理、代碼掃描、搜索、資源獲取等功能，同時提供了 Go 語言庫方便開發者使用。

🚀 快速開始

若你想使用 GitHub MCP API 的 Go 語言庫，可按以下步驟操作：

安裝庫

go get github.com/yourusername/github-mcp-api/v1

示例代碼

獲取倉庫信息

package main

import (
    "fmt"
    "github.com/yourusername/github-mcp-api/v1"
)

func main() {
    client := github.NewClient(nil)
    repo, _, err := client.Repositories.Get("yourusername", "yourrepo")
    if err != nil {
        fmt.Printf("Error: %v", err)
        return
    }
    fmt.Printf("Repository name: %s", repo.Name)
}

✨ 主要特性

• 支持對 GitHub 倉庫的拉取請求進行創建、更新、刪除和獲取內容等操作。
• 提供代碼掃描警報的獲取和列表功能。
• 支持在 GitHub 上進行代碼和倉庫的搜索。
• 可獲取倉庫的文件、目錄和提交信息。
• 提供 Go 語言庫，方便開發者集成使用。

📦 安裝指南

若使用 Go 語言庫，可通過以下命令進行安裝：

go get github.com/yourusername/github-mcp-api/v1

💻 使用示例

基礎用法

以下是使用 Go 語言庫獲取倉庫信息的示例：

package main

import (
    "fmt"
    "github.com/yourusername/github-mcp-api/v1"
)

func main() {
    client := github.NewClient(nil)
    repo, _, err := client.Repositories.Get("yourusername", "yourrepo")
    if err != nil {
        fmt.Printf("Error: %v", err)
        return
    }
    fmt.Printf("Repository name: %s", repo.Name)
}

📚 詳細文檔

倉庫操作

拉取請求（Pull Requests）

獲取拉取請求內容

此操作可獲取拉取請求的內容。

• 模板: repos/{owner}/{repo}/pulls/{pull_number}
• 參數:
  • owner: 倉庫所有者 (字符串，必需)
  • repo: 倉庫名稱 (字符串，必需)
  • pull_number: 拉取請求編號 (整數，必需)

創建拉取請求

用於創建一個新的拉取請求。

• 模板: repos/{owner}/{repo}/pulls
• 參數:
  • owner: 倉庫所有者 (字符串，必需)
  • repo: 倉庫名稱 (字符串，必需)
  • title: 拉取請求標題 (字符串，必需)
  • head: 拉取請求的頭部分支 (字符串，必需)
  • base: 拉取請求的基礎分支 (字符串，必需)

更新拉取請求

可更新現有的拉取請求。

• 模板: repos/{owner}/{repo}/pulls/{pull_number}
• 參數:
  • owner: 倉庫所有者 (字符串，必需)
  • repo: 倉庫名稱 (字符串，必需)
  • pull_number: 拉取請求編號 (整數，必需)
  • title: 新的拉取請求標題 (字符串，可選)
  • head: 新的頭部分支 (字符串，可選)
  • base: 新的基礎分支 (字符串，可選)

刪除拉取請求

用於刪除一個拉取請求。

• 模板: repos/{owner}/{repo}/pulls/{pull_number}
• 參數:
  • owner: 倉庫所有者 (字符串，必需)
  • repo: 倉庫名稱 (字符串，必需)
  • pull_number: 拉取請求編號 (整數，必需)

代碼掃描

獲取代碼掃描警報

可獲取特定的代碼掃描警報。

• 模板: repos/{owner}/{repo}/code-scanning/alerts/{alert_number}
• 參數:
  • owner: 倉庫所有者 (字符串，必需)
  • repo: 倉庫名稱 (字符串，必需)
  • alert_number: 警報編號 (整數，必需)

列出代碼掃描警報

可列出倉庫中的所有代碼掃描警報。

• 模板: repos/{owner}/{repo}/code-scanning/alerts
• 參數:
  • owner: 倉庫所有者 (字符串，必需)
  • repo: 倉庫名稱 (字符串，必需)
  • ref: Git 引用 (字符串，可選)
  • state: 警報狀態 (字符串，可選)
  • severity: 警報嚴重性 (字符串，可選)

搜索

搜索代碼

可在 GitHub 上搜索代碼。

• 模板: /search/code
• 參數:
  • query: 搜索查詢 (字符串，必需)
  • sort: 排序字段 (字符串，可選)
  • order: 排序順序 (字符串，可選)

搜索倉庫

可在 GitHub 上搜索倉庫。

• 模板: /search/repos
• 參數:
  • query: 搜索查詢 (字符串，必需)
  • sort: 排序字段 (字符串，可選)
  • order: 排序順序 (字符串，可選)

資源

獲取倉庫內容

可獲取倉庫中的文件和目錄。

• 模板: repos/{owner}/{repo}/contents
• 參數:
  • owner: 倉庫所有者 (字符串，必需)
  • repo: 倉庫名稱 (字符串，必需)
  • path: 文件路徑 (字符串，可選)

獲取提交

可獲取特定的提交信息。

• 模板: repos/{owner}/{repo}/commits/{commit_hash}
• 參數:
  • owner: 倉庫所有者 (字符串，必需)
  • repo: 倉庫名稱 (字符串，必需)
  • commit_hash: 提交哈希值 (字符串，必需)

📄 許可證

MIT License

版權所有 (c) 2023 GitHub MCP 團隊
本軟件按照 MIT 許可證發佈。

許可條款：

1. 個人和商業用途均被允許。
2. 修改和分發被允許，但必須保留版權聲明和許可證 notice。