@brave/brave-search-mcp-server/dist/tools/news/params.js

Brave Search MCP Server: web results, images, videos, rich results, AI summaries, and more.

import { z } from 'zod';
export const params = z.object({
    query: z
        .string()
        .max(400)
        .refine((str) => str.split(/\s+/).length <= 50, 'Query cannot exceed 50 words')
        .describe('Search query (max 400 chars, 50 words)'),
    country: z
        .string()
        .default('US')
        .describe('Search query country, where the results come from. The country string is limited to 2 character country codes of supported countries.')
        .optional(),
    search_lang: z
        .string()
        .default('en')
        .describe('Search language preference. The 2 or more character language code for which the search results are provided.')
        .optional(),
    ui_lang: z
        .string()
        .default('en-US')
        .describe('User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110.')
        .optional(),
    count: z
        .int()
        .min(1)
        .max(50)
        .default(20)
        .describe('Number of results (1-50, default 20)')
        .optional(),
    offset: z
        .int()
        .min(0)
        .max(9)
        .default(0)
        .describe('Pagination offset (max 9, default 0)')
        .optional(),
    spellcheck: z
        .boolean()
        .default(true)
        .describe('Whether to spellcheck provided query.')
        .optional(),
    safesearch: z
        .union([z.literal('off'), z.literal('moderate'), z.literal('strict')])
        .default('moderate')
        .describe("Filters search results for adult content. The following values are supported: 'off' - No filtering. 'moderate' - Filter out explicit content. 'strict' - Filter out explicit and suggestive content. The default value is 'moderate'.")
        .optional(),
    freshness: z
        .union([
        z.enum(['pd', 'pw', 'pm', 'py']),
        z
            .string()
            .regex(/^\d{4}-\d{2}-\d{2}to\d{4}-\d{2}-\d{2}$/, "Use 'pd', 'pw', 'pm', or 'py' for a relative discovery window, or a custom range as YYYY-MM-DDtoYYYY-MM-DD (e.g. 2022-04-01to2022-07-30)."),
    ])
        .describe("Filters search results by when they were discovered. The following values are supported: 'pd' - Discovered within the last 24 hours. 'pw' - Discovered within the last 7 Days. 'pm' - Discovered within the last 31 Days. 'py' - Discovered within the last 365 Days. 'YYYY-MM-DDtoYYYY-MM-DD' - Timeframe is also supported by specifying the date range e.g. 2022-04-01to2022-07-30.")
        .optional(),
    extra_snippets: z
        .boolean()
        .default(false)
        .describe('A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts. Only available under Free AI, Base AI, Pro AI, Base Data, Pro Data and Custom plans.')
        .optional(),
    goggles: z
        .union([z.string(), z.array(z.string())])
        .describe("Goggles act as a custom re-ranking on top of Brave's search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. Multiple goggle URLs and/or definitions can be provided in an array. For more details, refer to the Goggles repository (i.e., https://github.com/brave/goggles-quickstart).")
        .optional(),
});
export default params;