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。