Octocode MCP

🚀 Octocode MCP

完璧なAIコードアシスタント - GitHub全体での高度な検索と発見

🚀 クイックスタート

1. 前提条件のインストール

macOS/Linux:

# Install Node.js 18.12+
brew install node

# Install GitHub CLI
brew install gh

Windows:

# Install using WinGet (recommended)
winget install Microsoft.PowerShell  # PowerShell 7+ for better security
winget install GitHub.cli
winget install OpenJS.NodeJS

# Or using Chocolatey
choco install powershell-core nodejs github-cli

# Or using Scoop
scoop install gh nodejs

2. 認証

# Login to GitHub (opens browser)
gh auth login

# Login to NPM (for package research)
npm login

3. Claude Desktopに追加

# For Claude Desktop users
claude mcp add octocode npx 'octocode-mcp@latest'

またはMCP設定に手動で追加

{
  "octocode-mcp": {
    "command": "npx",
    "args": ["octocode-mcp"]
  }
}

以上で完了です！ Octocodeは自動的に組織のプライベートリポジトリで動作します。

✨ 主な機能

この完璧なコードアシスタントは、何でも理解するのに役立ちます。AIアシスタントを、GitHubとnpmエコシステム全体の数百万のリポジトリとパッケージに即座にアクセスできる専門のコード研究者に変えます。

リポジトリを手動で閲覧する代わりに、以下のような質問をすることができます。

• "Reactはコンカレントレンダリングをどのように実装したのか？"
• "Next.jsアプリケーションの認証パターンを教えて"
• "この特定のAPIの使用例を見せて"
• "このライブラリのアーキテクチャはどうなっているのか？"
• "このMCPツールを効果的に使うにはどうすればいいのか？"

📦 インストール

1. 前提条件のインストール

macOS/Linux

# Node.js 18.12以上をインストール
brew install node

# GitHub CLIをインストール
brew install gh

Windows

# WinGetを使用してインストール（推奨）
winget install Microsoft.PowerShell  # セキュリティ向上のためPowerShell 7以上
winget install GitHub.cli
winget install OpenJS.NodeJS

# またはChocolateyを使用
choco install powershell-core nodejs github-cli

# またはScoopを使用
scoop install gh nodejs

2. 認証

# GitHubにログイン（ブラウザが開きます）
gh auth login

# NPMにログイン（パッケージ調査用）
npm login

3. Claude Desktopに追加

# Claude Desktopユーザー向け
claude mcp add octocode npx 'octocode-mcp@latest'

またはMCP設定に手動で追加

{
  "octocode-mcp": {
    "command": "npx",
    "args": ["octocode-mcp"]
  }
}

💻 使用例

基本的な使用法

以下のような質問をOctocodeに投げることができます。

# 質問例
"How did React implement concurrent rendering?"

高度な使用法

複数の条件を組み合わせた検索や、特定のリポジトリ内での検索などの高度な使い方も可能です。

# 高度な質問例
"Find examples of how to use this specific API in the 'reactjs' repository"

📚 ドキュメント

詳細情報

• 詳細については、octocode.aiを参照してください。
• 技術的な詳細については、Technical Summaryを参照してください。
• Dockerのセットアップについては、Docker Guideを参照してください。
• コミュニティに参加するには、Discordに参加してください。役立つ更新情報や議論を追えます。

対象ユーザー

開発者向け

複雑なマルチリポジトリアーキテクチャをナビゲートし、大規模な組織の問題を理解し、実際のコード例からオンデマンドでカスタムドキュメントを生成できます。IDE内で直接コンテキストドキュメントを作成するか、OctoCodeに任意のリポジトリを学習させ、現在のプロジェクトで同様のパターンを実装できます。

プロダクトとエンジニアリングマネージャー向け

セマンティックコード検索を通じてアプリケーションの動作を前例のないレベルで可視化し、チーム全体の開発進捗を追跡し、製品機能の背後にある実際の実装を理解できます。

セキュリティ研究者向け

高度なパターンマッチングとクロスコードベース分析を使用して、公開およびプライベートリポジトリ全体でセキュリティパターン、脆弱性、およびコンプライアンス問題を発見できます。

大規模組織向け

チームが既存のコードベースから即座に学習し、チーム横断的な実装を理解し、実績のあるパターンを複製できるようにすることで、開発速度を劇的に向上させます。組織の知識を実行可能な開発の加速に変えます。

主な利点

• ゼロコンフィギュレーション設定 - 既存のGitHub CLI認証で動作し、個人アクセストークンは必要ありません。
• エンタープライズ対応のセキュリティ - コンテンツサニタイズにより組織のパーミッションを尊重します。
• AIトークン最適化 - インテリジェントなコンテンツ処理によりAIコストを削減します。
• クロスプラットフォーム対応 - 自動パス検出機能を備えたネイティブWindows PowerShellサポート。
• 普遍的なアクセス - 公開、プライベート、および組織のリポジトリでシームレスに動作します。

できること

深いプロジェクト調査と分析

