Github MCP Server 020

🚀 GitHub MCP APIドキュメント

このドキュメントは、GitHub MCP APIの使用方法を説明します。APIを通じて、リポジトリ操作、コードスキャン、検索、リソース取得などの機能を利用できます。

🚀 クイックスタート

このAPIを使用することで、GitHub上のリポジトリ操作やコードスキャン、検索などの機能を簡単に行うことができます。以下に各機能の詳細を説明します。

✨ 主な機能

• リポジトリ操作（プルリクエストの取得、作成、更新、削除）
• コードスキャン（アラートの取得、一覧表示）
• 検索（コード、リポジトリの検索）
• リソース取得（リポジトリ内容、コミット情報の取得）

📦 インストール

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)
}

📚 ドキュメント

リポジトリ操作

プルリクエスト（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ライセンス

Copyright (c) 2023 GitHub MCPチーム
このソフトウェアはMITライセンスの下で公開されています。

許諾条件:

1. 個人および商用利用が許可されます。
2. 修正および配布が許可されますが、著作権表示とライセンスの通知を保持する必要があります。