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 令牌进行身份验证。
• 生产环境中使用环境变量存储共享密钥。
• 避免将实际密钥提交到版本控制系统。
• 建议生产环境启用速率限制。