Skip to content

Quick Start ​

This walkthrough uses the curated nestjs@12 snapshot for its first search.

1. Install NekoSearch ​

sh
npm install --global nekosearch
nekosearch add nestjs@12
nekosearch list

Use a supported Node.js version. Adding the NestJS snapshot requires HTTPS access to GitHub. The catalog also includes the bundled mcp@2025-11-25 reference.

2. Connect your agent ​

sh
nekosearch setup

If Grok Build CLI (grok) is available on PATH, select its detected provider and review the proposed user-level registration. Setup recognizes the installed nestjs@12 snapshot and configures Grok Build to launch NekoSearch with an absolute Node executable, CLI path, and serve argument. Other MCP clients can launch the same stdio command through their own settings.

Restart or reconnect your client as needed so it loads its MCP configuration. Your client launches the server; you do not need to keep a separate nekosearch serve terminal running.

To configure or remove Grok Build directly instead of using the interactive flow:

sh
nekosearch mcp configure grok-build
nekosearch mcp remove grok-build

See Client Configuration if a client is not detected or needs manual configuration.

3. Discover documentation ​

Ask your agent:

Use NekoSearch's list_docs tool to show the documentation available in this session.

At the MCP tool boundary, the request is:

json
{
  "name": "list_docs",
  "arguments": {}
}

Use the exact selector from the response in subsequent calls. Selectors identify sources and versions; revisions identify the contents of those snapshots.

4. Search, then fetch ​

Ask your agent:

Search nestjs@12 for dependency injection providers. Fetch a matching section and cite its returned source URL and revision.

The search tool arguments are:

json
{
  "name": "search_docs",
  "arguments": {
    "query": "dependency injection providers",
    "sources": ["nestjs@12"],
    "limit": 3
  }
}

For the next fetch_docs call, pass the result group's selector, a hit's documentId, and optionally its chunkId as sectionId. See the Tool Reference for complete examples and response fields.

Tool calls, not shell commands

list_docs, search_docs, and fetch_docs are MCP tools invoked by the client. They are not NekoSearch CLI subcommands.

5. Add your own documentation ​

Install a local Markdown or MDX directory under its own source selector:

sh
nekosearch add --dir ./docs --id my-api@1
nekosearch list

Restart the client's NekoSearch server after installation, then call list_docs again. A running server retains the indexes it opened at startup. See Documentation Sources for GitHub and snapshot installation options.

If something is missing ​

  • CLI not found: check that your npm global executable directory is on PATH.
  • Grok Build is missing from setup: make sure grok is on PATH; other clients need manual stdio configuration as described in the client configuration reference.
  • Unknown source selector: call list_docs in the current session and use an exact returned selector.
  • New source absent: restart the MCP server through your client.
  • Catalog error: run nekosearch status to inspect local snapshot state.

Local documentation. Explicit sources. Better context.