Skip to content

docs(search): document SearXNG setup#2435

Open
aqilaziz wants to merge 2 commits into
tinyhumansai:mainfrom
aqilaziz:codex/1842-searxng-docs
Open

docs(search): document SearXNG setup#2435
aqilaziz wants to merge 2 commits into
tinyhumansai:mainfrom
aqilaziz:codex/1842-searxng-docs

Conversation

@aqilaziz
Copy link
Copy Markdown
Contributor

@aqilaziz aqilaziz commented May 21, 2026

Summary

  • Documented the optional searxng_search tool on the user-facing Web Search page.
  • Added config.toml and environment examples for enabling self-hosted SearXNG search.
  • Updated the native tools index and privacy page so web search no longer reads as backend-only.

Problem

Issue #1842 asks for SearXNG as a native tool. The implementation is already present on main, but the feature docs still describe only the managed web-search proxy. Users running a private SearXNG instance would not know how to enable or call the existing tool from the feature docs.

Solution

  • Adds a Self-hosted SearXNG section to gitbooks/features/native-tools/web-search.md.
  • Links the feature page to the MCP server docs where searxng_search is listed for MCP clients.
  • Clarifies privacy routing: default search uses the backend proxy; SearXNG queries go to the configured user-owned instance when that optional tool is called.

Submission Checklist

  • Tests added or updated: N/A, docs-only change.
  • Diff coverage >= 80%: N/A, no executable code changed.
  • Coverage matrix updated: N/A, documentation-only change.
  • All affected feature IDs from the matrix are listed in the PR description: N/A.
  • No new external network dependencies introduced.
  • Manual smoke checklist updated: N/A, no release-cut behavior changed.
  • Linked issue closed via Closes #NNN: N/A, this documents existing Feature Request : SearXNG as a native MCP tool integration for private, self-hosted web search #1842 implementation but does not itself add the runtime feature.

Impact

No runtime behavior changes. Users and MCP clients get a discoverable setup path for the existing self-hosted SearXNG search tool.

Related


AI Authored PR Metadata (required for Codex/Linear PRs)

Linear Issue

  • Key: N/A
  • URL: N/A

Commit & Branch

  • Branch: codex/1842-searxng-docs
  • Commit SHA: 7eadfb6ddf0584b90b825874a3e85e0e679ea8fd

Validation Run

  • git diff --check
  • rg -n "SearXNG|searxng_search|OPENHUMAN_SEARXNG|MCP Server" gitbooks/features/native-tools/web-search.md gitbooks/features/native-tools/README.md gitbooks/features/privacy-and-security.md
  • pnpm --filter openhuman-app format:check: N/A, docs-only change; not run in this isolated worktree.
  • pnpm typecheck: N/A, docs-only change.
  • Focused tests: N/A, docs-only change.
  • Rust fmt/check (if changed): N/A, no Rust changed.
  • Tauri fmt/check (if changed): N/A, no Tauri changed.

Validation Blocked

  • command: N/A
  • error: N/A
  • impact: N/A

Behavior Changes

  • Intended behavior change: N/A, documentation only.
  • User-visible effect: Web Search docs now show how to enable and use the existing SearXNG path.

Parity Contract

  • Legacy behavior preserved: Yes, no runtime code changed.
  • Guard/fallback/dispatch parity checks: N/A.

Duplicate / Superseded PR Handling

  • Duplicate PR(s): None found.
  • Canonical PR: This PR.
  • Resolution (closed/superseded/updated): N/A.

Summary by CodeRabbit

  • Documentation
    • Expanded Web Search docs with guidance for an optional self-hosted SearXNG setup
    • Clarified that Web Search uses the managed backend proxy by default, with an opt-in self-hosted path
    • Updated tool descriptions and privacy/security guidance to reflect default proxy behavior
    • Documented per-call input constraints, structured error handling, and response behavior

Review Change Stack

@aqilaziz aqilaziz requested a review from a team May 21, 2026 10:01
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 21, 2026

📝 Walkthrough

Walkthrough

Documentation adds an optional self-hosted SearXNG path for native Web Search, expands the web-search feature doc with registration, endpoint, configuration and error behavior details, and updates the native-tools index and privacy/security pages to clarify managed proxy default vs optional SearXNG routing.

Changes

Self-hosted SearXNG Web Search Documentation

Layer / File(s) Summary
Web Search feature documentation with SearXNG option
gitbooks/features/native-tools/web-search.md
The introduction clarifies managed proxy and optional self-hosted SearXNG paths. A new "Self-hosted SearXNG" section documents searxng_search registration, the /search?format=json endpoint/result shape, configuration examples for config.toml and environment variables, per-call input constraints, and error handling for invalid inputs, unsupported categories, non-2xx responses, and timeouts. The "See also" section references MCP Server documentation for searxng_search.
Feature index and security documentation updates
gitbooks/features/native-tools/README.md, gitbooks/features/privacy-and-security.md
The native tools index entry for Web Search is updated to indicate live web search via the managed proxy or an optional self-hosted SearXNG. The privacy/security doc clarifies the native web search tool uses the backend proxy by default while the optional SearXNG tool routes queries to a configured SearXNG instance.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 I hopped through docs to tweak a line,
SearXNG and proxy now both align,
Configs and endpoints set just right,
Search can be managed or self-hosted tonight,
Cheers from a rabbit, nibbling docs by moonlight.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs(search): document SearXNG setup' is specific and directly related to the main change—adding user-facing documentation for the optional self-hosted SearXNG search tool configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@gitbooks/features/native-tools/README.md`:
- Line 28: Update the statement that all network tools route through the
OpenHuman proxy to qualify it as the default behavior (e.g., add "by default" or
"unless self-hosted/opted-out") so it no longer contradicts the optional
self-hosted SearXNG mention; adjust the sentence near the network-tools
description that currently implies unconditional proxying (referenced alongside
the "Web Search" table row) to explicitly say the proxy is used by default and
note the self-host/opt-out option.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7da08c44-1763-435d-b441-645ad6b55fd5

📥 Commits

Reviewing files that changed from the base of the PR and between bf6f25e and 7bb2fb9.

📒 Files selected for processing (3)
  • gitbooks/features/native-tools/README.md
  • gitbooks/features/native-tools/web-search.md
  • gitbooks/features/privacy-and-security.md

Comment thread gitbooks/features/native-tools/README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature Request : SearXNG as a native MCP tool integration for private, self-hosted web search

1 participant