gsc_search_performance
Retrieve Google Search Console search performance data with clicks, impressions, CTR, and position. Filter by query, page, device, or country, and group by multiple dimensions.
Instructions
Query Google Search Console search performance data. Returns clicks, impressions, CTR, and position for a site. Supports filtering by query, page, device, or country and grouping by multiple dimensions.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site_url | No | Site URL in GSC format, e.g. 'sc-domain:example.com' or 'https://example.com/'. Uses config default if omitted. | |
| start_date | Yes | Start date in YYYY-MM-DD format. | |
| end_date | Yes | End date in YYYY-MM-DD format. | |
| dimensions | No | Dimensions to group results by. Default: ['query']. | |
| filter_query | No | Filter results to queries containing this string. | |
| filter_page | No | Filter results to this page URL (exact match). | |
| filter_device | No | Filter results to this device type. | |
| filter_country | No | Filter results to this country (ISO 3166-1 alpha-3, e.g. 'USA'). | |
| row_limit | No | Max rows to return. Default 100, max 25000. |
Implementation Reference
- src/types/tool.ts:12-18 (helper)ToolDefinition type that provides the interface contract for the tool definition, ensuring it has name, description, schema, and handler.
export interface ToolDefinition<T extends AnyZodObject = AnyZodObject> { name: string; description: string; schema: T; handler: (args: z.infer<T>, config: Config) => Promise<ToolResult>; }