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/