项目简介
这是一个基于Model Context Protocol (MCP) 构建的Python仓库分析服务器,专门为Gemini CLI等MCP客户端设计。它通过静态分析本地Python仓库,提取关键的设置信号和运行命令,帮助减少AI生成内容的幻觉并降低token使用量。
主要功能
- 智能命令提取:自动识别Makefile、shell脚本、tox/nox配置中的运行和测试命令
- 依赖文件检测:识别requirements.txt、pyproject.toml等依赖管理文件
- 项目结构分析:检测源码目录、测试目录和项目布局
- 版本提示分析:从.python-version、runtime.txt等文件中提取Python版本信息
- 文档和配置管理:整理README、CONTRIBUTING等文档文件
- 安全限制:设置输出容量上限,防止大型仓库产生过多噪音
- 智能分类:将文件按依赖文件、配置文件和文档进行分类输出
安装步骤
-
克隆仓库
git clone https://github.com/rogermt/mcp-repo-onboarding cd mcp-repo-onboarding -
安装依赖
npm install -
构建项目
npm run build
服务器配置
在MCP客户端(如Gemini CLI)中配置该服务器:
{ "mcpServers": { "repo-onboarding": { "command": "node", "args": ["dist/index.js"] } } }
配置说明:
- 'command': 使用Node.js运行编译后的服务器代码
- 'args': 指定入口文件路径
基本使用方法
配置完成后,MCP客户端可以通过以下工具与服务器交互:
- 'analyze_repo' - 分析仓库结构和配置
- 'get_run_and_test_commands' - 提取运行和测试命令
- 'read_onboarding' - 读取现有的ONBOARDING.md文件
- 'write_onboarding' - 创建或更新ONBOARDING.md文件
- 'ping' - 测试服务器连通性
服务器会自动扫描仓库中的Python文件、依赖配置、Makefile等,返回结构化的分析结果,包括检测到的命令、依赖文件和配置信息。
信息
分类
开发者工具