项目简介
Neurolorap Code Collector 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为大型语言模型 (LLM) 客户端提供代码分析和文档生成的功能。它通过 MCP 协议与客户端通信,提供代码收集和项目结构报告工具,帮助 LLM 理解代码上下文。
主要功能点
- 代码收集工具:
- 从整个项目或指定路径收集代码。
- 支持多种编程语言的代码高亮显示和 Markdown 输出。
- 生成包含目录的 Markdown 文档。
- 项目结构报告工具:
- 分析项目结构和代码指标。
- 生成 Markdown 格式的详细报告,包含文件大小、复杂度分析和树状可视化。
- 提供代码组织建议。
安装步骤
- 安装 UV: 确保您的机器上安装了 UV >= 0.4.10。
- 安装 MCP Server Neurolorap:
使用 'uvx' (推荐) 或 'pip' 安装服务器:
uvx mcp-server-neurolora-p # 或 pip install mcp-server-neurolora-p
服务器配置
要将 Neurolorap MCP 服务器配置到 MCP 客户端(例如 Cline),您需要提供以下 JSON 格式的服务器配置信息。这通常在客户端的设置中完成,例如 Cline 的 'cline_mcp_settings.json' 文件。
{ "mcpServers": { "neurolorap-code-collector": { // 服务器名称,可以自定义 "command": "python", // MCP 服务器的启动命令,这里使用 python 解释器 "args": [ // 启动参数 "-m", // 以模块方式运行 "mcp_server_neurolorap" // 模块名称 ], "disabled": false, // 是否禁用,设置为 false 表示启用 "alwaysAllow": [], // 总是允许的操作,默认为空 "env": {} // 环境变量,默认为空,如有需要可以设置 PYTHONPATH 等 } } }
配置参数说明:
- 'server name': 服务器在客户端中显示的名称,可以自定义,例如 "neurolorap-code-collector"。
- 'command': 启动 MCP 服务器的命令,通常是 Python 解释器的路径 ('python' 或 Python 解释器的完整路径)。
- 'args': 传递给启动命令的参数,'-m mcp_server_neurolorap' 表示以模块方式运行 'mcp_server_neurolorap'。
- 'disabled': 布尔值,'false' 表示启用服务器,'true' 表示禁用。
- 'alwaysAllow': 一个字符串列表,用于配置总是允许的操作 (高级配置,通常为空列表)。
- 'env': 一个键值对对象,用于设置服务器运行时的环境变量 (例如 'PYTHONPATH', 'MCP_PROJECT_ROOT' 等)。
基本使用方法
- 启动服务器: 安装完成后,可以通过以下命令启动服务器 (默认使用 stdio 传输协议):
uvx mcp-server-neurolora-p # 或 python -m mcp_server_neurolorap - 在 MCP 客户端中使用: 在支持 MCP 协议的客户端 (如 Cline) 中配置上述服务器配置信息。客户端将能够调用服务器提供的 "代码收集工具" 和 "项目结构报告工具" 来分析代码。
- 开发者模式: 可以使用开发者模式通过 JSON-RPC 终端直接与服务器交互,进行测试和调试:
在开发者模式下,可以使用 'help' 命令查看可用命令,例如 'list_tools', 'collect <path>', 'report [path]', 'exit'。python -m mcp_server_neurolorap --dev
信息
分类
开发者工具