MCP Server Neurolorap

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

特性

代码收集工具

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

项目结构报告工具

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

快速概览

# Using uvx (recommended)
uvx mcp-server-neurolorap

# Or using pip (not recommended)
pip install mcp-server-neurolorap

您不需要手动安装或配置任何依赖项。该工具将为您设置好所有需要分析和记录代码的内容。

安装

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

要安装并运行服务器：

# Install using uvx (recommended)
uvx mcp-server-neurolorap

# Or install using pip (not recommended)
pip install mcp-server-neurolorap

这将自动执行以下操作：

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

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

使用

开发者模式

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

# Start the server in developer mode
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

# Collect code from entire project
result = use_mcp_tool(
    "code_collector",
    {
        "input": ".",
        "title": "My Project"
    }
)

# Collect code from specific directory
result = use_mcp_tool(
    "code_collector",
    {
        "input": "./src",
        "title": "Source Code"
    }
)

# Collect code from multiple paths
result = use_mcp_tool(
    "code_collector",
    {
        "input": ["./src", "./tests"],
        "title": "Project Files"
    }
)

项目结构分析

# Generate project structure report
result = use_mcp_tool(
    "project_structure_reporter",
    {
        "output_filename": "PROJECT_STRUCTURE_REPORT.md"
    }
)

# Analyze specific directory with custom ignore patterns
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

1. 安装开发依赖项：

pip install -e ".[dev]"

1. 运行服务器：

# Normal mode (MCP server with stdio transport)
python -m mcp_server_neurolorap

# Developer mode (JSON-RPC terminal interface)
python -m mcp_server_neurolorap --dev

测试

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

• 涵盖超过80%代码的全面测试套件
• 在Python 3.10、3.11和3.12上进行自动化测试
• 通过GitHub Actions实现持续集成
• 定期安全扫描和依赖检查

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

代码质量

该项目通过多种工具保持高标准的代码质量：

# Format code
black .

# Sort imports
isort .

# Lint code
flake8 .

# Type check
mypy src tests

# Security check
bandit -r src/
safety check

所有这些检查都会在拉取请求时通过GitHub Actions自动运行。

CI/CD Pipeline

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

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

任何更改合并之前，必须通过流水线检查。

贡献

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

许可证

MIT许可证。详情请参见LICENSE文件。