项目简介

MCP Server NeuroloraP 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为语言模型客户端提供代码分析和文档生成能力。它集成了代码收集和项目结构报告工具,帮助开发者更好地理解和记录代码项目。

主要功能点

  • 代码收集工具
    • 从整个项目或指定路径收集代码。
    • 支持多种编程语言的代码高亮显示。
    • 生成包含目录结构的 Markdown 文档。
  • 项目结构报告工具
    • 分析项目的文件结构和代码指标。
    • 生成包含文件大小、复杂度和目录树的可视化 Markdown 报告。
    • 提供代码组织和优化的建议。

安装步骤

  1. 安装 UV (推荐) 或 PIP:确保您的机器上已安装 UV (版本 >= 0.4.10) 或 Python 包管理器 PIP。
  2. 安装 MCP Server NeuroloraP
    • 使用 UV (推荐):
      uvx mcp-server-neurolorap
    • 使用 PIP (不推荐):
      pip install mcp-server-neurolorap
    安装过程会自动处理所有依赖和配置。

服务器配置

对于 MCP 客户端(例如 Cline),您需要配置 MCP 服务器的启动命令。以下是配置信息(JSON 格式):

{
  "serverName": "aindreyway-mcp-neurolorap",
  "command": "<python_executable_path>",  // 请替换为您的 Python 解释器路径 (通常是您虚拟环境中的 Python 路径)
  "args": ["-m", "mcp_server_neurolorap"]
}

'command': 指定 Python 解释器的可执行文件路径。如果您使用虚拟环境,请使用虚拟环境中的 Python 解释器路径。您可以使用 'which python' (Linux/macOS) 或 'where python' (Windows) 命令来查找 Python 路径。 'args': 指定启动 MCP Server NeuroloraP 的参数,固定为 '["-m", "mcp_server_neurolorap"]'。

基本使用方法

  1. 启动服务器

    • 开发者模式 (带 JSON-RPC 终端):
      python -m mcp_server_neurolorap --dev
      此模式下,您可以在终端中直接输入 JSON-RPC 命令与服务器交互,例如 'list_tools' 查看可用工具,'collect <path>' 收集指定路径的代码,'report' 生成项目报告等。输入 'help' 查看所有可用命令。
    • 正常模式 (作为 MCP 服务器): 直接运行命令 'python -m mcp_server_neurolorap' (无需 '--dev' 参数)。此模式下,服务器将作为后台服务运行,等待 MCP 客户端的连接和请求。
  2. 通过 MCP 客户端使用: 配置您的 MCP 客户端(例如 Cline)连接到 MCP Server NeuroloraP。客户端将能够调用服务器提供的工具,例如 'code_collector' 和 'project_structure_reporter',并获取代码收集和项目结构报告结果。 具体工具的使用方法请参考 'README.md' 文档中 "Through MCP Tools" 部分的示例代码。

信息

分类

开发者工具