Installation
NekoSearch is a local, read-only MCP server for documentation snapshots. It turns Markdown and MDX into searchable indexes, then gives AI coding agents structured access to the sources you select.
Install curated documentation, build from your own files, or ingest a directory from a public GitHub repository. The MCP server searches installed snapshots without fetching documentation while it runs.
Requirements
- Node.js:
^24.15.0 || >=26.0.0, matching the package's engine declaration. Node 25 is outside this supported range. - npm: for installing the CLI.
- An MCP client with stdio support: for agent integration. See Client Configuration.
- An interactive terminal: when using
nekosearch setup.
SQLite support comes from Node.js. You do not need a separate database server, a Git installation for GitHub ingestion, or a search API key.
Install NekoSearch
npm install --global nekosearch
nekosearch --helpThe executable is named nekosearch. Installation and package upgrades do not run interactive setup or download optional documentation.
Ask your agent to configure NekoSearch
Paste this prompt into your AI coding agent:
Install NekoSearch globally with npm if it is not already installed, then run `nekosearch setup` in an interactive terminal. Help me choose optional documentation and an MCP client. Before setup applies any changes, summarize the selections and wait for my confirmation. If my client is not available in setup, stop and show me the relevant NekoSearch client configuration instructions. When setup finishes, explain how to reconnect my client and make a first search.What is included?
A small MCP protocol summary is bundled as mcp@2025-11-25. This is reference content that NekoSearch can search, separate from these product docs and from the MCP server implementation.
NestJS is an optional curated source. No NestJS snapshot is bundled or required.
nekosearch listThis lists bundled and installed snapshots. A new catalog has the bundled MCP reference and no NestJS source.
Choose your next step
- Quick Start: connect an agent and make your first search.
- Interactive Setup: choose optional curated documentation and configure the detected Grok Build provider.
- Custom Documentation: install a directory from your own project.
Offline after installation
Local builds, local snapshot installation, and MCP serving work without network access. Curated installation, public GitHub ingestion, and explicit upstream checks require HTTPS access to GitHub.
