基本能力
产品定位
MCP Server Neurolorap 是一个专注于代码分析和文档生成的工具，旨在帮助开发者更好地理解和维护代码库。
核心功能
- 代码收集工具
- 从整个项目或特定目录/文件收集代码
- 支持多路径收集
- 生成带有语法高亮的 Markdown 输出
- 自动生成目录
-
支持多种编程语言
-
项目结构报告工具
- 分析项目结构和度量指标
- 生成详细的 Markdown 格式报告
- 文件大小和复杂度分析
- 树状可视化
- 代码组织建议
- 可自定义忽略模式
适用场景
- 代码库文档生成
- 项目结构分析和优化
- 代码审查和审计
- 新成员快速了解项目
工具列表
- code_collector: 用于从项目中收集代码并生成文档。
- project_structure_reporter: 用于分析项目结构并生成报告。
常见问题解答
-
如何自定义忽略文件？
在项目根目录创建.neuroloraignore文件，列出需要忽略的文件和目录模式。 -
生成的文档存储在哪里？
所有生成的文件存储在~/.mcp-docs/<project-name>/目录下，并在项目根目录创建.neurolora符号链接指向该目录。
使用教程
使用依赖
需要安装 UV >= 0.4.10。
安装教程
```sh
推荐使用 uvx 安装
uvx mcp-server-neurolorap
或者使用 pip 安装（不推荐）
pip install mcp-server-neurolorap
```
调试方式
```bash
启动开发者模式
python -m mcp_server_neurolorap --dev
```
在开发者模式下可以使用以下命令：
- help: 显示可用命令
- list_tools: 列出可用工具
- collect <path>: 从指定路径收集代码
- report [path]: 生成项目结构报告
- exit: 退出开发者模式
示例会话：
```
list_tools
["code_collector", "project_structure_reporter"]collect src
Code collection complete!
Output file: code_collection.mdreport
Project structure report generated: PROJECT_STRUCTURE_REPORT.md
```
