ghcontext: Supercharge Your LLMs with Real-time GitHub Context

ghcontext：リアルタイムの GitHub コンテキストで LLM を強化

「でも、GitHub リポジトリは昨日更新されたのに……」— AI アシスタントの情報が古くなる心配はもうありません。

ghcontext（GitHub Context Provider）は、GitHub と大規模言語モデルの間をつなぎ、標準化された Model Context Protocol（MCP）を通じて、AI アシスタントがリポジトリ情報にリアルタイムでアクセスできるようにします。

🔥 ghcontext を使う理由

• 正確なリアルタイム情報： LLM のリポジトリに関する知識は古くなっていることがよくあります。ghcontext は最新の API ドキュメント、README の内容、コードベースの構造を提供します。プライベートリポジトリにも対応しています。
• より深い理解： LLM がプロジェクトのアーキテクチャ、設計原則、API の使用パターンを把握できるようにします。
• シームレスな連携： Claude、GPT など、MCP 対応のあらゆるモデルと互換性があります。
• 高い効率性： インテリジェントなキャッシュにより、情報の鮮度を保ちながら API 呼び出しを削減します。

✨ 主な機能

• API ドキュメントの抽出： README や専用のドキュメントファイルから API ドキュメントを自動的に特定して抽出します。
• リポジトリ構造の分析： コードベースの構成をマップとして提供します。
• README コンテンツの取得： GitHub から最新のドキュメントを直接取得します。
• ファイルコンテンツの検索： 特定のファイルやコードスニペットを検索して抽出します。
• リポジトリ検索： 特定の条件に一致するリポジトリを見つけます。

🚀 クイックスタート

トークンについて

ghcontext の認証には GitHub トークンが必要です。トークンはご自身の責任で安全に管理し、ユースケースに本当に必要なスコープのみを付与してください。 たとえば、公開リポジトリの読み取りのみが必要な場合は、public_repo スコープを指定してトークンを作成できます。ghcontext はリポジトリへの書き込みアクセスを必要としません。

インストール

方法 1：npx を使ってインストールせずに実行

# Run directly without installation (GitHub token is REQUIRED)
npx ghcontext --GITHUB_TOKEN your_github_token

# OR using pnpm
pnpm dlx ghcontext --GITHUB_TOKEN your_github_token

インストールが不要で、コマンドラインから直接実行できるため、Claude エージェントに渡す方法として推奨されています。

方法 2：npm からグローバルインストール

# Install globally using npm
npm install -g ghcontext

# OR using pnpm
pnpm add -g ghcontext

# Run ghcontext with your GitHub token (REQUIRED)
ghcontext --GITHUB_TOKEN your_github_token

方法 3：手動インストール（開発用）

# Clone the repository
git clone https://github.com/yourusername/ghcontext.git
cd ghcontext

# Install dependencies
pnpm install

# Start the server with GitHub token (REQUIRED)
pnpm start --GITHUB_TOKEN your_github_token

LLM での使用方法

MCP 対応の LLM を ghcontext サーバーのエンドポイントに接続します。

http://localhost:3000/api/mcp

これで、LLM は次のようなツールを利用できるようになります。

• get-repository-info：リポジトリの詳細情報を取得します。
• get-repository-readme：現在の README の内容を取得します。
• get-repository-api-docs：API ドキュメントを抽出します。
• search-repository-files：リポジトリ内のファイルを検索します。
• get-file-content：特定のファイルの内容を取得します。

🔍 使用例

MCP 対応の AI アシスタントに次のように尋ねます。

「axios ライブラリには、リクエストインターセプターを処理するためにどのようなメソッドがありますか？」

古い情報や一般的な情報ではなく、アシスタントは次のことができます。

1. get-repository-api-docs を使って、最新の axios API ドキュメントを取得する
2. 現在のドキュメントを分析し、インターセプターのメソッドを確認する
3. 正確で最新の情報を提供する

🧰 アーキテクチャ

ghcontext はモジュール式の設計を採用しています。

┌─────────────────┐       ┌──────────────┐       ┌────────────────┐
│   MCP Server    │◄─────►│  GitHub API  │◄─────►│  GitHub.com    │
│  (TypeScript)   │       │    Client    │       │                │
└────────┬────────┘       └──────────────┘       └────────────────┘
         │
         │
┌────────▼────────┐       ┌──────────────┐
│ Context         │       │   Caching    │
│ Processors      │◄─────►│   System     │
└─────────────────┘       └──────────────┘

• MCP サーバー： Model Context Protocol の通信を処理します。
• GitHub API クライアント： GitHub REST API および GraphQL API とのやり取りを管理します。
• コンテキストプロセッサ： 関連情報を抽出して整理します。
• キャッシュシステム： パフォーマンスを向上させ、API の負荷を軽減します。

🧠 重要な理由

従来の AI アシスタントには、次のような課題があります。

• リポジトリに関する知識が古い
• プロジェクト構成への理解が不十分
• 最近の変更や更新を把握できない

ghcontext は、GitHub の最新情報に LLM が直接アクセスできるようにすることで、これらの課題を解決します。これにより、AI アシスタントの正確性と有用性が高まり、進化し続けるコードベースにより適切に対応できるようになります。

🛠️ 開発

# Build the project
pnpm run build

# Run tests
pnpm test

# Lint your code
pnpm run lint

# Format your code
pnpm run format

📦 npm への公開

このパッケージのメンテナーで、新しいバージョンを公開する必要がある場合は、次の手順に従ってください。

1. package.json のバージョンを更新します。

   # For patch releases (bug fixes)
   npm version patch
   
   # For minor releases (new features, no breaking changes)
   npm version minor
   
   # For major releases (breaking changes)
   npm version major
   

2. npm に公開します。

   # The prepublishOnly script will run linting, tests, and build automatically
   npm publish
   

3. タグを GitHub にプッシュします。

   git push --follow-tags
   

📝 ライセンス

このプロジェクトは MIT ライセンスの下で公開されています。詳細は LICENSE ファイルをご覧ください。

---

ghcontext：AI アシスタントにも、あなたと同じくらいコードを理解してもらいましょう。