Code Explainer

🚀 代碼解釋器 MCP

代碼解釋器 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"]}'
  

📄 許可證

本項目遵循 Apache License 2.0 協議，具體內容詳見LICENSE文件。

⚠️ 重要提示

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