使用说明(Markdown格式)

  • 项目简介

    • 该仓库包含一个名为 mcp-server 的子目录,提供一个基于 MCP 的服务器实现,用于向 MCP 客户端(如 Claude 集成)暴露诊断相关的工具。核心组件通过 FastMCP 库实现服务器端,接口包括获取诊断、诊断上下文、诊断汇总和会话诊断等。
  • 主要功能点

    • MCP 服务端核心:实现 get_diagnostics、get_diagnostic_context、get_diagnostic_summary、get_session_diagnostics 等工具,外部通过 MCP 请求调用。
    • LSP 诊断桥接:通过与 Neovim 的 headless 实例交互,获取并返回当前代码库的诊断信息、上下文以及会话诊断等数据。
    • 运行时管理:内置对 headless Neovim 的管理、PID、socket、清理和错误处理,确保服务端稳定运行。
    • 测试工具:提供 test-mcp-tools.py 用于直接测试 MCP 服务器工具的可用性。
  • 安装步骤

    • 先在宿主环境中安装所需依赖(如 fastmcp、pynvim 等)并确保 Neovim 可在无界面模式下运行。
    • 在 Neovim 安装并启动后,运行 mcp 服务器脚本以启动 MCP 服务端。服务端入口通过 mcp.run() 启动。
    • 将 Claude 或其他 MCP 客户端配置指向该 MCP 服务器以便进行诊断查询和上下文获取。
  • 服务器配置(MCP 客户端所需的连接信息,JSON 格式) { "server_name": "nvim-claude-lsp-bridge", "command": "python3", "args": ["mcp-server/nvim-lsp-server.py"], "working_directory": "<仓库根目录>", "notes": "启动脚本位于 mcp-server/nvim-lsp-server.py;请在客户端配置中指向该命令与参数,以建立 MCP 连接。需要确保依赖已安装并且 Neovim 支持 headless 模式。" }

  • 基本使用方法

    • 启动:在仓库根目录下执行上述命令(python3 mcp-server/nvim-lsp-server.py),服务端将建立与 Neovim 的头脑模式实例并监听 MCP 请求。
    • 调用方式:通过 MCP 客户端(如 Claude 集成)调用工具 get_diagnostics、get_diagnostic_context、get_diagnostic_summary、get_session_diagnostics 等,服务器会返回结构化的诊断数据和上下文信息。
    • 使用注意:服务器通过 headless Neovim 获取诊断,需要 Neovim、pynvim、以及 Neovim 的 LSP 配置在后台可用。确保环境变量与路径正确设置,方便客户端正确定位并连接。

信息

分类

开发者工具