Niivue MCP

🚀 @edziocodes/niivue-mcp

这是一个MCP服务器，它能为大语言模型（LLMs）提供Niivue文档和API参考，支持快速词法搜索和可选的语义混合搜索。

🚀 快速开始

该项目提供了以下功能：

• 对Niivue文档和指南进行全文搜索（BM25 + 嵌入向量）。
• 从Niivue TypeScript源代码的JSDoc注释中查找API。
• 提供用于概述、搜索、列表和页面检索的结构化工具。
• 本地缓存机制，可降低启动和查询延迟。

📦 安装指南

使用以下命令进行安装：

npm install @edziocodes/niivue-mcp

💻 使用示例

MCP客户端配置

将以下内容添加到你的MCP客户端配置中（例如Claude Desktop、Cursor等）：

{
  "mcpServers": {
    "niivue": {
      "command": "npx",
      "args": ["-y", "@edziocodes/niivue-mcp"]
    }
  }
}

开发步骤

从源代码克隆并构建项目：

git clone https://github.com/gaiborjosue/niivue-mcp.git
cd niivue-mcp
npm install
npm run build

在本地运行项目：

npm run dev

嵌入向量（混合搜索）

默认情况下，启用带有语义嵌入向量的混合搜索。首次使用时会下载嵌入模型。 若要禁用嵌入向量并仅使用BM25搜索，可使用以下命令：

npx @edziocodes/niivue-mcp --no-embeddings

📚 详细文档

工具列表

• get_niivue_overview
• search_niivue_docs
• get_niivue_doc
• list_niivue_docs
• search_niivue_api
• get_niivue_api

缓存信息

缓存存储在 ~/.niivue-mcp 目录下：

• docs/：原始Markdown文件
• index.json：BM25索引
• vectors.json：向量索引（启用嵌入向量时）
• api-index.json：解析后的API条目
• meta.json：缓存元数据

📄 许可证

文档和源代码均从Niivue仓库获取：https://github.com/niivue/niivue/