Files
OmniRoute/docs/frameworks/SEARCH_TOOLS_STUDIO.md
Diego Rodrigues de Sa e Souza 5ac4637816 docs: reorganize docs/ + accuracy audit + drop Node 20 (rebased onto current release tip) (#5262)
* docs: move superpowers/research artifacts to isolated _tasks repo + docs tree cleanup

- Move docs/superpowers/{plans,specs} and docs/research/* into the gitignored,
  separately-versioned _tasks/ repo; untrack the two tracked research design docs.
- Add CLAUDE.md "Planning & Research Artifacts" section overriding the superpowers
  default save paths (docs/... -> _tasks/...); align REPOSITORY_MAP and
  DOCUMENTATION_OVERHAUL_PLAN with the new convention.
- Drop 4 now-obsolete /api/discovery/* entries from check-docs-symbols allowlist
  (stale-enforcement) and refresh code/spec path comments to _tasks/...
- Sweeps in concurrent docs-tree restructuring (root-level provider/guide docs,
  compression spec cleanup, .mcp.json.example removal).

* docs: reorganize docs/ tree + fix stale facts across ~26 docs

Phase A — reorganization:
- Move 7 orphan root docs into subfolders (providers/ created; TIERS+USAGE_QUOTA→guides/;
  plugins+PLUGIN_SDK→frameworks/); delete 8 obsolete/redundant docs (SUBMIT_PR superseded
  by CONTRIBUTING; DOCUMENTATION_OVERHAUL_PLAN; INCIDENT_RESPONSE/PERF_BUDGETS/THREAT_MODEL;
  3 ops snapshots). Rebuild README index (was missing ~40 files) + per-folder meta.json nav.
- Clean 14 dangling doc-path references in bin/ ops scripts, scripts/, workflow, tests;
  fix the dockerignore-docs-coverage required-docs path (PROVIDERS→providers/CLAUDE_WEB).

Phase B — content accuracy (verified against code, not the audit summary):
- Functional: ENVIRONMENT flag defaults (INPUT_SANITIZER/MCP_ENFORCE_SCOPES=true,
  COMPRESS_DESCRIPTIONS=false, dynamic heap); MCP-SERVER notion tool names (omniroute_*→
  notion_*) + counts 87→94; coverage gate 75/70→60/60/60/60 (RELEASE_CHECKLIST, COVERAGE_PLAN,
  ERROR_SANITIZATION, CONTRIBUTING); pre-push hook description; regenerate PROVIDER_REFERENCE (237).
- Count drift: providers 237, executors 70, migrations 106, db modules 94, oauth 19,
  strategies 17, MCP 94, flags 38, TS 6.0, open-sse ~900/services 294 across architecture/
  frameworks/ops docs; AUTO-COMBO 9→12 factors w/ correct DEFAULT_WEIGHTS; REASONING +2
  patterns; STEALTH UA defaults; AGENT_PROTOCOLS +cursor-cloud/list-capabilities;
  LANGUAGE_PACKS +id pack.
- Kept Node 20 (runtime guard accepts 20.20.2+; only engines is stricter) and MCP scopes=13
  (mcpScopes.ts) — both were correct in the docs; corrected only the attribution.

* docs: finish content refresh — compression engines, CLI_TOKEN merge, metadata sweep

- Compression: document the additional built-in engines (CCR, headroom, ionizer,
  session-dedup) in COMPRESSION_ENGINES; clarify LLMLingua-2 is the ultra-mode SLM
  backend + cross-ref the extra engines in EXTENDING_COMPRESSION; add the id
  (Indonesian) language pack to LANGUAGE_PACKS.
- AUTO-COMBO: replace the orphan 'How tiers fit' weight table (stale weights) with a
  pointer to the canonical 12-factor DEFAULT_WEIGHTS table.
- Security: merge CLI_TOKEN_AUTH.md (legacy 32-char SHA-256 format) into CLI_TOKEN.md
  as a 'Legacy format — still accepted' section (server accepts both HMAC + legacy),
  delete CLI_TOKEN_AUTH.md, drop it from the index + security nav.
- Metadata: bump stale frontmatter (version/lastUpdated) to 3.8.40/2026-06-28 across the
  doc set audited this pass, and normalize the in-body 'Last updated' header lines to match.

* fix(runtime): drop Node 20 from supported range + align all docs/diagrams/counts

- Node minimum is now 22 (aligned with package.json engines). SUPPORTED_NODE_RANGE in
  src/shared/utils/nodeRuntimeSupport.ts (and the bin/ mirror) drops the 20.x line →
  '>=22.22.2 <23 || >=24.0.0 <27'; getNodeRuntimeSupport now rejects Node 20 as
  unsupported-major. Test updated (TDD): node-runtime-support.test.ts asserts Node 20
  rejected. Docs aligned (TROUBLESHOOTING ×2, TERMUX, RELEASE_CHECKLIST, CODEBASE,
  CLI-TOOLS, README, llm.txt + 42 i18n llm.txt mirrors, skills/cli-serve).
- Diagrams regenerated: mcp-tools-87 -> mcp-tools-94 (34 base + pool 6 = 94) and
  auto-combo-9factor -> auto-combo-12factor (correct DEFAULT_WEIGHTS); SVGs re-rendered
  via mermaid-cli; doc refs + diagrams/README updated; fixed a pre-existing broken
  resilience-3layers image path.
- CLAUDE.md + AGENTS.md aligned to real counts (237 providers, 94 MCP tools / 34 base,
  106 migrations, 94 db modules, 12-factor auto-combo, 17 strategies); README provider
  count 231 -> 237; executor count corrected to 68 (provider executors, excl base/index)
  and OAuth to 18 across architecture docs. check:docs-all now passes (0 strict drift,
  0 broken links); removed dead .mcp.json.example doc link.

* fix(services): update installer Node hint to >=22.22.2 (aligned with dropped Node 20)

* docs: realign counts to current release tip after rebase

The release tip advanced while this work was in flight (Gemini CLI provider/executor
removed by #5246, plus other PRs). Re-counted against the current code and updated:
providers 237->236, executors 68->67, OAuth modules 18->17, open-sse services 294->298;
regenerated PROVIDER_REFERENCE.md (236). check:docs-all passes (0 strict drift).

* docs(changelog) + i18n: record Node 20 drop + fix nodeIncompatibleHint

- CHANGELOG: add [3.8.40] entries for the Node 20.x removal (runtime) and the docs
  reorganization/accuracy audit.
- i18n: nodeIncompatibleHint across all 42 locales no longer lists Node 20.x as
  supported (ASCII + CJK full-width variants), aligned with the dropped Node 20.

* fix(docs): repair CI breakages from the doc moves

- test: cli-plugin-system asserted docs/dev/plugins.md exists; the file moved to
  docs/frameworks/PLUGINS.md — point the test at the new path (Unit fast-path 2/2 fix).
- frontmatter: PLUGINS.md and PLUGIN_SDK.md moved into the fumadocs-indexed
  docs/frameworks/ which requires a 'title' frontmatter; the missing frontmatter
  failed the Next.js MDX build (dast-smoke 'invalid frontmatter'). Added frontmatter
  to both, plus the providers/ docs (consistency; that folder is not indexed).
2026-06-28 22:07:18 -03:00

10 KiB
Raw Blame History

title, version, lastUpdated
title version lastUpdated
Search Tools Studio 3.8.40 2026-06-28

Search Tools Studio

Feature: Search Tools Studio — unified web tools workspace for /dashboard/search-tools. Plans: 18-search-tools-studio-redesign.plan.md + _orchestration/master-plan-group-C.md Status: Released in v3.8.6


Overview

Search Tools Studio transforms /dashboard/search-tools from a basic search playground into a three-tab Studio unifying web search, web scraping, and side-by-side provider comparison.

┌ Search Tools ──────────────────────────────────────────────────────────┐
│ [🔍 Search] [📄 Scrape] [⚖ Compare]             142ms · $0.001  </>    │
│ ⓘ [Modalities guide]                                                    │
├──────────────────────────────────────────┬─────────────────────────────┤
│  {active tab content}                    │ ─ Config                    │
│                                          │ Provider [auto ]           │
│                                          │   🟢 Serper  $0.001         │
│                                          │   🟢 Tavily  $0.008         │
│                                          │   🔥 Firecrawl (fetch)      │
│                                          │ Type   [web | news]         │
│                                          │ Full page [ ] (scrape)      │
│                                          │ Format [md|text|html]       │
│                                          │ Rerank model []            │
└──────────────────────────────────────────┴─────────────────────────────┘

Tabs

Search Tab

Evolves the existing SearchForm + ResultsPanel + RerankPanel into a tab:

  • Query → results (title, URL, snippet, relevance score).
  • Provider metadata in Config pane (cost, quota, status).
  • Rerank section: pick a rerank model, reorder results, show positionDelta.
  • Empty state with CTA when no search providers are configured.
  • Search history via SearchHistory.tsx.
  • Calls POST /v1/search (existing endpoint, no changes).

Scrape Tab

New tab for extracting content from a URL via POST /v1/web/fetch (created in plan 05):

  • Input: URL + full-page toggle + format selector (markdown / text / HTML).
  • Submit → fetch → render ScrapeResult.tsx.
  • ScrapeResult renders markdown preview + raw toggle.
  • Cap: if response body > 256 KB, UI shows (truncated, view raw) and opens raw in a Monaco modal (D21).
  • Metadata panel: provider (firecrawl/jina-reader/tavily-search), latency, cost, response size, links count.
  • Uses useScrapeFetch.ts hook.

Compare Tab

Runs the same query/URL across up to 4 providers in parallel (D22):

  • Side-by-side columns per provider.
  • Metrics: latency, cost, result count, response size.
  • URL overlap calculation for search (number of shared URLs vs initial result).
  • Calls POST /v1/search (search) or POST /v1/web/fetch (scrape) per provider.

Config Pane (Shared)

SearchToolsConfigPane.tsx — always visible, collapsible.

Field Notes
Provider Dropdown with status badge (configured / missing / rate limited)
Type web or news (search only)
Full page Toggle for scrape — fetches entire page vs first visible content
Format markdown, text, or html (scrape only)
Rerank model Optional model for post-search reranking
History Collapsible search history section

SearchConceptCard

SearchConceptCard.tsx — always visible, collapsible accordion. Explains:

Concept One-liner
Search Fetches a list of web results (title, URL, snippet, relevance score)
Scrape Extracts the full content of a URL (markdown, text or HTML)
Compare Runs the same query in N providers side-by-side
Rerank Reorders results via LLM to improve query relevance
Auto (cheapest) Picks the cheapest available provider automatically

Provider Catalog

ProviderCatalog.tsx exposes the full provider list from GET /api/search/providers (extended in F4 to include fetch providers):

Field Source
id, name searchRegistry.ts
kind "search" (12 providers) or "fetch" (firecrawl, jina-reader, tavily-search)
costPerQuery Registry data
freeMonthlyQuota Registry data
searchTypes / fetchFormats Registry data
status "configured" / "missing" / "rate_limited" — derived at runtime from credential store
configureHref /dashboard/providers

The status is derived at request time by checking whether credentials exist and whether all keys are currently in cooldown.


Export Code

ExportCodeModal (imported from Playground Studio) + codeExport.ts generate curl / Python / TypeScript snippets for both /v1/search and /v1/web/fetch calls. API key placeholder is always $OMNIROUTE_API_KEY (D11, shared with Playground Studio).


Backend Changes

Only one backend change was needed for this feature:

Extended GET /api/search/providers

src/app/api/search/providers/route.ts was extended to:

  • Include all 3 fetch providers (firecrawl, jina-reader, tavily-search) in the array.
  • Add kind: "search" | "fetch" to every item.
  • Add status: "configured" | "missing" | "rate_limited" derived from live credential state.
  • Maintain backward compatibility — existing fields (id, name, etc.) unchanged.

Key Files

Path Purpose
src/app/(dashboard)/dashboard/search-tools/SearchToolsClient.tsx Studio shell, tab orchestrator
src/app/(dashboard)/dashboard/search-tools/components/SearchToolsTopBar.tsx Tabs + metrics + export button
src/app/(dashboard)/dashboard/search-tools/components/SearchToolsConfigPane.tsx Shared config panel
src/app/(dashboard)/dashboard/search-tools/components/SearchConceptCard.tsx Explainer cards (always visible)
src/app/(dashboard)/dashboard/search-tools/components/ProviderCatalog.tsx Provider list with metadata
src/app/(dashboard)/dashboard/search-tools/components/ScrapeResult.tsx Markdown preview + raw toggle
src/app/(dashboard)/dashboard/search-tools/components/tabs/SearchTab.tsx Search + rerank tab
src/app/(dashboard)/dashboard/search-tools/components/tabs/ScrapeTab.tsx Scrape tab
src/app/(dashboard)/dashboard/search-tools/components/tabs/CompareTab.tsx Multi-provider compare tab
src/app/(dashboard)/dashboard/search-tools/hooks/useScrapeFetch.ts Scrape fetch hook
src/app/api/search/providers/route.ts Extended with kind + status + fetch providers
open-sse/config/searchRegistry.ts Source of truth for search provider metadata

Troubleshooting

Symptom Cause Fix
Scrape tab shows "endpoint not available" /v1/web/fetch not wired Verify plan 05 is merged; check src/app/api/v1/web/fetch/route.ts exists
Provider catalog shows all as "missing" Credentials not configured Add credentials in /dashboard/providers
Scrape content is truncated Response > 256 KB cap Expected behavior (D21). Use "view raw" button for full content
Compare tab only shows 2 providers Rate limit active Two or more providers may be in cooldown — check provider status in Config pane
"Size" shown as raw key in table Missing i18n key Verify search.size exists in the locale file; rebuild i18n

References

  • Master plan: _tasks/features-v3.8.6/refactorpages/_orchestration/master-plan-group-C.md
  • Feature plan: _tasks/features-v3.8.6/refactorpages/18-search-tools-studio-redesign.plan.md
  • Search provider registry: open-sse/config/searchRegistry.ts
  • Playground Studio (shared ExportCodeModal + codeExport.ts): docs/frameworks/PLAYGROUND_STUDIO.md
  • Web fetch backend: src/app/api/v1/web/fetch/route.ts