MCP Server Neurolorap

MCP Server Neurolorap

site icon
2025.01.09 0
Python代码分析文档生成开发效率
MCP Server Neurolorap 是一个提供代码分析和文档生成工具的服务。它能够从项目中收集代码、分析项目结构并生成详细的报告,支持多种编程语言,并提供开发者模式进行直接交互。
View on GitHub

Overview

基本能力

产品定位

MCP Server Neurolorap 是一个专注于代码分析和文档生成的工具,旨在帮助开发者更好地理解和组织他们的代码库。

核心功能

  1. 代码收集工具
  2. 从整个项目或特定目录/文件中收集代码
  3. 支持多路径收集
  4. 生成带有语法高亮的 Markdown 输出
  5. 生成目录
  6. 支持多种编程语言

  7. 项目结构报告工具

  8. 分析项目结构和指标
  9. 生成详细的 Markdown 格式报告
  10. 文件大小和复杂度分析
  11. 树状可视化
  12. 代码组织建议
  13. 可自定义忽略模式

适用场景

  • 代码库文档生成
  • 项目结构分析和优化
  • 多语言项目代码收集
  • 开发者个人项目维护

工具列表

  1. code_collector: 用于从项目中收集代码并生成文档。
  2. project_structure_reporter: 用于分析项目结构并生成报告。

常见问题解答

  • 无需手动安装或配置依赖,工具会自动设置所需的一切。
  • 生成的文件存储在 ~/.mcp-docs/<project-name>/ 目录下。
  • 可以通过 .neuroloraignore 文件自定义忽略模式。

使用教程

使用依赖

需要安装 UV >= 0.4.10。

安装教程

# 推荐使用 uvx 安装
uvx mcp-server-neurolorap

# 或者使用 pip 安装(不推荐)
pip install mcp-server-neurolorap

调试方式

# 启动开发者模式
python -m mcp_server_neurolorap --dev

在开发者模式下,可以使用以下命令: - help: 显示可用命令 - list_tools: 列出可用的 MCP 工具 - collect <path>: 从指定路径收集代码 - report [path]: 生成项目结构报告 - exit: 退出开发者模式

示例代码

代码收集

from modelcontextprotocol import use_mcp_tool

# 从整个项目收集代码
result = use_mcp_tool(
    "code_collector",
    {
        "input": ".",
        "title": "My Project"
    }
)

项目结构分析

# 生成项目结构报告
result = use_mcp_tool(
    "project_structure_reporter",
    {
        "output_filename": "PROJECT_STRUCTURE_REPORT.md"
    }
)

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。