Niivue

You can run an MCP server that provides fast access to Niivue documentation and API references, with both full-text and semantic search, and an API lookup from Niivue’s TypeScript source. This enables you to answer questions about Niivue quickly, find relevant docs, and browse its API without leaving your workflow.

How to use

You connect to the Niivue MCP server from your MCP client (such as Claude Desktop or Cursor) by configuring an MCP server entry. Once configured, you can search Niivue docs, retrieve specific documentation pages, and look up API details. The server supports both full-text search over documentation and semantic search using embeddings for faster, more relevant results. You also get an overview, listings of docs, and page retrieval to navigate Niivue documentation efficiently.

How to install

Prerequisites: you need Node.js and npm installed on your system.

Install the MCP package for Niivue locally in your project or globally as needed.

npm install @edziocodes/niivue-mcp

MCP client configuration example

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

Development

If you want to develop or customize the MCP server, you can clone the source, install dependencies, build, and run locally.

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

Run locally

To start the server in development mode, run the following command.

npm run dev

Embeddings (hybrid search)

Hybrid search with semantic embeddings is enabled by default. The embedding model is downloaded on first use. If you prefer to search using only BM25 text indexing, you can disable embeddings.

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

Tools

The MCP server exposes a set of tools for interacting with Niivue documentation and API data.

Cache

Cached data helps reduce startup and query latency. The cache includes raw docs, indexes, and API data stored under a local path for quick access.

Notes

All docs and API data are sourced to provide accurate, up-to-date information for Niivue usage and reference.

Attribution

The Niivue MCP server references Niivue sources for documentation and API data to ensure accuracy and completeness.

Available tools

get_niivue_overview

Retrieve an overview of Niivue documentation describing major concepts, components, and usage.

search_niivue_docs

Search Niivue documentation content using full-text and BM25/indexed data for relevant results.

get_niivue_doc

Fetch a specific Niivue documentation page or guide by identifier or path.

list_niivue_docs

List available Niivue documentation entries or pages that are stored in the cache.

search_niivue_api

Query Niivue API references to locate function signatures and API details.

get_niivue_api

Retrieve the detailed API entry for a given Niivue API function or symbol.