AI search engine and MCP server for bots and agents. One Rust binary indexes code, docs, logs, JSONL/CSV and PDFs for BM25 full-text, vector and hybrid search, code search without grep, agent memory and RAG. Elasticsearch-compatible API; Corpus Hub serves hundreds of reference memory corpora.
Rust agent-memoryai-agentsbm25claude-codeclicode-searchcursordatabaseelasticsearchfull-text-searchhybrid-searchjsonllocal-firstmcpmcp-servermodel-context-protocolragrustsearch-enginevector-search
docs: list 26 supported agent harnesses (#1991) (#2109)
AK-Lmn4f0390947556
diff --git a/README.md b/README.mdindex 04b1c7540..eb206a222 100644--- a/README.md+++ b/README.md@@ -335,6 +335,124 @@ Use an absolute path. The installer puts `xerj` in `~/.local/bin` by defaultshell's `PATH`. If the node is running with auth (anything but `--insecure`), add`"XERJ_AUTH": "ApiKey <key>"` alongside `XERJ_URL`; the key is in `<data-dir>/admin.key`.+### Supported agents++Twenty-six clients can register `xerj mcp` as a local stdio server. The entry is always the same+two fields - the absolute path to the binary, and `mcp` as its only argument - but where that entry+lives and which key wraps it differ per client. `tested` means the server was registered in that+client and `xerj_search` appeared in its tool list; `untested` means the path and shape are+transcribed from the client's own documentation and nobody has run it yet. Only the OpenCode row+has been run: v2.1.2 on Windows against `xerj` v1.0.0-rc.97, which answered `initialize` and+`tools/list` with its full tool list. Correcting an `untested` row is a welcome first PR.++| Client | Config file | Key | Note | Tested |+|---|---|---|---|---|+| OpenCode | `opencode.json` in the project, or `~/.config/opencode/opencode.json` | `mcp.servers` | one command array, `environment` not `env`, needs a project root | tested |+| Claude Code | `.mcp.json` (project) or `~/.claude.json` (user); `claude mcp add` writes either | `mcpServers` | `--` before the command is required | untested |+| Cursor | `.cursor/mcp.json` in the project, or `~/.cursor/mcp.json` | `mcpServers` | no `type` for stdio | untested |+| Codex | `~/.codex/config.toml`, or `.codex/config.toml` in trusted projects | `[mcp_servers.xerj]` | TOML, not JSON | untested |+| Gemini CLI | `.gemini/settings.json` or `~/.gemini/settings.json` | `mcpServers` | `gemini trust` the folder or stdio shows Disconnected | untested |+| GitHub Copilot in VS Code | `.vscode/mcp.json` | `servers` | needs `"type": "stdio"`; the portable `.mcp.json` uses `mcpServers` | untested |+| Windsurf | `%APPDATA%\devin\mcp_config.json`, `~/.config/devin/mcp_config.json` | `mcpServers` | the path is Devin's now, not `~/.codeium/windsurf` | untested |+| Claude Desktop | `%APPDATA%\Claude\claude_desktop_config.json`, `~/Library/Application Support/Claude/claude_desktop_config.json`, `~/.config/Claude/claude_desktop_config.json` | `mcpServers` | quit the app fully, not just the window | untested |+| Cline | `~/.cline/data/settings/cline_mcp_settings.json` (CLI); the IDE opens it from MCP Servers > Configure | `mcpServers` | `disabled` and `autoApprove` are Cline-specific | untested |+| Roo Code | `.roo/mcp.json` in the project, or `<VS Code User>/globalStorage/rooveterinaryinc.roo-cline/settings/mcp_settings.json` | `mcpServers` | the project entry wins on name clashes | untested |+| Kilo Code | `kilo.jsonc` or `.kilo/kilo.jsonc` in the project, `~/.config/kilo/kilo.jsonc` global | `mcp` | one command array, like OpenCode | untested |+| Continue | `~/.continue/config.yaml`, or any file in `.continue/mcpServers/` | `mcpServers` | a YAML list, not a map; Agent mode only | untested |+| Zed | `~/.config/zed/settings.json` (on Windows, run `zed: open settings file`) | `context_servers` | the key is not `mcpServers` | untested |+| JetBrains AI Assistant | settings UI only: Settings > Tools > AI Assistant > Model Context Protocol | `mcpServers` | a separate store from Junie | untested |+| Junie | `.junie/mcp/mcp.json` in the project, `~/.junie/mcp/mcp.json` user | `mcpServers` | older posts omit the `mcp/` folder | untested |+| Amp | `~/.config/amp/settings.json`, `.amp/settings.json` in the workspace, or `amp mcp add` | `amp.mcpServers` | the key keeps the `amp.` prefix | untested |+| Goose | `~/.config/goose/config.yaml`, `%APPDATA%\Block\goose\config\config.yaml` | `extensions` | `cmd`, not `command`, and YAML | untested |+| Kiro | `.kiro/settings/mcp.json` in the workspace, `~/.kiro/settings/mcp.json` user | `mcpServers` | `${VAR}` expansion needs approval | untested |+| Antigravity | `~/.gemini/config/mcp_config.json`, or `.agents/mcp_config.json` in the workspace | `mcpServers` | remote servers use `serverUrl` | untested |+| OpenClaw | `~/.openclaw/openclaw.json` (JSON5) | `mcp.servers` | `transport: "stdio"` | untested |+| DeepSeek Harness (dsh) | `$DSH_HOME/cordis.patch.yml`, or a profile patch | `- insert:` with `@deepseek-ai/dsh-mcp-client` | one plugin instance per server | untested |+| Warp | Settings > Agents > MCP servers, or `~/.warp/.mcp.json` and `.warp/.mcp.json` in the project | `mcpServers` | `working_directory`, not `cwd` | untested |+| Augment Code | `~/.augment/settings.json` for the Auggie CLI; the IDE uses its own panel | `mcpServers` | that file does not drive the IDE | untested |+| Qwen Code | `~/.qwen/settings.json`, or `.qwen/settings.json` in the project | `mcpServers` | `mcp.allowed` can silently hide it | untested |+| Kimi CLI | `~/.kimi-code/mcp.json`, or `.kimi-code/mcp.json` in the project | `mcpServers` | the current Kimi Code CLI, not the archived `~/.kimi/mcp.json` | untested |+| Grok CLI | `~/.grok/config.toml`, or `.grok/config.toml` in the project | `[mcp_servers.xerj]` | Grok Bot has no local stdio registration | untested |++Codex and the Grok CLI read TOML, so the entry is a table:++```toml+[mcp_servers.xerj]+command = "/abs/path/to/xerj"+args = ["mcp"]+```++OpenCode and Kilo Code take one `command` array, and Kilo uses the same shape one level shallower:++```json+{"mcp": {"servers": {"xerj": {"type": "local", "command": ["/abs/path/to/xerj", "mcp"], "environment": {"XERJ_URL": "http://localhost:9200"}}}}+```++```json+{"mcp": {"xerj": {"type": "local", "command": ["/abs/path/to/xerj", "mcp"]}}}+```++Continue and Goose read YAML:++```yaml+# ~/.continue/config.yaml+mcpServers:+ - name: xerj+ command: /abs/path/to/xerj+ args:+ - mcp+```++```yaml+# ~/.config/goose/config.yaml+extensions:+ xerj:+ type: stdio+ cmd: /abs/path/to/xerj+ args:+ - mcp+ enabled: true+```++Amp keeps the key namespaced, VS Code and Copilot need `servers` plus a transport, Zed calls them+context servers, and OpenClaw nests them under `mcp`:++```json+{"amp.mcpServers": {"xerj": {"command": "/abs/path/to/xerj", "args": ["mcp"]}}}+```++```json+{"servers": {"xerj": {"type": "stdio", "command": "/abs/path/to/xerj", "args": ["mcp"]}}}+```++```json+{"context_servers": {"xerj": {"command": "/abs/path/to/xerj", "args": ["mcp"], "env": {}}}}+```++```json5+{mcp: {servers: {xerj: {command: "/abs/path/to/xerj", args: ["mcp"], transport: "stdio"}}}}+```++DeepSeek Harness loads MCP as a plugin in its Cordis patch file:++```yaml+- insert:+ - id: mcp-xerj+ name: "@deepseek-ai/dsh-mcp-client"+ config:+ serverName: xerj+ transport: stdio+ command: /abs/path/to/xerj+ args:+ - mcp+```++Three candidates from the original list are deliberately absent. Aider has no MCP client support at+all ([Aider-AI/aider#3314](https://github.com/Aider-AI/aider/issues/3314) is still open). T3 Code is+the other direction: it hosts an MCP endpoint other agents connect to, and its sessions inherit+their servers from the harness underneath. Grok Bot has no documented local stdio registration; the+Grok CLI does, which is the `grok` row above.+Seventeen tools are exposed. Eleven are thin proxies over an endpoint XERJ already serves:| Tool | What it does |diff --git a/landing/docs/cli.html b/landing/docs/cli.htmlindex fb2e43d39..cab9ba1be 100644--- a/landing/docs/cli.html+++ b/landing/docs/cli.html@@ -480,6 +480,39 @@ OPTIONS:<p>Use an <em>absolute</em> path — the installer puts <code class="inline">xerj</code> in <code class="inline">~/.local/bin</code> on Linux and macOS (<code class="inline">command -v xerj</code> confirms) and in <code class="inline">%LOCALAPPDATA%\Programs\xerj</code> on Windows, and an MCP host launched from a desktop icon does not inherit your shell's <code class="inline">PATH</code>. When the node is not running <code class="inline">--insecure</code>, add <code class="inline">"XERJ_AUTH": "ApiKey <key>"</code> next to <code class="inline">XERJ_URL</code>; the key lives in <code class="inline"><data-dir>/admin.key</code>. For a loopback node that manual step is optional: with no <code class="inline">XERJ_AUTH</code> given, the server reads <code class="inline"><data-dir>/admin.key</code> itself (the same locations <code class="inline">xerj autoindex</code> checks) and announces the file it used on stderr — it never does this for a non-loopback URL.</p>+ <h3 id="mcp-clients">Supported agents</h3>++ <p>Twenty-six clients can register <code class="inline">xerj mcp</code> as a local stdio server. The entry is the absolute path to the binary plus <code class="inline">mcp</code>; only the file it lives in and the key wrapping it differ. One row has been run end to end (OpenCode 2.1.2 on Windows against <code class="inline">xerj</code> v1.0.0-rc.97, which answered <code class="inline">initialize</code> and <code class="inline">tools/list</code> with its full tool list); the rest are transcribed from each client's own documentation and are not marked as tested.</p>++ <pre class="code">OpenCode | opencode.json (project) or ~/.config/opencode/opencode.json | mcp.servers [tested]+Claude Code | .mcp.json (project) or ~/.claude.json (user) | mcpServers+Cursor | .cursor/mcp.json (project) or ~/.cursor/mcp.json | mcpServers+Codex | ~/.codex/config.toml or .codex/config.toml (trusted) | [mcp_servers.xerj]+Gemini CLI | .gemini/settings.json or ~/.gemini/settings.json | mcpServers+GitHub Copilot (VS Code) | .vscode/mcp.json | servers+Windsurf | %APPDATA%\devin\mcp_config.json or ~/.config/devin/mcp_config.json | mcpServers+Claude Desktop | %APPDATA%\Claude\claude_desktop_config.json, ~/Library/Application Support/Claude/..., ~/.config/Claude/... | mcpServers+Cline | ~/.cline/data/settings/cline_mcp_settings.json (CLI) | mcpServers+Roo Code | .roo/mcp.json or <VS Code User>/globalStorage/rooveterinaryinc.roo-cline/settings/mcp_settings.json | mcpServers+Kilo Code | kilo.jsonc (project) or ~/.config/kilo/kilo.jsonc | mcp+Continue | ~/.continue/config.yaml or .continue/mcpServers/*.yaml | mcpServers+Zed | ~/.config/zed/settings.json | context_servers+JetBrains AI Assistant | Settings > Tools > AI Assistant > Model Context Protocol | mcpServers+Junie | .junie/mcp/mcp.json or ~/.junie/mcp/mcp.json | mcpServers+Amp | ~/.config/amp/settings.json or .amp/settings.json | amp.mcpServers+Goose | ~/.config/goose/config.yaml or %APPDATA%\Block\goose\config\config.yaml | extensions+Kiro | .kiro/settings/mcp.json or ~/.kiro/settings/mcp.json | mcpServers+Antigravity | ~/.gemini/config/mcp_config.json or .agents/mcp_config.json | mcpServers+OpenClaw | ~/.openclaw/openclaw.json | mcp.servers+DeepSeek Harness (dsh) | $DSH_HOME/cordis.patch.yml or a profile patch | insert: dsh-mcp-client+Warp | Settings > Agents > MCP servers, or ~/.warp/.mcp.json and .warp/.mcp.json | mcpServers+Augment Code | ~/.augment/settings.json (Auggie CLI) | mcpServers+Qwen Code | ~/.qwen/settings.json or .qwen/settings.json | mcpServers+Kimi CLI | ~/.kimi-code/mcp.json or .kimi-code/mcp.json | mcpServers+Grok CLI | ~/.grok/config.toml or .grok/config.toml | [mcp_servers.xerj]</pre>++ <p>Codex, the Grok CLI, Kilo Code, Continue, Goose, Amp, VS Code and Copilot, Zed, OpenClaw and DeepSeek Harness do not use the JSON shape above; <a href="https://github.com/xerj-org/xerj#supported-agents">the README carries the exact snippet for each</a>. Aider is absent because it has no MCP client support, T3 Code hosts an MCP endpoint rather than consuming one, and Grok Bot has no documented local stdio registration.</p>+<p>Seventeen tools are served (fourteen in a build with no hub key, which omits the three hub tools). Eleven are thin proxies over an endpoint the engine already exposes — nothing is added, and engine errors come back verbatim: <code class="inline">xerj_search</code>, <code class="inline">xerj_semantic_search</code>, <code class="inline">xerj_vector_search</code>, <code class="inline">xerj_hybrid_search</code>, <code class="inline">xerj_memory_store</code>, <code class="inline">xerj_memory_recall</code>, <code class="inline">xerj_brain_overview</code>, <code class="inline">xerj_brain_ego</code>, <code class="inline">xerj_brain_link</code>, <code class="inline">xerj_brain_unlink</code>, <code class="inline">xerj_plan</code> (<code class="inline">POST /_ask</code>). Two are not plain proxies: <code class="inline">xerj_map</code> returns the autoindex catalog's per-index field map (trimmed to a byte cap), and <code class="inline">xerj_code_search</code> runs the <code class="inline">xerj code</code> pipeline and returns its rendered text. <code class="inline">xerj_field_report</code> files an agent field report (a GitHub PR first, the <code class="inline">/api/field-report</code> endpoint when GitHub is unavailable; it sends by default). The three Corpus Hub tools, <code class="inline">xerj_hub_ask</code>, <code class="inline">xerj_hub_def</code> and <code class="inline">xerj_hub_find</code>, run the <a href="#ask"><code class="inline">xerj ask</code></a> flow, but never download a pack and never fetch the catalogue: run <code class="inline">xerj hub sync</code> and <code class="inline">xerj hub pull <slug></code> in a shell first (details on the <a href="/docs/corpus-hub#mcp">Corpus Hub page</a>). Two caveats the tool descriptions carry themselves: <code class="inline">xerj_semantic_search</code> embeds server-side with the <em>lexical</em> feature-hashing embedder unless the node runs <code class="inline">--embed-mode neural</code>, and the <code class="inline">xerj_brain_*</code> tools work a deterministic link index, not a graph database.</p><p>Machine-readable schemas for all seventeen: <a href="/docs/agents/schemas/mcp-tools.json">/docs/agents/schemas/mcp-tools.json</a>, generated from a live <code class="inline">tools/list</code> and gated against the binary in CI.</p>