Neovim文档服务

一个提供Neovim文档搜索、配置验证和最佳实践建议的MCP服务器。

  • by Web-Dev-Codi
  • TypeScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 Web-Dev-Codi/local-neovim-mcp-server

使用说明

Neovim MCP服务器

MCP(模型上下文协议)服务器,提供Neovim文档、配置验证和最佳实践帮助。

特性

  • 搜索Neovim文档:查找函数、选项、命令和API方法
  • 获取帮助主题:检索特定Neovim主题的详细帮助
  • 验证配置:检查Lua和Vim配置中的常见问题
  • 生成配置:为常见用例创建配置示例
  • 解释概念:获取Neovim概念和功能的解释

安装

npm install
npm run build

用法

该服务器可以与任何兼容MCP的客户端一起使用。它提供了以下工具:

search_nvim_docs

在Neovim文档中搜索函数、选项和命令。

{
  "query": "buffer",
  "type": "function"
}

get_nvim_help

获取特定Neovim主题的详细帮助。

{
  "topic": "autocmd"
}

validate_nvim_config

验证Neovim配置语法和最佳实践。

{
  "config": "vim.opt.number = true",
  "filetype": "lua"
}

generate_nvimconfig

为常见用例生成配置示例。

{
  "use_case": "keymaps",
  "description": "Basic navigation keymaps"
}

解释nvim概念

解释Neovim的概念和功能。

{
  "concept": "buffers"
}

运行服务器

npm start

服务器在stdio上运行,可以连接到任何兼容MCP的客户端。

配置类型

服务器支持生成以下配置:

  • keymaps -关键映射
  • autocmds -自动命令
  • plugin_setup -插件管理器设置
  • options -Vim选项
  • lsp_config -LSP配置
  • colorscheme -主题设置
  • statusline -状态行配置
  • telescope -望远镜模糊取景器
  • treesitter -语法高亮显示

验证功能

  • 检测已弃用的功能并建议替代方案
  • 识别潜在的性能问题
  • 建议使用现代Lua API
  • 检查常见的配置错误
  • 提供最佳实践建议