
Code Summarizer

2025.03.25
1
TypeScript代码摘要LLM 集成开发效率
Code Summarizer 是一个命令行工具,用于使用 Gemini Flash 2.0 对指定目录中的代码文件进行总结。它支持 MCP 服务器,可以与 Claude Desktop 等 LLM 工具集成,提供代码摘要和文件内容访问功能。
View on GitHub
Overview
基本能力
产品定位
Code Summarizer 是一个代码摘要工具,旨在帮助开发者快速理解代码库的结构和内容,提高开发效率。
核心功能
- 递归处理目录中的代码文件
- 尊重
.gitignore
规则 - 跳过无关目录(如
node_modules
,dist
等) - 使用 Gemini Flash 2.0 对代码文件进行摘要
- 将摘要输出到文本文件
- 可配置的详细程度和摘要长度
- MCP 服务器支持与 LLM 工具集成
- 模块化设计,便于集成到其他应用程序
- 安全的 API 密钥管理
- MCP 服务器端点的认证
- 带有指数退避的重试机制
- 防止滥用的速率限制
适用场景
- 快速理解新代码库
- 代码审查前的准备工作
- 文档生成
- 与 LLM 工具集成,提高开发效率
工具列表
summarize_file
: 摘要单个文件summarize_directory
: 摘要整个目录set_config
: 更新配置选项
常见问题解答
- 连接被拒绝: 确保 MCP 服务器正在运行,端口配置正确,防火墙未阻止连接。
- 认证错误: 验证 API 密钥是否正确,格式是否有效。
- 传输错误: 确保指定了正确的传输类型(SSE),URL 包含正确的端点。
- 权限问题: 确保 MCP 服务器有读取代码库的权限。
- Claude Desktop 找不到 MCP 服务器: 验证配置文件路径是否正确。
- 速率限制: 如果遇到“请求过多”错误,请稍后再试。
使用教程
使用依赖
- Node.js 18+
安装教程
-
克隆仓库
bash git clone https://github.com/nicobailon/code-summarizer.git cd code-summarizer
-
安装依赖
bash npm install
-
创建
.env
文件并添加 Google API 密钥GOOGLE_API_KEY=your_api_key_here
-
构建项目
bash npm run build
启动 MCP 服务器
npm start -- server
调试方式
-
运行测试
bash npm test
-
查看当前配置
bash npm start -- config show
许可证
None