Interface: SearxngToolConfig<A>

Defined in: batteries/tools/searxng/index.ts:144

Configuration for createSearxngSearchTool (async) and createSearxngSearchToolSync (sync — artifact narrowed to the sync subset).

Type Parameters

Type Parameter	Default type	Description
A	ArtifactResolver	The ArtifactResolver variant accepted: the full resolver (async factory) or the sync subset (createSearxngSearchToolSync).

Properties

Property	Type	Description	Defined in
artifact?	A	Spool-artifact resolver for the tool's output. Default () => SpooledJsonArtifact. Accepts a constructor, a sync resolver, or — via createSearxngSearchTool — an async / dynamic-import resolver. Pass () => SpooledMarkdownArtifact (paired with an output stage that renders markdown into ctx.output) or () => SpooledArtifact for plain text.	batteries/tools/searxng/index.ts:166
description?	string	Tool description override.	batteries/tools/searxng/index.ts:159
headers?	| SearxngHeadersResolver | SearxngHeaders	Custom request headers — a static object or a (sync/async) resolver for refreshable auth.	batteries/tools/searxng/index.ts:148
inputPipeline?	SearxngInputMiddlewareFn[]	Stages run before the HTTP request. See SearxngRequestContext.	batteries/tools/searxng/index.ts:168
instanceUrl	string	Base URL of the SearXNG instance, e.g. https://searx.example.org. Required.	batteries/tools/searxng/index.ts:146
name?	string	Tool name. Default searxng_search.	batteries/tools/searxng/index.ts:157
outputPipeline?	SearxngOutputMiddlewareFn[]	Stages run after the response is parsed. See SearxngResponseContext.	batteries/tools/searxng/index.ts:170
resultFormat?	SearxngResultFormat	Output shape. normalized/raw pin the shape (the model cannot change it); either (default) exposes a format argument so the model chooses per call.	batteries/tools/searxng/index.ts:155
timeout?	number	Request timeout in milliseconds. Default 10_000.	batteries/tools/searxng/index.ts:150