Code Explainer

🚀 コードエクスプレイナー MCP

このプロジェクトは、Cloudflare Workerを利用したコード解釈のMCP（モデルコンテキストプロトコル）サーバーです。コードを分析し、その構造と機能を詳細に説明します。

✨ 主な機能

• アーキテクチャ図生成：ASCII形式のチャートを生成し、コード全体の構造、コンポーネント間の関係、データフローを可視化します。
• 核心機能分析：パターン認識を通じて、コードの主な目的を特定し、その説明を提供します。
• コンポーネント分解：主要なクラスと関数をリストアップし、その役割を簡潔に説明します。
• 多言語対応：JavaScript、TypeScript、Python、Java、C#など、様々なプログラミング言語のコードを分析できます。
• ドキュメントコメント認識：コード内のJSDocやドキュメント文字列などを抽出し、有効活用します。
• セキュアAPI：Bearerトークンを使用した認証方式で、エンドポイントのセキュリティを確保します。

🔧 技術詳細

コードエクスプレイナーは、以下の手順でソースコードを分析します。

1. パターン認識：コード構造と一般的なパターンを識別します。
2. 関係分析：コンポーネント間の依存関係をマッピングします。
3. ドキュメント抽出：既存のコメントドキュメントを優先的に使用します。
4. アーキテクチャ可視化：コード構造のASCIIチャートを作成します。
5. コンポーネント説明：主要なクラスと関数を分解し、その説明を提供します。

📦 インストール

前提条件

• Node.jsとnpmがインストールされていることを確認してください。
• Cloudflare CLIツールをインストールします：npm install -g wrangler

設定手順

1. リポジトリをクローンします：

   git clone https://github.com/BillDuke13/code-explainer-mcp.git
   cd code-explainer-mcp
   

2. 依存関係をインストールします：

   npm install
   

💻 使用例

リクエスト形式

コードを分析するために、以下の構造のPOSTリクエストを送信します。

{
  "method": "explainCode",
  "params": ["分析対象のコード", "プログラミング言語"]
}

認証ヘッダー

HTTPヘッダーに以下の情報を追加します。

• Content-Type: application/json
• Authorization: Bearer YOUR_SECRET_KEY_HERE

🚀 クイックスタート

ローカル開発

• 開発サーバーを起動します：

  wrangler dev
  

• エンドポイントをテストします：

  curl -X POST http://localhost:8787 \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer YOUR_SECRET_KEY_HERE" \
    -d '{"method":"explainCode","params":["function hello() { return \"Hello World\"; }","javascript"]}'
  

⚠️ 重要提示

• Bearerトークンを使用した認証を行ってください。
• 本番環境では、環境変数を使用して共有キーを保存してください。
• 実際のキーをバージョン管理システムにコミットしないでください。
• 本番環境では、レート制限を有効にすることをおすすめします。

📄 ライセンス

本プロジェクトは、Apache License 2.0に基づいてライセンスされています。詳細はLICENSEファイルを参照してください。