Code Explainer MCP

🚀 コードインタープリターMCPの仕組み説明

これはCloudflare Workerで、コード解釈のためのモデルコンテキストプロトコル（MCP）サーバーです。コードを分析・解釈し、包括的な構造と機能の分解を提供します。

✨ 主な機能

• アーキテクチャチャート生成：ASCIIチャートを作成して、全体構造、コンポーネント間の関係、データフローを表示します。
• 核心機能分析：パターン認識により、コードの主な目的を特定して解釈します。
• コンポーネント分解：すべての主要なクラスと関数をリストアップし、その役割を簡単に説明します。
• 多言語対応：JavaScript、TypeScript、Python、Java、C#など、複数のプログラミング言語をサポートします。
• ドキュメントコメント認識：コード内の既存のドキュメントコメント（JSDocやDocstringなど）を抽出して利用します。
• セキュアAPI：Bearerトークンを使用して認証を行い、エンドポイントのセキュリティを確保します。

🔧 技術詳細

コードインタープリターは以下の手順でソースコードを分析します。

1. パターン認識：コード内の一般的な構造と設計パターンを識別します。
2. アーキテクチャ分解：コードの階層構造を解析し、主要なコンポーネントとその相互作用を特定します。
3. 機能説明：各関数、クラス、モジュールの役割と相互作用を詳細に説明します。
4. ドキュメント生成：理解しやすい技術ドキュメントを自動生成し、理解と保守を容易にします。

📦 インストール

1. リポジトリをクローンし、依存関係をインストールします。

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

2. 開発サーバーを起動します。

   wrangler dev
   

3. ローカルエンドポイントをテストします。

   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"]}'
   

💻 使用例

APIインターフェース

• リクエストメソッド：POST
• ヘッダー情報：
  • Content-Type: application/json
  • Authorization: Bearer YOUR_SECRET_KEY_HERE
• リクエストボディ形式：

  {
    "method": "explainCode",
    "params": [
      "<コード内容>",
      "<プログラミング言語>"
    ]
  }
  

レスポンス例

{
  "result": {
    "architecture": {
      "components": ["主要コンポーネント1", "主要コンポーネント2"],
      "relations": {"コンポーネントA": ["依存コンポーネントB", "呼び出しコンポーネントC"]}
    },
    "functions": [
      {
        "name": "関数名",
        "purpose": "関数の役割の説明",
        "parameters": ["パラメータ1", "パラメータ2"],
        "returnType": "戻り値の型"
      }
    ],
    "documentation": "自動生成されたドキュメント内容..."
  },
  "status": "success"
}

📚 ドキュメント

• TypeScriptのベストプラクティスに従ってください。
• 複雑なロジックの部分にはコメントを追加してください。
• 公開APIの変更履歴を更新してください。
• 新機能にはテストケースを追加してください。

⚠️ セキュリティに関する注意事項

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

📄 ライセンス

このプロジェクトはApache License 2.0に従っています。詳細はLICENSEファイルを参照してください。