Code Explainer MCP

🚀 代碼解釋器 MCP 工作原理說明

代碼解釋器 MCP 是一個 Cloudflare Worker，作為代碼解釋的模型上下文協議（MCP）服務器。它能通過分析和解釋代碼，提供全面的結構和功能分解，幫助開發者更好地理解代碼。

✨ 主要特性

• 架構圖表生成：創建 ASCII 圖表展示整體結構、組件間關係及數據流。
• 核心功能分析：通過模式識別確定代碼的主要目的並進行解釋。
• 組件分解：列出所有主要類和函數，並簡要說明其作用。
• 多語言支持：支持多種編程語言，包括 JavaScript、TypeScript、Python、Java、C# 等。
• 文檔註釋識別：提取並利用代碼中的現有文檔註釋（如 JSDoc 或 Docstring）。
• 安全 API：使用 Bearer 令牌進行身份驗證，確保端點安全。

🚀 快速開始

安裝與配置

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

🔧 技術細節

工作原理

代碼解釋器通過以下步驟分析源代碼：

1. 模式識別：識別代碼中的常見結構和設計模式。
2. 架構分解：解析代碼的層次結構，確定主要組件及其相互作用。
3. 功能說明：詳細描述每個函數、類和模塊的作用及交互。
4. 文檔生成：自動生成易懂的技術文檔，便於理解和維護。

開發指南

• 遵循 TypeScript 最佳實踐
• 在複雜邏輯處添加註釋
• 更新公共 API 的變更記錄
• 為新功能增加測試用例

安全注意事項

⚠️ 重要提示

• 使用 Bearer 令牌進行身份驗證。
• 生產環境使用環境變量存儲共享密鑰。
• 不要將實際密鑰提交到版本控制系統。
• 建議在生產環境中實施速率限制。

📄 許可證

本項目遵循 Apache License 2.0 協議，詳情請參閱LICENSE文件。