Code Explainer MCP
一个 Cloudflare Worker,用于分析源代码,并提供全面的解释,包括架构图、核心功能分析以及跨多种编程语言的组件分解。
README
代码解释器 MCP
一个 Cloudflare Worker,用作代码解释的 MCP(模型上下文协议)服务器。它分析并解释代码,并提供结构和功能的全面分解。
特性
- 架构图: 生成一个 ASCII 图,显示整体结构、组件之间的关系和数据流。
- 核心功能分析: 基于模式识别,识别并解释代码的主要目的。
- 组件分解: 列出所有主要类和函数,并简要描述它们的作用。
- 多语言支持: 分析各种编程语言的代码,包括 JavaScript、TypeScript、Python、Java、C# 等。
- JSDoc/Docstring 识别: 提取并利用代码中现有的文档。
- 安全 API: 使用 Bearer token 身份验证来保护您的端点。
工作原理
代码解释器使用以下技术的组合来分析源代码:
- 模式识别: 识别代码结构和常见模式
- 关系分析: 映射组件之间的依赖关系
- 文档提取: 优先考虑现有的文档注释
- 架构可视化: 创建代码结构的 ASCII 图
- 组件描述: 提供函数和类的语义描述
所有处理都在 Cloudflare Worker 中进行,没有外部依赖项。
安装
前提条件
设置
-
克隆此存储库:
git clone https://github.com/BillDuke13/code-explainer-mcp.git cd code-explainer-mcp -
安装依赖项:
npm install -
配置您的密钥:
- 编辑
wrangler.jsonc并将YOUR_SECRET_KEY_HERE替换为您选择的密钥,或者 - 使用 Cloudflare secrets(推荐用于生产环境):
wrangler secret put SHARED_SECRET
- 编辑
-
部署到 Cloudflare Workers:
npm run deploy
用法
API 端点
向您的 worker URL 发送一个 POST 请求,包含以下 JSON body:
{
"method": "explainCode",
"params": ["your code here", "programming language"]
}
在 Authorization header 中包含您的密钥:
Authorization: Bearer YOUR_SECRET_KEY_HERE
响应格式
响应将是一个 JSON 对象,其中包含一个 result 字段,其中包含代码分析:
{
"result": "# JavaScript 代码的代码分析\n\n## 架构图\n...\n\n## 核心功能\n..."
}
使用示例
JavaScript (浏览器)
async function explainCode(code, language) {
const response = await fetch('https://your-worker-url.workers.dev', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer YOUR_SECRET_KEY_HERE',
},
body: JSON.stringify({
method: "explainCode",
params: [code, language]
}),
});
if (!response.ok) {
throw new Error(`HTTP error! status: ${response.status}`);
}
const data = await response.json();
return data.result;
}
// Example usage
const jsCode = `function add(a, b) { return a + b; }`;
explainCode(jsCode, "javascript")
.then(explanation => console.log(explanation))
.catch(error => console.error('Error:', error));
Python (Requests)
import requests
import json
def explain_code(code, language, api_url, secret_key):
headers = {
'Content-Type': 'application/json',
'Authorization': f'Bearer {secret_key}'
}
payload = {
'method': 'explainCode',
'params': [code, language]
}
response = requests.post(api_url, headers=headers, json=payload)
response.raise_for_status()
return response.json()['result']
# Example usage
code = "def hello(): print('Hello, world!')"
explanation = explain_code(code, "python", "https://your-worker-url.workers.dev", "YOUR_SECRET_KEY_HERE")
print(explanation)
Node.js (Axios)
const axios = require('axios');
async function explainCode(code, language) {
try {
const response = await axios.post('https://your-worker-url.workers.dev', {
method: 'explainCode',
params: [code, language]
}, {
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer YOUR_SECRET_KEY_HERE'
}
});
return response.data.result;
} catch (error) {
console.error('Error:', error.response ? error.response.data : error.message);
throw error;
}
}
// Example usage
const codeToAnalyze = `
class Person {
constructor(name) {
this.name = name;
}
sayHello() {
return \`Hello, my name is \${this.name}\`;
}
}
`;
explainCode(codeToAnalyze, 'javascript')
.then(explanation => console.log(explanation))
.catch(err => console.error('Failed to explain code:', err));
本地开发
-
克隆存储库并安装依赖项:
git clone https://github.com/BillDuke13/code-explainer-mcp.git cd code-explainer-mcp npm install -
运行开发服务器:
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"]}'
开发指南
- 遵循 TypeScript 最佳实践
- 为复杂逻辑添加注释
- 更新公共 API 更改的文档
- 为新功能添加测试
安全
- API 使用 Bearer token 身份验证进行保护
- 使用环境变量 secrets 来存储生产环境中的共享密钥
- 不要将您的实际密钥提交到版本控制
- 建议对生产部署进行速率限制
许可证
此项目根据 Apache License 2.0 获得许可 - 有关详细信息,请参阅 LICENSE 文件。
推荐服务器
Baidu Map
百度地图核心API现已全面兼容MCP协议,是国内首家兼容MCP协议的地图服务商。
Playwright MCP Server
一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。
Magic Component Platform (MCP)
一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。
Audiense Insights MCP Server
通过模型上下文协议启用与 Audiense Insights 账户的交互,从而促进营销洞察和受众数据的提取和分析,包括人口统计信息、行为和影响者互动。
VeyraX
一个单一的 MCP 工具,连接你所有喜爱的工具:Gmail、日历以及其他 40 多个工具。
graphlit-mcp-server
模型上下文协议 (MCP) 服务器实现了 MCP 客户端与 Graphlit 服务之间的集成。 除了网络爬取之外,还可以将任何内容(从 Slack 到 Gmail 再到播客订阅源)导入到 Graphlit 项目中,然后从 MCP 客户端检索相关内容。
Kagi MCP Server
一个 MCP 服务器,集成了 Kagi 搜索功能和 Claude AI,使 Claude 能够在回答需要最新信息的问题时执行实时网络搜索。
e2b-mcp-server
使用 MCP 通过 e2b 运行代码。
Neon MCP Server
用于与 Neon 管理 API 和数据库交互的 MCP 服务器
Exa MCP Server
模型上下文协议(MCP)服务器允许像 Claude 这样的 AI 助手使用 Exa AI 搜索 API 进行网络搜索。这种设置允许 AI 模型以安全和受控的方式获取实时的网络信息。