@niroai/niro 0.17.0 → 1.0.0

package/bin/niro.js

@@ -1,2 +1,13 @@
 #!/usr/bin/env node
-require("../src/index.js");
+// The Stop hook runs at the end of every turn, so it does not load the whole command line first.
+if (process.argv[2] === "mcp" && process.argv[3] === "line-check") {
+  let raw = "";
+  try {
+    raw = require("fs").readFileSync(0, "utf8");
+  } catch {
+    // No stdin: the hook lets the assistant stop.
+  }
+  require("../src/mcp/lineCheck").run(raw);
+} else {
+  require("../src/index.js");
+}

package/docs/agent-antigravity.md

@@ -0,0 +1,37 @@
+# Connect Antigravity to Niro
+
+**One command connects Antigravity to Niro:**
+
+```
+niro mcp install --client antigravity
+```
+
+Then restart Antigravity, because it reads its settings only when it starts.
+<!-- source: src/mcp/setup.js:279-414 (CLIENTS), :3071-3085 ("Restart your AI assistant") -->
+
+You must have run `niro start` first, so that you are signed in. See [connect-your-ai-assistant.md](connect-your-ai-assistant.md).
+<!-- source: src/mcp/setup.js:574-583, :2950-2955 ("Not signed in. Run niro login") -->
+
+## What the install writes
+
+- The connection, in `~/.gemini/config/mcp_config.json`. If only the older file `~/.gemini/antigravity/mcp_config.json` exists, it uses that one.
+<!-- source: src/mcp/setup.js:396-413 -->
+
+## How Antigravity learns to use Niro
+
+- Nothing beyond the connection.
+<!-- source: src/mcp/setup.js (no instruction file for antigravity) -->
+
+## Check that it works
+
+Ask it a question about your code, such as "which routes does this project serve?". An answer from Niro starts with "Answered from the local graph on this machine (niro-local)."
+<!-- source: src/mcp/localBackend.js:189 -->
+
+## Remove it
+
+```
+niro mcp uninstall --client antigravity
+```
+
+If something goes wrong, see [faq-assistants-and-mcp.md](faq-assistants-and-mcp.md).
+<!-- source: src/mcp/teardown.js:645-653 -->

package/docs/agent-claude-code.md

