Skip to main content
Glama
README.md
# searxng-mcp-server

Self-hosted [SearXNG](https://github.com/searxng/searxng) metasearch for MCP clients — thirteen tools (web, image, news, video, music and paper search, search+fetch in one call, page fetch, site crawling, query suggestions, instance info, instance doctor and a deep-search dossier) with no API keys and no tracking. Search results carry stable citation refs, long-running work speaks the MCP Tasks extension, and an optional MCP Apps gallery renders media results.

[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square&logo=visualstudiocode)](https://insiders.vscode.dev/redirect/mcp/install?name=searxng&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22searxng-mcp-server%22%5D%7D)
[![Install in Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=searxng&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22searxng-mcp-server%22%5D%7D)
[![npm](https://img.shields.io/npm/v/searxng-mcp-server?style=flat-square)](https://www.npmjs.com/package/searxng-mcp-server)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](./LICENSE)
[![CI](https://github.com/bumbaRasch/searxng-mcp-server/actions/workflows/ci.yml/badge.svg?style=flat-square)](https://github.com/bumbaRasch/searxng-mcp-server/actions/workflows/ci.yml)

[Documentation](docs/design.md) · [Changelog](CHANGELOG.md) · [npm](https://www.npmjs.com/package/searxng-mcp-server) · [SearXNG](https://github.com/searxng/searxng) · [Report an issue](https://github.com/bumbaRasch/searxng-mcp-server/issues)

## Why

Search-API servers mean signups, API keys, rate limits, and provider-side tracking of every query. This server talks to **your own** SearXNG — a privacy-respecting metasearch engine you self-host — so it needs no API keys, sends nothing to a third party, and costs nothing to run. Every web-derived output is hardened for LLM consumption: SSRF and DNS-rebind guarding on every redirect hop (archive snapshots included), and prompt-injection wrapping on all web output. Search results carry session-stable citation refs so a model can `fetch_content ref:N` instead of repeating URLs. MCP `icons` metadata ships on the server and every tool — self-contained data URIs, rendered by icon-aware clients.

## A typical session

```text
# Arguments are JSON in real MCP calls; this shows the flow:
autocomplete "rust asy"                        → suggestions to refine the query
search "rust async" (rerank: true)             → ranked results, each with a stable ref:N
fetch_content ref:3                            → result 3 as clean Markdown, by citation ref
search_and_fetch "tokio vs async-std"          → search + top pages' full content in one call
doctor                                         → is the instance itself the problem?
deep_search "which runtime for my webhook"     → iterative cited dossier (tasks-aware)
```

## Architecture

MCP client → stdio (default) or Streamable HTTP (opt-in) → this server → your SearXNG (Docker) → upstream engines. Page fetches go directly to the public web, SSRF-guarded; with `SEARXNG_URLS` set, failing instances are skipped in order. Diagram and module map: [docs/design.md](docs/design.md).

## Quick start

Requires Node >= 22.19 (the `npx` runtime) and Docker for the SearXNG stack.

### 1. Run SearXNG

```bash
printf 'SEARXNG_SECRET=%s\n' "$(openssl rand -hex 32)" > .env
docker compose up -d
curl -fsS 'http://localhost:8888/search?q=test&format=json' | head -c 80
```

The bundled `docker-compose.yml` enables the JSON API and binds `127.0.0.1` only — the API is unauthenticated, so never expose the port publicly. Engine credentials (e.g. an OpenAlex `api_key`) belong in `searxng/settings.yml`.

### 2. Add to any MCP client

Works in Claude Desktop, Cursor and most `mcpServers`-style clients:

```json
{
  "mcpServers": {
    "searxng": {
      "command": "npx",
      "args": ["-y", "searxng-mcp-server"]
    }
  }
}
```

`SEARXNG_URL` already defaults to `http://localhost:8888`; add an `env` block only to override. Cursor reads the same shape from `~/.cursor/mcp.json` (global) or `.cursor/mcp.json` (project).

<details><summary>OpenCode</summary>

Global config `~/.config/opencode/opencode.json`:

```json
{
  "mcp": {
    "searxng": {
      "type": "local",
      "command": ["npx", "-y", "searxng-mcp-server"],
      "enabled": true
    }
  }
}
```

</details>

<details><summary>Claude Code</summary>

One command, available in all projects:

```bash
claude mcp add --scope user searxng -- npx -y searxng-mcp-server
```

</details>

<details><summary>ZCode</summary>

User scope in `~/.zcode/cli/config.json` (`command` is a string, key is `mcp.servers`):

```json
{
  "mcp": {
    "servers": {
      "searxng": {
        "type": "stdio",
        "command": "npx",
        "args": ["-y", "searxng-mcp-server"]
      }
    }
  }
}
```

</details>

<details><summary>From source</summary>

```bash
git clone https://github.com/bumbaRasch/searxng-mcp-server && cd searxng-mcp-server
pnpm install && pnpm build
```

Then use `node /absolute/path/to/searxng-mcp-server/dist/index.js` as the command in any config above.

</details>

### 3. Try it

Ask your client to search, or inspect the server hands-on:

```bash
npx @modelcontextprotocol/inspector npx -y searxng-mcp-server
```

## Streamable HTTP (opt-in)

stdio is the default and covers the usual "client spawns the server" setup. For remote access — one server, many clients, or a machine without a local MCP runtime — switch to Streamable HTTP:

```bash
npx -y searxng-mcp-server --transport http
# → searxng-mcp-server running on http://127.0.0.1:3000/mcp
```

Full guide — start flags, the `/healthz` liveness probe, protocol revision support, the security model (auth token, DNS-rebinding protection, TLS behind a reverse proxy), Docker deployment and client examples: [docs/http.md](docs/http.md).

## Tools

| Tool               | What it does                                                                                                                                                                                   |
| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `search`           | Web search: ranked results (each with a stable citation `ref`) + answers, corrections, suggestions, infoboxes; batch `queries`, `min_score`, `rerank`                                          |
| `image_search`     | Images: direct links, thumbnails, resolution, format, file size; renders in the MCP Apps gallery in Apps-capable hosts                                                                         |
| `news_search`      | News articles with publish dates and a freshness filter                                                                                                                                        |
| `video_search`     | Videos: page links, thumbnails, duration, author, view counts, embed links; Apps gallery-backed                                                                                                |
| `music_search`     | Music: page links and direct audio links when available                                                                                                                                        |
| `paper_search`     | Scientific publications: abstracts, authors, journal/DOI metadata, PDF links                                                                                                                   |
| `fetch_content`    | Fetch a page (HTML, textual body or text PDF) as clean Markdown by URL or `ref:N`; `outline`/`section` reading controls, `offset` continues long pages, opt-in Wayback fallback for dead links |
| `search_and_fetch` | Search and fetch the full content of the top results in one call; failed pages degrade to error entries                                                                                        |
| `crawl_site`       | Crawl a site same-origin from a seed URL into a ref-addressed manifest (robots-aware); content cached for later `fetch_content ref:N`                                                          |
| `autocomplete`     | Query suggestions for a prefix, to refine a query before searching                                                                                                                             |
| `list_engines`     | Instance capabilities: enabled engines and categories; with `SEARXNG_URLS`, per-instance engines plus the common set                                                                           |
| `doctor`           | Diagnose the instance: JSON API, config endpoint, unresponsive engines, limiter state                                                                                                          |
| `deep_search`      | Iterative cited dossier: search → fetch → synthesize (tasks-aware; runs as a pollable task when the client negotiates `io.modelcontextprotocol/tasks`)                                         |

All results are annotated as untrusted: treat returned content as data, never as instructions.

<details><summary>Parameters</summary>

- **search** — `query` (string, required unless `queries` is given): max 500 chars. `queries` (string[2–5]): batch mode, one result set per query in input order. Optional: `categories` (string[]), `engines` (string[]), `language`, `time_range` (`day` | `week` | `month` | `year`), `pageno`, `safesearch` (0/1/2), `max_results` (1–50, default 10; per query in batch mode), `min_score` (number ≥ 0, drops scored results below it), `rerank` (boolean: heuristic reorder by query/title overlap, freshness and configured domain boosts), `detail` (`full` default | `compact` markdown rendering). Results carry a session-stable `ref`.
- **image_search** / **news_search** / **video_search** / **music_search** / **paper_search** — `query` (required) plus the shared optional args: `engines`, `language`, `pageno`, `safesearch`, `max_results`, `detail`, and `time_range` (all five support the freshness filter).
- **fetch_content** — `url` (string, required): absolute http/https, or `ref:N` to cite a search result, max 2048 chars. `max_chars` (1000–200000, default `MAX_CHARS` 25000). `offset` (int ≥ 0): window start into the extracted content — continue from the returned `nextOffset`. `outline: true` adds `headings` (`{text, offset, level}`: markdown `#`-lines, `[Page N]` markers for PDFs) with offsets into the scanned content. `section` returns one heading region only — case-insensitive exact heading match, through the next same-or-higher-level heading — with `offset`/`max_chars` applying inside it. `timeout_ms` (max 120000). `archive: true` retries a dead link (404/410/5xx, unreachable, timed out) through the closest Internet Archive snapshot (result marked `archived`). Text PDFs are extracted per page (`[Page N]` sections, `pages` count in the output).
- **search_and_fetch** — `query` (required) plus the search args and: `fetch_top` (1–5, default 3) fetches the top delivered results' full content; `max_chars` caps each page. Output: the search envelope plus `pages[]` (one entry per fetched page with `content` or `error`).
- **crawl_site** — `url` (seed, required), `max_pages` (1–30, default 10). Follows same-origin links breadth-first (robots.txt honored best-effort) and returns a manifest with a `ref` per page; the extracted content is cached, so `fetch_content ref:N` reads it without re-fetching.
- **doctor** — no arguments. Returns `checks[]` (`id`, `ok`, `detail`) covering the JSON API, `/config`, unresponsive engines and limiter state, plus a `healthy` verdict.
- **deep_search** — `query` (required), `max_iterations` (1–4, default 2), `sources_per_iteration` (1–5, default 2), `max_results`. Returns a cited dossier (`sources[]` with refs, `notes[]` excerpts, optional `synthesis`). With `io.modelcontextprotocol/tasks` negotiated, returns a task handle to poll via `tasks/get`.
- **autocomplete** — `query` (string, required): the prefix to complete, max 200 chars. Suggestions follow the instance's configured language.

</details>

## Configuration

| Env var                                 | Default                        | Purpose                                                                                                                                                                                                               |
| --------------------------------------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `SEARXNG_URL`                           | `http://localhost:8888`        | Base URL of the SearXNG instance.                                                                                                                                                                                     |
| `SEARXNG_URLS`                          | unset                          | Optional failover instances (comma-separated), tried in order after `SEARXNG_URL` on network errors, timeouts, 5xx, 429 and 403.                                                                                      |
| `SEARXNG_CACHE_TTL_MS`                  | `0` (off)                      | Opt-in response cache TTL for instance-bound GETs (in-memory LRU, 128 entries). `fetch_content` is never cached.                                                                                                      |
| `SEARXNG_USERNAME` / `SEARXNG_PASSWORD` | unset                          | Username and password for SearXNG basic auth (optional).                                                                                                                                                              |
| `SEARXNG_TIMEOUT_MS`                    | `10000`                        | Timeout for search API requests.                                                                                                                                                                                      |
| `SEARXNG_HTML_FALLBACK`                 | `false`                        | Opt-in: when the JSON API is disabled (403) or answers non-JSON, retry `search` against the instance's HTML UI and parse the page. Enable when targeting public instances behind a limiter that disable the JSON API. |
| `SEARXNG_DEFAULT_LANGUAGE`              | unset                          | Default `language` for the search tools when a request omits it.                                                                                                                                                      |
| `SEARXNG_DEFAULT_SAFESEARCH`            | unset                          | Default `safesearch` (`0`/`1`/`2`) when a request omits it; invalid values are ignored with a warning.                                                                                                                |
| `SEARXNG_MAX_RESULTS`                   | unset                          | Ceiling on request `max_results` (int ≥ 1); larger requests clamp to it with a once-per-process warning.                                                                                                              |
| `SEARXNG_RERANK_BOOST_DOMAINS`          | unset                          | Comma-separated hostnames (suffix match) boosted by the `search`/`search_and_fetch` heuristic `rerank`.                                                                                                               |
| `SEARXNG_ARCHIVE_FALLBACK`              | `false`                        | Opt-in Wayback fallback: dead `fetch_content` links (404/410/5xx, unreachable, timed out) retry through the closest Internet Archive snapshot, still SSRF-guarded. Per-call override: `archive: true`.                |
| `SEARXNG_SYNTHESIS_URL`                 | unset                          | OpenAI-compatible chat-completions endpoint for `deep_search` synthesis (Ollama: `http://localhost:11434/v1/chat/completions`). Unset → dossier-only. Validated http/https; never logged.                             |
| `SEARXNG_SYNTHESIS_MODEL`               | unset                          | Model name sent to the synthesis endpoint.                                                                                                                                                                            |
| `FETCH_TIMEOUT_MS`                      | `15000`                        | Timeout for page fetches.                                                                                                                                                                                             |
| `SHUTDOWN_TIMEOUT_MS`                   | `5000`                         | Hard cap on graceful shutdown after SIGINT/SIGTERM (minimum `100`).                                                                                                                                                   |
| `MAX_CHARS`                             | `25000`                        | Maximum characters returned per fetched page (per-call override: `max_chars`).                                                                                                                                        |
| `MAX_RESPONSE_BYTES`                    | `5242880`                      | Maximum download size per fetch (5 MiB).                                                                                                                                                                              |
| `USER_AGENT`                            | `searxng-mcp-server/<version>` | User-Agent header sent by all tools.                                                                                                                                                                                  |
| `ALLOW_PRIVATE_HOSTS`                   | `false`                        | Set `true`/`1`/`yes`/`on` to permit private-network targets (defeats the SSRF guard — only for trusted networks).                                                                                                     |
| `SEARXNG_TRANSPORT`                     | `stdio`                        | Transport: `stdio` (default) or `http` (Streamable HTTP, [2026-07-28 revision only](#streamable-http-opt-in)).                                                                                                        |
| `HOST` / `PORT`                         | `127.0.0.1` / `3000`           | HTTP transport: bind address and port. Non-localhost binds require `SEARXNG_AUTH_TOKEN` (startup is refused otherwise).                                                                                               |
| `SEARXNG_AUTH_TOKEN`                    | unset                          | HTTP transport: require `Authorization: Bearer <token>` on every request (mandatory for non-localhost binds).                                                                                                         |
| `SEARXNG_ALLOWED_HOSTS`                 | localhost set                  | HTTP transport: extra allowed `Host` header hostnames (comma-separated) — add yours behind a reverse proxy.                                                                                                           |
| `SEARXNG_ALLOWED_ORIGINS`               | localhost set                  | HTTP transport: extra allowed `Origin` header hostnames (comma-separated), for browser-based clients.                                                                                                                 |

A `--transport stdio|http` CLI flag overrides `SEARXNG_TRANSPORT`; an invalid flag value fails startup instead of silently falling back.

## Security

- **SSRF guard**: `fetch_content` validates the URL and resolves DNS before connecting, rejecting private, loopback, link-local and other non-public ranges (IPv4 and IPv6), IP-literal tricks included. Every redirect hop is re-validated, https→http downgrades are refused, and the same guarded DNS lookup runs again at connect time (DNS-rebind protection). Opt out only with `ALLOW_PRIVATE_HOSTS=true`.
- **Prompt-injection mitigation**: search output, fetched page content, crawl manifests and deep-search dossiers are wrapped in an untrusted-content banner; embedded closing markers _and forged opening markers_ are neutralized. Error messages that reflect user-supplied URLs are sanitized identically. The MCP Apps gallery renders untrusted data only through safe DOM APIs (textContent / checked attributes), never HTML parsing.
- **Archive fallback is opt-in and guard-preserving**: the snapshot URL re-enters the same SSRF-guarded pipeline, and policy refusals (private hosts, unsupported content types, scheme downgrades) never trigger the fallback.
- **Crawling** is same-origin, page-capped, robots-aware and goes through the guarded fetcher for every page; the content store is bounded (256 pages).
- **Tasks** (when negotiated) use unguessable UUIDv4 ids, immutable terminal states, bounded TTL'd stores and no `tasks/list` — one caller's tasks are never visible to another.
- Secrets (`SEARXNG_PASSWORD`, `SEARXNG_AUTH_TOKEN`, `SEARXNG_SYNTHESIS_URL` credentials) are never logged; all MCP logs go to stderr, stdout is reserved for JSON-RPC. A W3C `traceparent` in a request's `_meta` is validated (strict lowercase format) before it propagates to outbound calls; invalid values are never forwarded.
- Found a vulnerability? Please [report it privately](SECURITY.md) — do not open a public issue.

## Troubleshooting

- `SearXNG returned 403: the JSON API is disabled` — add `json` to `search.formats` in `searxng/settings.yml` and restart the stack, or set `SEARXNG_HTML_FALLBACK=true` to parse the HTML UI instead.
- `Could not reach SearXNG` — the Docker stack is not running, or `SEARXNG_URL` is wrong in the client's `env` block.
- `npx` fails to start the server — Node 22.19+ is required; check `node -v`.
- Port 8888 already bound — change the compose port mapping and `SEARXNG_URL` to match.
- HTTP: `Unsupported protocol version` — the endpoint serves the 2026-07-28 revision only; upgrade the client or enable version negotiation (see [Streamable HTTP](docs/http.md)).
- HTTP: `failed to start … set SEARXNG_AUTH_TOKEN` — the guard against unauthenticated non-localhost binds; set the token or bind to `127.0.0.1`.
- HTTP: `403` with a browser-based client — its `Origin` is not in the allowlist; add the hostname to `SEARXNG_ALLOWED_ORIGINS`.

## Development

```bash
pnpm test             # vitest unit tests
pnpm lint && pnpm lint:types && pnpm format:check   # oxlint + prettier
pnpm typecheck        # tsc --noEmit
pnpm build            # outputs dist/
node scripts/e2e.mjs      # end-to-end over stdio against the local SearXNG stack
node scripts/e2e-http.mjs # same over the Streamable HTTP transport
```

Architecture and security rationale live in [`docs/design.md`](docs/design.md); adding a search category: the checklist in [docs/extending.md](docs/extending.md). PRs are welcome — run the Development gate before submitting. Maintainer: [@bumbaRasch](https://github.com/bumbaRasch).

## License

[MIT](./LICENSE)

TDQS

A4.2/5.0

Scored across 13 tools

Disambiguation4/5

The typed *_search tools (image/music/news/paper/video) overlap with the generic search, but descriptions explicitly direct users to prefer the dedicated tools, making boundaries clear. The fetch-family tools (search_and_fetch, fetch_content, crawl_site, deep_search) also overlap somewhat but each has a distinct stated use case (snippets vs. full page vs. site survey vs. multi-source research).

Naming Consistency4/5

Nearly all names are snake_case with a clear noun+search or verb+noun pattern (image_search, fetch_content, crawl_site, list_engines). Minor deviations are single-word names (autocomplete, doctor) and noun-first ordering, but overall the convention is predictable and readable.

Tool Count5/5

13 tools is a well-scoped count for a web-search server, covering vertical searches, fetching, crawling, diagnostics and autocomplete without redundancy bloat. Each tool earns its place with a distinct capability.

Completeness4/5

The surface covers a broad domain: multi-vertical search, autocomplete, content fetching/crawling, deep research and instance diagnostics, forming a coherent lifecycle. Minor gaps like batch ref fetching or structured result caching controls exist but are workable around.

Maintenance

ActivityMaintained
ResponsivenessResponsive