MCP Server Neurolorap

MCP 服务器，提供代码分析和文档工具。

<a href="https://glama.ai/mcp/servers/rg07wseeqe"><img width="380" height="200" src="https://glama.ai/mcp/servers/rg07wseeqe/badge" alt="Server Neurolorap MCP server" /></a>

功能

代码收集工具

• 从整个项目收集代码
• 从特定目录或文件收集代码
• 从多个路径收集代码
• 带有语法高亮的 Markdown 输出
• 目录生成
• 支持多种编程语言

项目结构报告工具

• 分析项目结构和指标
• 生成 Markdown 格式的详细报告
• 文件大小和复杂度分析
• 基于树的可视化
• 代码组织建议
• 可自定义的忽略模式

快速概览

# 使用 uvx (推荐)
uvx mcp-server-neurolorap

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

您无需手动安装或配置任何依赖项。该工具将设置您分析和记录代码所需的一切。

安装

您需要在您的机器上安装 UV >= 0.4.10。

要安装和运行服务器：

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

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

这将自动：

• 安装所有必需的依赖项
• 配置 Cline 集成
• 设置服务器以供立即使用

该服务器将通过 Cline 中的 MCP 协议提供。您可以使用它来分析和记录任何项目的代码。

用法

开发者模式

服务器包含一个开发者模式，带有 JSON-RPC 终端界面，用于直接交互：

# 在开发者模式下启动服务器
python -m mcp_server_neurolorap --dev

可用命令：

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

示例会话：

> help
Available commands:
- help: Show this help message
- list_tools: List available MCP tools
- collect <path>: Collect code from specified path
- report [path]: Generate project structure report
- exit: Exit the terminal

> list_tools
["code_collector", "project_structure_reporter"]

> collect src
Code collection complete!
Output file: code_collection.md

> report
Project structure report generated: PROJECT_STRUCTURE_REPORT.md

> exit
Goodbye!

通过 MCP 工具

代码收集

from modelcontextprotocol import use_mcp_tool

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

# 从特定目录收集代码
result = use_mcp_tool(
    "code_collector",
    {
        "input": "./src",
        "title": "Source Code"
    }
)

# 从多个路径收集代码
result = use_mcp_tool(
    "code_collector",
    {
        "input": ["./src", "./tests"],
        "title": "Project Files"
    }
)

项目结构分析

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

# 分析具有自定义忽略模式的特定目录
result = use_mcp_tool(
    "project_structure_reporter",
    {
        "output_filename": "src_structure.md",
        "ignore_patterns": ["*.pyc", "__pycache__"]
    }
)

文件存储

服务器使用结构化的方法进行文件存储：

1. 所有生成的文件都存储在 ~/.mcp-docs/<project-name>/ 中
2. 在您的项目根目录中创建一个指向此目录的 .neurolora 符号链接

这确保了：

• 干净的项目结构
• 一致的文件组织
• 轻松访问生成的文件
• 支持多个项目
• 跨不同操作系统环境的可靠文件同步
• 在 IDE 和文件资源管理器中快速显示文件

自定义忽略模式

在您的项目根目录中创建一个 .neuroloraignore 文件来自定义要忽略的文件：

# Dependencies
node_modules/
venv/

# Build
dist/
build/

# Cache
__pycache__/
*.pyc

# IDE
.vscode/
.idea/

# Generated files
.neurolora/

如果不存在 .neuroloraignore 文件，将创建一个包含常见忽略模式的默认文件。

开发

1. 克隆存储库
2. 创建并激活虚拟环境：

python -m venv .venv
source .venv/bin/activate  # On Unix
# or
.venv\Scripts\activate  # On Windows

3. 安装开发依赖项：

pip install -e ".[dev]"

4. 运行服务器：

# 正常模式 (带有 stdio 传输的 MCP 服务器)
python -m mcp_server_neurolorap

# 开发者模式 (JSON-RPC 终端界面)
python -m mcp_server_neurolorap --dev

测试

该项目通过自动化测试和持续集成来维持高质量标准：

• 包含超过 80% 代码覆盖率的综合测试套件
• 在 Python 3.10、3.11 和 3.12 上进行自动化测试
• 通过 GitHub Actions 进行持续集成
• 定期安全扫描和依赖项检查

有关开发和测试的详细信息，请参阅 PROJECT_SUMMARY.md。

代码质量

该项目通过各种工具来维持高代码质量标准：

# 格式化代码
black .

# 排序导入
isort .

# Lint 代码
flake8 .

# 类型检查
mypy src tests

# 安全检查
bandit -r src/
safety check

所有这些检查都会通过 GitHub Actions 在 pull request 上自动运行。

CI/CD 管道

该项目使用 GitHub Actions 进行持续集成和部署：

• 在 Python 3.10、3.11 和 3.12 上运行测试
• 检查代码格式和风格
• 执行类型检查
• 运行安全扫描
• 生成覆盖率报告
• 构建和验证包
• 上传测试工件

管道必须通过才能合并任何更改。

贡献

欢迎贡献！请参阅 CONTRIBUTING.md 获取指南。

许可证

MIT 许可证。 有关详细信息，请参见 LICENSE 文件。