API: tools/search

better-web-search-mcp

better-web-search-mcp / tools/search

tools/search#

Interfaces#

SearchResponse#

Defined in: src/tools/search.ts:35

The spec-shaped web_search response.

Properties#

Property	Type	Defined in
`answer`	`string`	src/tools/search.ts:36
`queries_used`	`string`[]	src/tools/search.ts:38
`sources`	`SearchSource`[]	src/tools/search.ts:37

SearchSource#

Defined in: src/tools/search.ts:26

The spec-shaped source entry returned for each result.

Properties#

Property	Type	Defined in
`published?`	`string`	src/tools/search.ts:30
`relevance`	`number`	src/tools/search.ts:31
`snippet`	`string`	src/tools/search.ts:29
`title`	`string`	src/tools/search.ts:27
`url`	`string`	src/tools/search.ts:28

Variables#

searchInputSchema#

const searchInputSchema: { max_results: ZodDefault<ZodNumber>; query: ZodString; recency_days: ZodOptional<ZodNumber>; }

Defined in: src/tools/search.ts:19

Input schema for web_search.

Type Declaration#

Name	Type	Defined in
`max_results`	`ZodDefault`<`ZodNumber`>	src/tools/search.ts:21
`query`	`ZodString`	src/tools/search.ts:20
`recency_days`	`ZodOptional`<`ZodNumber`>	src/tools/search.ts:22

Functions#

registerSearch()#

registerSearch(server, cache?): void

Defined in: src/tools/search.ts:101

Register the web_search tool on the given MCP server.

Parameters#

Parameter	Type
`server`	`McpServer`
`cache?`	`Cache`

Returns#

void

runSearch()#

runSearch(args): Promise<SearchResponse>

Defined in: src/tools/search.ts:58

Run a web_search and return the spec-shaped response.

Exported separately from the registration so tests and the smoke harness can call the handler logic directly.

Parameters#

Parameter	Type
`args`	{ `cache?`: `Cache`; `max_results?`: `number`; `query`: `string`; `recency_days?`: `number`; }
`args.cache?`	`Cache`
`args.max_results?`	`number`
`args.query`	`string`
`args.recency_days?`	`number`

Returns#

Promise<SearchResponse>