
Code Explainer MCP

2025.03.04
3
TypeScript代码分析代码解释开发工具开发效率
Code Explainer MCP 是一个基于 Cloudflare Worker 的 MCP(Model Context Protocol)服务器,专门用于代码解释和分析。它能够通过多种技术手段对代码进行全面的结构解析和功能说明,支持多种编程语言,并提供架构图、核心功能分析、组件分解等功能。
View on GitHub
Overview
基本能力
产品定位
Code Explainer MCP 是一个代码解释和分析工具,旨在帮助开发者理解代码的结构和功能,适用于代码审查、教学和学习场景。
核心功能
- 架构图生成:生成 ASCII 图表,展示代码的整体结构、组件关系和数据流。
- 核心功能分析:通过模式识别,解释代码的主要用途。
- 组件分解:列出所有主要类和函数,并简要描述其作用。
- 多语言支持:支持 JavaScript、TypeScript、Python、Java、C# 等多种编程语言。
- JSDoc/Docstring 识别:提取并利用代码中的现有文档。
- 安全 API:通过 Bearer token 认证保护 API 端点。
适用场景
- 代码审查和优化
- 教学和学习编程
- 代码文档生成
- 新项目代码库的快速理解
工具列表
- Wrangler:Cloudflare Workers CLI,用于部署和管理 Worker。
- Node.js:运行环境和依赖管理。
- npm:包管理工具,用于安装依赖。
常见问题解答
- 如何保护 API 安全? 使用 Bearer token 认证,并通过环境变量存储密钥。
- 支持哪些编程语言? 支持 JavaScript、TypeScript、Python、Java、C# 等。
- 如何本地测试? 使用
wrangler dev
启动本地开发服务器。
使用教程
使用依赖
- 安装 Node.js(版本 12 或更高):
bash # 在 Linux/macOS 上使用 nvm 安装 nvm install 12
- 安装 Wrangler:
bash npm install -g wrangler
安装教程
- 克隆仓库:
bash git clone https://github.com/BillDuke13/code-explainer-mcp.git cd code-explainer-mcp
- 安装依赖:
bash npm install
- 配置密钥:
- 编辑
wrangler.jsonc
文件,替换YOUR_SECRET_KEY_HERE
。 - 或使用 Cloudflare 密钥:
bash wrangler secret put SHARED_SECRET
- 部署到 Cloudflare Workers:
bash npm run deploy
调试方式
- 启动本地开发服务器:
bash wrangler dev
- 测试 API 端点:
bash 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"]}'