代码解释器 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

开发指南

1. 本地开发
   • 启动开发服务器：

     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文件。