• 問題検索と分析：プロジェクトの課題、機能要求、およびバグパターンを理解します。
• コミット履歴調査：時間を追って機能の実装とバグ修正を追跡します。
• プルリクエストとコードレビュー分析：実際のコード差分にアクセスし、開発ワークフローを理解します。
• プロジェクト進捗追跡：開発速度とチームの協力パターンを監視します。

コアGitHub調査

• リポジトリ発見：トピック、言語、およびアクティビティでリポジトリを検索します。
• コード検索：数百万のリポジトリ全体で正確なパターンと実装を検索します。
• クロスリポジトリフロー理解：複数のリポジトリ間の関連する変更をつなげます。
• リポジトリアーキテクチャ：プロジェクト構造をナビゲートして理解します。

パッケージエコシステムツール

• NPMパッケージ発見：包括的なメタデータでNode.jsパッケージを分析します。
• Pythonパッケージ統合：クロスエコシステム比較でPyPIパッケージを探索します。
• パッケージ分析：バージョン、依存関係、およびリポジトリの接続を深く調査します。

高度な調査機能

• コードパターン発見：実装パターンとベストプラクティスを特定します。
• セキュリティとコンプライアンス調査：コードベース全体でセキュリティパターンを検索します。
• チーム協力分析：コードレビュープロセスとチームのダイナミクスを理解します。
• リアルタイムドキュメント：ライブコードから任意のトピックに対するカスタムドキュメントを生成します。

🔧 技術詳細

Dockerサポート

Octocode MCPをDockerコンテナで実行し、完全なGitHub CLI認証を維持できます。一貫した環境とデプロイに最適です。

DXT拡張機能

このプロジェクトは、Claude DesktopなどのAIアプリケーションに簡単にインストールできるデスクトップ拡張機能（DXT） として利用可能です。

DXTのクイックセットアップ

# 依存関係をインストール
yarn install

# DXTパッケージをビルド
yarn dxt:pack

生成されたoctocode-mcp.dxtファイルは、Claude Desktopに単にクリックするだけでインストールできます。

DXTスクリプト

• yarn dxt:validate - manifest.jsonファイルを検証します。
• yarn dxt:pack - 拡張機能をビルドしてパッケージ化します。
• yarn dxt:release - 完全なリリースパイプライン（ビルド → パッケージ化 → 署名 → 検証）

ベストプラクティス

自然な質問をする

• "このプロジェクトで認証はどのように機能しているか？"
• "このパターンを実装しているライブラリは何か？"
• "Xの問題を解決するNPMパッケージを見せて"
• "このアプローチは時間とともにどのように進化したか？"

AIに探索をガイドさせる

• 広いクエリから始める - システムがインテリジェントに絞り込みます。
• スマートなフォールバックを信頼する - 自動的に代替案で再試行します。
• 前の検索を基にする - 深い探索のためにコンテキストを維持します。
• どこでも動作する - 公開、プライベート、および組織のリポジトリで動作します。

トラブルシューティング

クロスプラットフォームコマンド

# GitHub CLIのステータスを確認
gh auth status

# 必要に応じて再認証
gh auth logout && gh auth login

# NPMアクセスを確認
npm whoami

Windows固有のコマンド

# PowerShellのバージョンを確認（7以上を推奨）
$PSVersionTable.PSVersion

# 実行可能ファイルの検出をテスト
where.exe gh
where.exe npm

一般的な解決策

• 結果が得られない場合 - より広い検索用語を試してみてください。
• プライベートリポジトリが見つからない場合 - gh auth statusで組織のメンバーシップを確認してください。
• Windowsで問題が発生する場合 - セキュリティ向上のためPowerShell 7以上をインストールしてください。
• パーミッションエラーが発生する場合 - 実行可能ファイルのパーミッションとPATH設定を確認してください。

セキュリティとプライバシー

ローカルファーストアーキテクチャ

• 🏠 100% ローカル - 完全にあなたのマシン上で実行されます。
• 🚫 ゼロデータ収集 - テレメトリやデータ送信は行われません。
• 🔑 安全な認証 - GitHub CLI OAuthを使用し、個人トークンは必要ありません。

エンタープライズセキュリティ

• 🛡️ コンテンツ保護 - 入力検証とコンテンツサニタイズ。
• 🔐 シークレット検出 - 機密データパターンの自動検出と編集。
• ⚪ 安全なコマンドのみ - 事前承認されたGitHub CLIおよびNPMコマンドのみを使用します。

背景

このプロジェクトは、Wixで勤務しているときの個人用ツールとして始まりました。大規模なコードベースをナビゲートし、急速に進化する技術環境に追いつくという課題から生まれました。サイドプロジェクトとして始まったものが、何でも理解するのに役立つ完璧なコードアシスタント に進化しました。

目標は、コードの探索を、シニア開発者があなたを任意のコードベースを通して案内するのと同じくらいインテリジェントにすること です。

📄 ライセンス

MITライセンス - 詳細はLICENSEを参照してください。