Pygithub MCP Server

🚀 PyGithub 使用説明

PyGithubは、GitHub APIをPythonで操作するためのライブラリです。このドキュメントでは、PyGithubのインストール、使用方法、開発ガイド、トラブルシューティングについて説明します。

🚀 クイックスタート

このセクションでは、PyGithubをすぐに使い始めるための基本的な手順を説明します。

📦 インストール

PyGithubをインストールするには、以下のコマンドを使用してください。

uv add pygithub-mcp-server
uv install

依存関係

• Python 3.10+ バージョン
• MCP Python SDK
• Pydantic
• PyGithub
• UV パッケージマネージャー

💻 使用例

基本的な使用法

PyGithubを使用するには、以下の手順に従ってください。

仮想環境のアクティブ化

source .venv/bin/activate

サーバーの起動

uv run pygithub-mcp-server

高度な使用法

ツールグループの設定

デフォルトでは、issues ツールグループのみが有効になっています。ツールグループを設定するには、以下の2つの方法があります。

設定ファイルを使用する方法

設定ファイルを作成して指定します。

export PYGITHUB_MCP_CONFIG=/path/to/pygithub_mcp_config.json

設定ファイルの例は以下の通りです。

{
  "tool_groups": {
    "issues": true,
    "repositories": true,
    "pull_requests": false,
    "discussions": false,
    "search": true
  }
}

環境変数を使用する方法

ツールグループの状態を直接設定します。

export PYGITHUB_ENABLE_ISSUES=true
export PYGITHUB_ENABLE_REPOSITORIES=true
export PYGITHUB_ENABLE_PULL_REQUESTS=false

設定ファイルのパス

デフォルトの設定ファイルは pygithub_mcp_server/settings.py にあります。カスタマイズする場合は、README.config.md を参照してください。

🔧 技術詳細

テスト方法

このプロジェクトには包括的なテストスイートが含まれています。

# すべてのテストを実行
pytest

# カバレッジレポートを生成
pytest --cov

# 特定のテストファイルを実行
pytest tests/test_operations/test_issues.py

# パターンに基づいてテストを実行
pytest -k "test_create_issue"

⚠️ 重要提示

現在、多くのテストが失敗しており、積極的に修正中です。

MCP インスペクターを使用した開発テスト

開発中は、MCP インスペクターを使用してツールをテストできます。

source .venv/bin/activate  # 仮想環境がアクティブ化されていることを確認
npx @modelcontextprotocol/inspector -e GITHUB_PERSONAL_ACCESS_TOKEN=your-token-here uv run pygithub-mcp-server

MCP インスペクターのWeb UIを使用すると、以下のことができます。

• 利用可能なツールをテストする
• 実際のGitHubリポジトリとやり取りする
• 成功とエラーのケースを検証する
• ペイロードを文書化する

プロジェクト構造

tests/
├── unit/                # 外部依存関係のない高速テスト
│   ├── config/          # 設定テスト
│   ├── tools/           # ツール登録テスト
│   └── ...              # その他の単体テスト
└── integration/         # 実際のGitHub APIを使用するテスト
    ├── issues/          # イシューツールのテスト
    └── ...              # その他の統合テスト

src/
└── pygithub_mcp_server/
    ├── __init__.py
    ├── __main__.py
    ├── server.py        # ファクトリパターン（create_server）
    ├── version.py
    ├── config/          # 設定システム
    │   ├── __init__.py
    │   └── settings.py  # 設定管理
    ├── tools/           # モジュール化されたツールシステム
    │   ├── __init__.py  # ツール登録フレームワーク
    │   └── issues/      # イシューツール
    │       ├── __init__.py
    │       └── tools.py # イシューツールの実装
    ├── client/          # GitHubクライアント
    │   ├── __init__.py
    │   └── client.py    # 主要なクライアントロジック
    ├── core/            # コア機能モジュール
    │   ├── __init__.py
    │   └── logic.py     # コアビジネスロジック
    └── utils/          # ツールと補助関数
       ├── __init__.py
       └── helper.py      # 補助関数の集合

トラブルシューティングとサポート

一般的な問題と解決策

• 依存関係が見つからない：uv install を実行して、すべての必要なパッケージをインストールしてください。
• 設定ファイルのエラー：PYGITHUB_MCP_CONFIG 環境変数が正しく設定されていることを確認するか、デフォルトの設定ファイルが存在することを確認してください。

さらなる支援が必要な場合は、サポートチームにお問い合わせいただくか、プロジェクトのドキュメントを参照してください。