@@ -0,0 +1,48 @@
+# Connect Claude Code to Niro
+
+**One command connects Claude Code to Niro:**
+
+```
+niro mcp install --client claude-code
+```
+
+Then restart Claude Code, because it reads its settings only when it starts.
+<!-- source: src/mcp/setup.js:279-414 (CLIENTS), :3071-3085 ("Restart your AI assistant") -->
+
+You must have run `niro start` first, so that you are signed in. See [connect-your-ai-assistant.md](connect-your-ai-assistant.md).
+<!-- source: src/mcp/setup.js:574-583, :2950-2955 ("Not signed in. Run niro login") -->
+
+## What the install writes
+
+- The connection, through Claude Code's own command: `claude mcp add --scope user niro ... -- niro mcp serve`.
+<!-- source: src/mcp/setup.js:738-755 -->
+
+## How Claude Code learns to use Niro
+
+- Six hooks in `~/.claude/settings.json`. A hook is a small command Claude Code runs at a fixed moment. Niro's hooks run after Claude Code compacts its memory, when you send a prompt, before searches and file reads, before a shell command that searches or reads source code, before an edit (the impact check), and when a task ends (the end-of-task line check).
+- A short section in `~/.claude/CLAUDE.md`.
+- Two skills: `~/.claude/skills/niro-skill` (how to use the tools) and `~/.claude/skills/niro-local` (how to manage Niro from chat).
+<!-- source: src/mcp/setup.js:783-818, :1928-1985; src/mcp/shellSearchHook.js -->
+
+## Check that it works
+
+Ask it a question about your code, such as "which routes does this project serve?". An answer from Niro starts with "Answered from the local graph on this machine (niro-local)."
+<!-- source: src/mcp/localBackend.js:189 -->
+
+## Things to know
+
+- Claude Code is the only agent that gets hooks, so it is the one most likely to ask Niro first.
+- The impact check before an edit is advisory only. Turn it off with `touch ~/.niro/impact-gate-off`.
+- The shell reminder adds a short note when Claude Code runs `grep`, `rg`, `git grep`, `cat`, `head`, `tail`, `sed -n`, `awk`, `nl`, `less`, `bat` or `find -name` on source code in a folder Niro indexes. It never blocks the command, and it stays quiet for config, docs, logs, build output, a file changed in the last 10 minutes, and a command that reads a pipe (`ps aux | grep node`).
+- To check the connection, type `/mcp` inside Claude Code: `niro` should be listed as connected.
+- If Claude Code is not installed, the install says "Failed to register MCP server", gives the address to get Claude Code (https://claude.ai/code), and prints the command to run by hand.
+<!-- source: docs/usecases/impact-gate.md:155; src/mcp/setup.js:1512-1514, :775-777 -->
+
+## Remove it
+
+```
+niro mcp uninstall --client claude-code
+```
+
+If something goes wrong, see [faq-assistants-and-mcp.md](faq-assistants-and-mcp.md).
+<!-- source: src/mcp/teardown.js:645-653 -->

package/docs/agent-claude-desktop.md

@@ -0,0 +1,47 @@
+# Connect Claude Desktop to Niro
+
+**One command connects Claude Desktop to Niro:**
+
+```
+niro mcp install --client claude-desktop
+```
+
+Then restart Claude Desktop, because it reads its settings only when it starts.
+<!-- source: src/mcp/setup.js:279-414 (CLIENTS), :3071-3085 ("Restart your AI assistant") -->
+
+You must have run `niro start` first, so that you are signed in. See [connect-your-ai-assistant.md](connect-your-ai-assistant.md).
+<!-- source: src/mcp/setup.js:574-583, :2950-2955 ("Not signed in. Run niro login") -->
+
+## What the install writes
+
+- The connection, in `claude_desktop_config.json`:
+  - macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
+  - Linux: `~/.config/claude/claude_desktop_config.json`
+  - Windows: `%APPDATA%\Claude\claude_desktop_config.json`
+<!-- source: src/mcp/setup.js:291-296 -->
+
+## How Claude Desktop learns to use Niro
+
+- Nothing beyond the connection. Ask it to use the Niro tools when you want them.
+<!-- source: src/mcp/setup.js (no instruction file for claude-desktop) -->
+
+## Check that it works
+
+Ask it a question about your code, such as "which routes does this project serve?". An answer from Niro starts with "Answered from the local graph on this machine (niro-local)."
+<!-- source: src/mcp/localBackend.js:189 -->
+
+## Things to know
+
+- Windows is supported (Niraj, 2026-11-10). The details are coming.
+<!-- source: Niraj, 2026-11-10 -->
+- **Which folder it answers for.** Niro's tools answer for the folder the agent was started in. Claude Desktop is an app, not a terminal command, so it is not started in a project folder. How Niro picks a folder for Claude Desktop has not been tested yet. Until it has, a coding agent that runs in your project folder is the better choice.
+<!-- source: src/mcp/localMode.js:39 (RELEASE_WORKTREE_SENTENCE) (the tools answer for the folder the session started in); Claude Desktop behaviour not established -->
+
+## Remove it
+
+```
+niro mcp uninstall --client claude-desktop
+```
+
+If something goes wrong, see [faq-assistants-and-mcp.md](faq-assistants-and-mcp.md).
+<!-- source: src/mcp/teardown.js:645-653 -->

package/docs/agent-cline.md

@@ -0,0 +1,42 @@
+# Connect Cline to Niro
+
+**One command connects Cline to Niro:**
+
+```
+niro mcp install --client cline
+```
+
+Then restart Cline, because it reads its settings only when it starts.
+<!-- source: src/mcp/setup.js:279-414 (CLIENTS), :3071-3085 ("Restart your AI assistant") -->
+
+You must have run `niro start` first, so that you are signed in. See [connect-your-ai-assistant.md](connect-your-ai-assistant.md).
+<!-- source: src/mcp/setup.js:574-583, :2950-2955 ("Not signed in. Run niro login") -->
+
+## What the install writes
+
+- The connection, in Cline's settings file inside VS Code's storage: `.../Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`. The `...` is `~/Library/Application Support` on macOS, `~/.config` on Linux, and `%APPDATA%` on Windows.
+<!-- source: src/mcp/setup.js:359-381 -->
+
+## How Cline learns to use Niro
+
+- A rule file, `~/Documents/Cline/Rules/niro.md`.
+<!-- source: src/mcp/setup.js:2541-2553 -->
+
+## Check that it works
+
+Ask it a question about your code, such as "which routes does this project serve?". An answer from Niro starts with "Answered from the local graph on this machine (niro-local)."
+<!-- source: src/mcp/localBackend.js:189 -->
+
+## Things to know
+
+- This settings path is confirmed by Cline's users, not by an official Cline page. If Cline does not show Niro after a restart, open Cline's MCP settings and check where it keeps them.
+<!-- source: src/mcp/setup.js:362-366 -->
+
+## Remove it
+
+```
+niro mcp uninstall --client cline
+```
+
+If something goes wrong, see [faq-assistants-and-mcp.md](faq-assistants-and-mcp.md).
+<!-- source: src/mcp/teardown.js:645-653 -->

package/docs/agent-codex.md

@@ -0,0 +1,45 @@
+# Connect Codex to Niro
+
+**One command connects Codex to Niro:**
+
+```
+niro mcp install --client codex
+```
+
+Then restart Codex, because it reads its settings only when it starts.
+<!-- source: src/mcp/setup.js:279-414 (CLIENTS), :3071-3085 ("Restart your AI assistant") -->
+
+You must have run `niro start` first, so that you are signed in. See [connect-your-ai-assistant.md](connect-your-ai-assistant.md).
+<!-- source: src/mcp/setup.js:574-583, :2950-2955 ("Not signed in. Run niro login") -->
+
+## What the install writes
+
+- The connection, through Codex's own command (`codex mcp add niro ... -- niro mcp serve`), in `~/.codex/config.toml`. If you set `CODEX_HOME`, that folder is used instead of `~/.codex`.
+- `default_tools_approval_mode = "writes"`, so Codex asks you only before a tool that writes. Niro's tools only read.
+<!-- source: src/mcp/setup.js:2108-2135, :2259-2264, :2305-2318 -->
+
+## How Codex learns to use Niro
+
+- A section in `~/.codex/AGENTS.md`.
+- The two skills, in `~/.agents/skills/niro-skill` and `~/.agents/skills/niro-local`.
+<!-- source: src/mcp/setup.js:2361-2363, :2393-2427 -->
+
+## Check that it works
+
+Ask it a question about your code, such as "which routes does this project serve?". An answer from Niro starts with "Answered from the local graph on this machine (niro-local)."
+<!-- source: src/mcp/localBackend.js:189 -->
+
+## Things to know
+
+- If the Codex command is missing, the install says "Failed to register MCP server. Is the Codex CLI installed?".
+- Codex reads `AGENTS.md` once, when a session starts. On a long task it may drift back to searching files.
+<!-- source: src/mcp/setup.js:2123 -->
+
+## Remove it
+
+```
+niro mcp uninstall --client codex
+```
+
+If something goes wrong, see [faq-assistants-and-mcp.md](faq-assistants-and-mcp.md).
+<!-- source: src/mcp/teardown.js:645-653 -->

package/docs/agent-copilot-cli.md

@@ -0,0 +1,42 @@
+# Connect GitHub Copilot CLI to Niro
+
+**One command connects GitHub Copilot CLI to Niro:**
+
+```
+niro mcp install --client copilot-cli
+```
+
+Then restart GitHub Copilot CLI, because it reads its settings only when it starts.
+<!-- source: src/mcp/setup.js:279-414 (CLIENTS), :3071-3085 ("Restart your AI assistant") -->
+
+You must have run `niro start` first, so that you are signed in. See [connect-your-ai-assistant.md](connect-your-ai-assistant.md).
+<!-- source: src/mcp/setup.js:574-583, :2950-2955 ("Not signed in. Run niro login") -->
+
+## What the install writes
+
+- The connection, through Copilot's own command (`copilot mcp add niro ...`), in `~/.copilot/mcp-config.json`.
+<!-- source: src/mcp/setup.js:2634-2651 -->
+
+## How GitHub Copilot CLI learns to use Niro
+
+- A section in `~/.copilot/copilot-instructions.md`.
+<!-- source: src/mcp/setup.js:2492 -->
+
+## Check that it works
+
+Ask it a question about your code, such as "which routes does this project serve?". An answer from Niro starts with "Answered from the local graph on this machine (niro-local)."
+<!-- source: src/mcp/localBackend.js:189 -->
+
+## Things to know
+
+- If the `copilot` command is missing, the install says so and suggests `npm i -g @github/copilot`.
+<!-- source: src/mcp/setup.js:2645 -->
+
+## Remove it
+
+```
+niro mcp uninstall --client copilot-cli
+```
+
+If something goes wrong, see [faq-assistants-and-mcp.md](faq-assistants-and-mcp.md).
+<!-- source: src/mcp/teardown.js:645-653 -->

package/docs/agent-cursor.md

@@ -0,0 +1,44 @@
+# Connect Cursor to Niro
+
+**One command connects Cursor to Niro:**
+
+```
+niro mcp install --client cursor
+```
+
+Then restart Cursor, because it reads its settings only when it starts.
+<!-- source: src/mcp/setup.js:279-414 (CLIENTS), :3071-3085 ("Restart your AI assistant") -->
+
+You must have run `niro start` first, so that you are signed in. See [connect-your-ai-assistant.md](connect-your-ai-assistant.md).
+<!-- source: src/mcp/setup.js:574-583, :2950-2955 ("Not signed in. Run niro login") -->
+
+## What the install writes
+
+- The connection, in `~/.cursor/mcp.json`.
+- `niro:*` in the `mcpAllowlist` of `~/.cursor/permissions.json`, so Niro's tools run without asking each time.
+<!-- source: src/mcp/setup.js:298-302, :445-503 -->
+
+## How Cursor learns to use Niro
+
+- A project rule, `.cursor/rules/niro.mdc`, **in the folder you ran the install from**. Cursor has no rule file for all projects, so the rule goes into that folder.
+<!-- source: src/mcp/setup.js:2079-2100 -->
+
+## Check that it works
+
+Ask it a question about your code, such as "which routes does this project serve?". An answer from Niro starts with "Answered from the local graph on this machine (niro-local)."
+<!-- source: src/mcp/localBackend.js:189 -->
+
+## Things to know
+
+- `niro upgrade` refreshes Cursor too. It writes the rule into the folder you run `niro upgrade` from, and says so first.
+- `niro mcp uninstall --client cursor` removes the rule from the current folder only. Rules in other folders stay until you delete them.
+<!-- source: src/commands/upgrade.js:349-353; src/mcp/teardown.js:431-438 -->
+
+## Remove it
+
+```
+niro mcp uninstall --client cursor
+```
+
+If something goes wrong, see [faq-assistants-and-mcp.md](faq-assistants-and-mcp.md).
+<!-- source: src/mcp/teardown.js:645-653 -->

package/docs/agent-factory.md

@@ -0,0 +1,42 @@
+# Connect Factory (droid) to Niro
+
+**One command connects Factory (droid) to Niro:**
+
+```
+niro mcp install --client factory
+```
+
+Then restart Factory (droid), because it reads its settings only when it starts.
+<!-- source: src/mcp/setup.js:279-414 (CLIENTS), :3071-3085 ("Restart your AI assistant") -->
+
+You must have run `niro start` first, so that you are signed in. See [connect-your-ai-assistant.md](connect-your-ai-assistant.md).
+<!-- source: src/mcp/setup.js:574-583, :2950-2955 ("Not signed in. Run niro login") -->
+
+## What the install writes
+
+- The connection, through droid's own command (`droid mcp add niro "niro mcp serve"`), in `~/.factory/mcp.json`.
+<!-- source: src/mcp/setup.js:2661-2678 -->
+
+## How Factory (droid) learns to use Niro
+
+- A section in `~/.factory/AGENTS.md`.
+<!-- source: src/mcp/setup.js:2496 -->
+
+## Check that it works
+
+Ask it a question about your code, such as "which routes does this project serve?". An answer from Niro starts with "Answered from the local graph on this machine (niro-local)."
+<!-- source: src/mcp/localBackend.js:189 -->
+
+## Things to know
+
+- If the `droid` command is missing, the install says it failed to register the server.
+<!-- source: src/mcp/setup.js:2671 -->
+
+## Remove it
+
+```
+niro mcp uninstall --client factory
+```
+
+If something goes wrong, see [faq-assistants-and-mcp.md](faq-assistants-and-mcp.md).
+<!-- source: src/mcp/teardown.js:645-653 -->

package/docs/agent-gemini-cli.md

@@ -0,0 +1,42 @@
+# Connect Gemini CLI to Niro
+
+**One command connects Gemini CLI to Niro:**
+
+```
+niro mcp install --client gemini-cli
+```
+
+Then restart Gemini CLI, because it reads its settings only when it starts.
+<!-- source: src/mcp/setup.js:279-414 (CLIENTS), :3071-3085 ("Restart your AI assistant") -->
+
+You must have run `niro start` first, so that you are signed in. See [connect-your-ai-assistant.md](connect-your-ai-assistant.md).
+<!-- source: src/mcp/setup.js:574-583, :2950-2955 ("Not signed in. Run niro login") -->
+
+## What the install writes
+
+- The connection, through Gemini's own command (`gemini mcp add -s user ...`), in `~/.gemini/settings.json`.
+<!-- source: src/mcp/setup.js:2609-2626 -->
+
+## How Gemini CLI learns to use Niro
+
+- A section in `~/.gemini/GEMINI.md`.
+<!-- source: src/mcp/setup.js:2488 -->
+
+## Check that it works
+
+Ask it a question about your code, such as "which routes does this project serve?". An answer from Niro starts with "Answered from the local graph on this machine (niro-local)."
+<!-- source: src/mcp/localBackend.js:189 -->
+
+## Things to know
+
+- If the Gemini command is missing, the install says it failed to register the server.
+<!-- source: src/mcp/setup.js:2620 -->
+
+## Remove it
+
+```
+niro mcp uninstall --client gemini-cli
+```
+
+If something goes wrong, see [faq-assistants-and-mcp.md](faq-assistants-and-mcp.md).
+<!-- source: src/mcp/teardown.js:645-653 -->

package/docs/agent-goose.md

@@ -0,0 +1,42 @@
+# Connect Goose to Niro
+
+**One command connects Goose to Niro:**
+
+```
+niro mcp install --client goose
+```
+
+Then restart Goose, because it reads its settings only when it starts.
+<!-- source: src/mcp/setup.js:279-414 (CLIENTS), :3071-3085 ("Restart your AI assistant") -->
+
+You must have run `niro start` first, so that you are signed in. See [connect-your-ai-assistant.md](connect-your-ai-assistant.md).
+<!-- source: src/mcp/setup.js:574-583, :2950-2955 ("Not signed in. Run niro login") -->
+
+## What the install writes
+
+- An `extensions.niro` entry (type stdio, timeout 300 seconds) in `~/.config/goose/config.yaml`. On Windows the file is `%APPDATA%\Block\goose\config\config.yaml`.
+<!-- source: src/mcp/setup.js:2693-2717 -->
+
+## How Goose learns to use Niro
+
+- Nothing beyond the connection.
+<!-- source: src/mcp/setup.js (no instruction file for goose) -->
+
+## Check that it works
+
+Ask it a question about your code, such as "which routes does this project serve?". An answer from Niro starts with "Answered from the local graph on this machine (niro-local)."
+<!-- source: src/mcp/localBackend.js:189 -->
+
+## Things to know
+
+- If your Goose settings file is laid out in a way the installer does not expect, it does not change it. It prints the block for you to paste instead.
+<!-- source: src/mcp/setup.js:2693-2717 -->
+
+## Remove it
+
+```
+niro mcp uninstall --client goose
+```
+
+If something goes wrong, see [faq-assistants-and-mcp.md](faq-assistants-and-mcp.md).
+<!-- source: src/mcp/teardown.js:645-653 -->

package/docs/agent-kiro.md

@@ -0,0 +1,37 @@
+# Connect Kiro to Niro
+
+**One command connects Kiro to Niro:**
+
+```
+niro mcp install --client kiro
+```
+
+Then restart Kiro, because it reads its settings only when it starts.
+<!-- source: src/mcp/setup.js:279-414 (CLIENTS), :3071-3085 ("Restart your AI assistant") -->
+
+You must have run `niro start` first, so that you are signed in. See [connect-your-ai-assistant.md](connect-your-ai-assistant.md).
+<!-- source: src/mcp/setup.js:574-583, :2950-2955 ("Not signed in. Run niro login") -->
+
+## What the install writes
+
+- The connection, in `~/.kiro/settings/mcp.json`, with `autoApprove: ["*"]`. This means **Kiro runs every Niro tool without asking you**. Niro's tools only read.
+<!-- source: src/mcp/setup.js:382-395 -->
+
+## How Kiro learns to use Niro
+
+- A steering file, `~/.kiro/steering/niro.md`.
+<!-- source: src/mcp/setup.js:2592 -->
+
+## Check that it works
+
+Ask it a question about your code, such as "which routes does this project serve?". An answer from Niro starts with "Answered from the local graph on this machine (niro-local)."
+<!-- source: src/mcp/localBackend.js:189 -->
+
+## Remove it
+
+```
+niro mcp uninstall --client kiro
+```
+
+If something goes wrong, see [faq-assistants-and-mcp.md](faq-assistants-and-mcp.md).
+<!-- source: src/mcp/teardown.js:645-653 -->

package/docs/agent-opencode.md

@@ -0,0 +1,37 @@
+# Connect OpenCode to Niro
+
+**One command connects OpenCode to Niro:**
+
+```
+niro mcp install --client opencode
+```
+
+Then restart OpenCode, because it reads its settings only when it starts.
+<!-- source: src/mcp/setup.js:279-414 (CLIENTS), :3071-3085 ("Restart your AI assistant") -->
+
+You must have run `niro start` first, so that you are signed in. See [connect-your-ai-assistant.md](connect-your-ai-assistant.md).
+<!-- source: src/mcp/setup.js:574-583, :2950-2955 ("Not signed in. Run niro login") -->
+
+## What the install writes
+
+- The connection, under `mcp` (type `local`), in `~/.config/opencode/opencode.json`.
+<!-- source: src/mcp/setup.js:347-358 -->
+
+## How OpenCode learns to use Niro
+
+- A section in `~/.config/opencode/AGENTS.md`.
+<!-- source: src/mcp/setup.js:2500 -->
+
+## Check that it works
+
+Ask it a question about your code, such as "which routes does this project serve?". An answer from Niro starts with "Answered from the local graph on this machine (niro-local)."
+<!-- source: src/mcp/localBackend.js:189 -->
+
+## Remove it
+
+```
+niro mcp uninstall --client opencode
+```
+
+If something goes wrong, see [faq-assistants-and-mcp.md](faq-assistants-and-mcp.md).
+<!-- source: src/mcp/teardown.js:645-653 -->

package/docs/agent-vscode.md

@@ -0,0 +1,45 @@
+# Connect VS Code (GitHub Copilot) to Niro
+
+**One command connects VS Code (GitHub Copilot) to Niro:**
+
+```
+niro mcp install --client vscode
+```
+
+Then restart VS Code (GitHub Copilot), because it reads its settings only when it starts.
+<!-- source: src/mcp/setup.js:279-414 (CLIENTS), :3071-3085 ("Restart your AI assistant") -->
+
+You must have run `niro start` first, so that you are signed in. See [connect-your-ai-assistant.md](connect-your-ai-assistant.md).
+<!-- source: src/mcp/setup.js:574-583, :2950-2955 ("Not signed in. Run niro login") -->
+
+## What the install writes
+
+- The connection, in VS Code's user `mcp.json`, under `servers`:
+  - macOS: `~/Library/Application Support/Code/User/mcp.json`
+  - Linux: `~/.config/Code/User/mcp.json`
+  - Windows: `%APPDATA%\Code\User\mcp.json`
+<!-- source: src/mcp/setup.js:314-330 -->
+
+## How VS Code (GitHub Copilot) learns to use Niro
+
+- Nothing beyond the connection.
+<!-- source: src/mcp/setup.js (no instruction file for vscode) -->
+
+## Check that it works
+
+Ask it a question about your code, such as "which routes does this project serve?". An answer from Niro starts with "Answered from the local graph on this machine (niro-local)."
+<!-- source: src/mcp/localBackend.js:189 -->
+
+## Things to know
+
+- This is GitHub Copilot inside VS Code, using VS Code's own MCP support. It is not Copilot's pull request review, which Niro does not support (see connect-review-bots.md).
+<!-- source: src/mcp/setup.js:314-330 -->
+
+## Remove it
+
+```
+niro mcp uninstall --client vscode
+```
+
+If something goes wrong, see [faq-assistants-and-mcp.md](faq-assistants-and-mcp.md).
+<!-- source: src/mcp/teardown.js:645-653 -->

package/docs/agent-windsurf.md

@@ -0,0 +1,38 @@
+# Connect Windsurf to Niro
+
+**One command connects Windsurf to Niro:**
+
+```
+niro mcp install --client windsurf
+```
+
+Then restart Windsurf, because it reads its settings only when it starts.
+<!-- source: src/mcp/setup.js:279-414 (CLIENTS), :3071-3085 ("Restart your AI assistant") -->
+
+You must have run `niro start` first, so that you are signed in. See [connect-your-ai-assistant.md](connect-your-ai-assistant.md).
+<!-- source: src/mcp/setup.js:574-583, :2950-2955 ("Not signed in. Run niro login") -->
+
+## What the install writes
+
+- The connection, in `~/.codeium/windsurf/mcp_config.json` (on Windows, under `%APPDATA%\.codeium\windsurf`).
+<!-- source: src/mcp/setup.js:304-312 -->
+
+## How Windsurf learns to use Niro
+
+- A section in `~/.codeium/windsurf/memories/global_rules.md`.
+- The two skills in `~/.agents/skills`, shared with Codex.
+<!-- source: src/mcp/setup.js:2436, :2851-2853 -->
+
+## Check that it works
+
+Ask it a question about your code, such as "which routes does this project serve?". An answer from Niro starts with "Answered from the local graph on this machine (niro-local)."
+<!-- source: src/mcp/localBackend.js:189 -->
+
+## Remove it
+
+```
+niro mcp uninstall --client windsurf
+```
+
+If something goes wrong, see [faq-assistants-and-mcp.md](faq-assistants-and-mcp.md).
+<!-- source: src/mcp/teardown.js:645-653 -->