@disruptorganic/mcp-google-search-console 1.0.0

package/dist/tools/query-advanced.js

@@ -0,0 +1,378 @@
+import { listProperties, matchProperty, generatePropertyMatchError } from '../gsc/properties.js';
+import { queryAdvancedParamsSchema } from '../utils/validators.js';
+import { chunkResults } from '../utils/token-estimator.js';
+import { logger } from '../utils/logger.js';
+export const queryAdvancedTool = {
+    name: 'query_advanced',
+    description: 'Performs multi-dimensional custom queries with up to 3 dimensions (e.g., query + device + country) and flexible filtering. Use for complex analysis not covered by specialized tools. Supports all GSC dimensions and metrics with sorting and aggregation options. Automatically chunks results to stay under token limits. IMPORTANT: Use list_properties first to get the correct property identifier.',
+    inputSchema: {
+        type: 'object',
+        properties: {
+            property: {
+                type: 'string',
+                description: 'Property identifier from list_properties (e.g., "sc-domain:example.com")',
+            },
+            startDate: {
+                type: 'string',
+                description: 'Start date in ISO 8601 format (YYYY-MM-DD)',
+                pattern: '^\\d{4}-\\d{2}-\\d{2}$',
+            },
+            endDate: {
+                type: 'string',
+                description: 'End date in ISO 8601 format (YYYY-MM-DD)',
+                pattern: '^\\d{4}-\\d{2}-\\d{2}$',
+            },
+            dimensions: {
+                type: 'array',
+                items: {
+                    type: 'string',
+                    enum: ['query', 'page', 'country', 'device', 'searchAppearance', 'date'],
+                },
+                description: 'Array of 1-3 dimensions to group results by',
+                minItems: 1,
+                maxItems: 3,
+            },
+            filters: {
+                type: 'array',
+                items: {
+                    type: 'object',
+                    properties: {
+                        dimension: {
+                            type: 'string',
+                            enum: ['query', 'page', 'country', 'device', 'searchAppearance', 'date'],
+                        },
+                        operator: {
+                            type: 'string',
+                            enum: ['equals', 'notEquals', 'contains', 'notContains', 'includingRegex', 'excludingRegex'],
+                        },
+                        expression: {
+                            type: 'string',
+                        },
+                    },
+                    required: ['dimension', 'operator', 'expression'],
+                },
+                description: 'Optional array of filters to apply',
+            },
+            searchType: {
+                type: 'string',
+                enum: ['web', 'image', 'video', 'news', 'discover', 'googleNews'],
+                description: 'Search type filter (default: web)',
+                default: 'web',
+            },
+            rowLimit: {
+                type: 'number',
+                description: 'Maximum rows to retrieve (1-25000, default: 25000)',
+                minimum: 1,
+                maximum: 25000,
+                default: 25000,
+            },
+            sortBy: {
+                type: 'string',
+                enum: ['clicks', 'impressions', 'ctr', 'position'],
+                description: 'Metric to sort by (default: clicks)',
+                default: 'clicks',
+            },
+            sortOrder: {
+                type: 'string',
+                enum: ['asc', 'desc'],
+                description: 'Sort order (default: desc)',
+                default: 'desc',
+            },
+            offset: {
+                type: 'number',
+                description: 'Pagination offset (default: 0)',
+                default: 0,
+                minimum: 0,
+            },
+            limit: {
+                type: 'number',
+                description: 'Results per chunk - auto-calculated if not provided',
+                minimum: 1,
+                maximum: 25000,
+            },
+        },
+        required: ['property', 'startDate', 'endDate', 'dimensions'],
+    },
+};
+function transformOperator(mcpOperator) {
+    const operatorMap = {
+        'equals': 'EQUALS',
+        'notEquals': 'NOT_EQUALS',
+        'contains': 'CONTAINS',
+        'notContains': 'NOT_CONTAINS',
+        'includingRegex': 'INCLUDING_REGEX',
+        'excludingRegex': 'EXCLUDING_REGEX',
+    };
+    const result = operatorMap[mcpOperator];
+    if (!result) {
+        logger.warn('Unknown filter operator, using as-is', { mcpOperator });
+        return mcpOperator.toUpperCase();
+    }
+    return result;
+}
+function transformFiltersToGSCFormat(filters) {
+    if (!filters || filters.length === 0) {
+        return undefined;
+    }
+    return {
+        filters: filters.map(filter => ({
+            dimension: filter.dimension,
+            operator: transformOperator(filter.operator),
+            expression: filter.expression,
+        })),
+    };
+}
+function transformRowToMCPFormat(row, dimensions) {
+    const result = {
+        clicks: 0,
+        impressions: 0,
+        ctr: 0,
+        position: 0,
+    };
+    if (row.keys && Array.isArray(row.keys)) {
+        row.keys.forEach((key, index) => {
+            const dimension = dimensions[index];
+            if (dimension) {
+                result[dimension] = key;
+            }
+        });
+    }
+    result.clicks = row.clicks || 0;
+    result.impressions = row.impressions || 0;
+    result.ctr = row.ctr || 0;
+    result.position = row.position || 0;
+    return result;
+}
+function sortResults(results, sortBy, sortOrder) {
+    results.sort((a, b) => {
+        const aVal = a[sortBy];
+        const bVal = b[sortBy];
+        if (aVal === undefined || aVal === null)
+            return 1;
+        if (bVal === undefined || bVal === null)
+            return -1;
+        const direction = sortOrder === 'asc' ? 1 : -1;
+        return direction * (aVal - bVal);
+    });
+}
+export async function handleQueryAdvanced(params, client) {
+    try {
+        logger.info('Handling query_advanced request', {
+            propertyInput: params.property,
+            dimensions: params.dimensions,
+            filterCount: params.filters?.length || 0,
+            dateRange: params.startDate && params.endDate ? `${params.startDate} to ${params.endDate}` : 'not provided',
+        });
+        const validationResult = queryAdvancedParamsSchema.safeParse(params);
+        if (!validationResult.success) {
+            const errorMessages = validationResult.error.issues.map(issue => {
+                const path = issue.path.length > 0 ? `${issue.path.join('.')}: ` : '';
+                return `${path}${issue.message}`;
+            }).join('; ');
+            logger.error('Input validation failed', {
+                errors: errorMessages,
+                params,
+            });
+            return {
+                content: [{
+                        type: 'text',
+                        text: JSON.stringify({
+                            error: 'Input validation failed',
+                            details: errorMessages,
+                        }, null, 2),
+                    }],
+                isError: true,
+            };
+        }
+        const validated = validationResult.data;
+        const { property, startDate, endDate, dimensions, filters, searchType = 'web', rowLimit = 25000, sortBy = 'clicks', sortOrder = 'desc', offset = 0, limit, } = validated;
+        logger.debug('Fetching available properties');
+        const availableProperties = await listProperties(client);
+        if (availableProperties.length === 0) {
+            logger.warn('No properties found for this account');
+            return {
+                content: [{
+                        type: 'text',
+                        text: JSON.stringify({
+                            error: 'No properties found',
+                            details: 'No Google Search Console properties are accessible with this account. Please verify your account has access to at least one property.',
+                        }, null, 2),
+                    }],
+                isError: true,
+            };
+        }
+        const matchResult = matchProperty(property, availableProperties);
+        if (!matchResult.matched) {
+            const errorMessage = generatePropertyMatchError(matchResult, availableProperties);
+            logger.error('Property matching failed', {
+                searchInput: property,
+                matchType: matchResult.matchType,
+                alternativeCount: matchResult.alternatives?.length || 0,
+            });
+            return {
+                content: [{
+                        type: 'text',
+                        text: JSON.stringify({
+                            error: 'Property not found or ambiguous',
+                            details: errorMessage,
+                        }, null, 2),
+                    }],
+                isError: true,
+            };
+        }
+        const matchedProperty = matchResult.matched;
+        logger.info('Property matched successfully', {
+            searchInput: property,
+            matched: matchedProperty.propertyUrl,
+            matchType: matchResult.matchType,
+        });
+        const request = {
+            startDate,
+            endDate,
+            dimensions,
+            type: searchType,
+            dataState: 'final',
+            rowLimit: Math.min(rowLimit, 25000),
+            startRow: 0,
+        };
+        if (filters && filters.length > 0) {
+            const transformedFilters = transformFiltersToGSCFormat(filters);
+            if (transformedFilters) {
+                request.dimensionFilterGroups = [transformedFilters];
+            }
+        }
+        logger.debug('GSC API request prepared', {
+            dimensions: request.dimensions,
+            filters: request.dimensionFilterGroups?.length || 0,
+            searchType: request.type,
+            rowLimit: request.rowLimit,
+        });
+        logger.info('Executing advanced query', {
+            property: matchedProperty.propertyUrl,
+            dimensions,
+            dateRange: `${startDate} to ${endDate}`,
+        });
+        const response = await client.query({
+            propertyUrl: matchedProperty.propertyUrl,
+            startDate,
+            endDate,
+            dimensions,
+            filters: request.dimensionFilterGroups ? [transformFiltersToGSCFormat(filters)].filter(Boolean) : undefined,
+            searchType,
+            rowLimit: request.rowLimit,
+            startRow: request.startRow,
+            dataState: 'final',
+        });
+        if (!response || !response.rows || response.rows.length === 0) {
+            logger.info('Query returned no results', {
+                property: matchedProperty.propertyUrl,
+                dimensions,
+            });
+            return {
+                content: [{
+                        type: 'text',
+                        text: JSON.stringify({
+                            property: matchedProperty.propertyUrl,
+                            dateRange: { start: startDate, end: endDate },
+                            dimensions,
+                            filters: filters || [],
+                            searchType,
+                            sortBy,
+                            sortOrder,
+                            results: [],
+                            pagination: {
+                                offset: 0,
+                                limit: 0,
+                                total_rows: 0,
+                                current_chunk: 1,
+                                total_chunks: 1,
+                                has_more: false,
+                            },
+                        }, null, 2),
+                    }],
+            };
+        }
+        logger.debug('Transforming GSC response', {
+            rowCount: response.rows.length,
+        });
+        const results = response.rows.map((row) => transformRowToMCPFormat(row, dimensions));
+        logger.debug('Sorting results', { sortBy, sortOrder });
+        sortResults(results, sortBy, sortOrder);
+        logger.debug('Applying chunking', {
+            totalRows: results.length,
+            offset,
+            limit: limit || 'auto',
+        });
+        const chunked = chunkResults(results, offset, limit);
+        logger.info('Results chunked', {
+            totalRows: results.length,
+            offset,
+            limit: chunked.pagination.limit,
+            currentChunk: chunked.pagination.current_chunk,
+            totalChunks: chunked.pagination.total_chunks,
+            hasMore: chunked.pagination.has_more,
+        });
+        const responseObject = {
+            property: matchedProperty.propertyUrl,
+            dateRange: {
+                start: startDate,
+                end: endDate,
+            },
+            dimensions,
+            filters: filters || [],
+            searchType,
+            sortBy,
+            sortOrder,
+            results: chunked.results,
+            pagination: chunked.pagination,
+        };
+        logger.info('Query advanced completed successfully', {
+            property: matchedProperty.propertyUrl,
+            dimensions,
+            resultsReturned: chunked.results.length,
+            hasMore: chunked.pagination.has_more,
+        });
+        return {
+            content: [{
+                    type: 'text',
+                    text: JSON.stringify(responseObject, null, 2),
+                }],
+        };
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        const errorStack = error instanceof Error ? error.stack : undefined;
+        logger.error('Query advanced handler failed', {
+            error: errorMessage,
+            stack: errorStack,
+            params,
+        });
+        let userFriendlyMessage = errorMessage;
+        if (errorMessage.includes('permission') || errorMessage.includes('Permission')) {
+            userFriendlyMessage = `Permission denied for property ${params.property}. Use list_properties to see accessible properties.`;
+        }
+        else if (errorMessage.includes('not found') || errorMessage.includes('Not Found')) {
+            userFriendlyMessage = `Property ${params.property} not found. Use list_properties to get valid property identifiers.`;
+        }
+        else if (errorMessage.includes('dimension') || errorMessage.includes('Dimension')) {
+            userFriendlyMessage = 'Invalid dimension configuration. Valid dimensions: query, page, country, device, searchAppearance, date. Maximum 3 dimensions allowed per query.';
+        }
+        else if (errorMessage.includes('date') || errorMessage.includes('Date')) {
+            userFriendlyMessage = `Invalid date range. ${errorMessage}`;
+        }
+        else if (errorMessage.includes('rate limit') || errorMessage.includes('Rate limit')) {
+            userFriendlyMessage = 'Rate limit exceeded. Please wait a moment and try again.';
+        }
+        return {
+            content: [{
+                    type: 'text',
+                    text: JSON.stringify({
+                        error: 'Query execution failed',
+                        details: userFriendlyMessage,
+                    }, null, 2),
+                }],
+            isError: true,
+        };
+    }
+}
+//# sourceMappingURL=query-advanced.js.map

package/dist/tools/query-advanced.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-advanced.js","sourceRoot":"","sources":["../../src/tools/query-advanced.ts"],"names":[],"mappings":"AA6BA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAC;AACjG,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAEnE,OAAO,EAAE,YAAY,EAAsB,MAAM,6BAA6B,CAAC;AAC/E,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AA8D5C,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,IAAI,EAAE,gBAAgB;IACtB,WAAW,EAAE,2YAA2Y;IACxZ,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,0EAA0E;aACxF;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,4CAA4C;gBACzD,OAAO,EAAE,wBAAwB;aAClC;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,0CAA0C;gBACvD,OAAO,EAAE,wBAAwB;aAClC;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,CAAC;iBACzE;gBACD,WAAW,EAAE,6CAA6C;gBAC1D,QAAQ,EAAE,CAAC;gBACX,QAAQ,EAAE,CAAC;aACZ;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,SAAS,EAAE;4BACT,IAAI,EAAE,QAAQ;4BACd,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,CAAC;yBACzE;wBACD,QAAQ,EAAE;4BACR,IAAI,EAAE,QAAQ;4BACd,IAAI,EAAE,CAAC,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE,gBAAgB,EAAE,gBAAgB,CAAC;yBAC7F;wBACD,UAAU,EAAE;4BACV,IAAI,EAAE,QAAQ;yBACf;qBACF;oBACD,QAAQ,EAAE,CAAC,WAAW,EAAE,UAAU,EAAE,YAAY,CAAC;iBAClD;gBACD,WAAW,EAAE,oCAAoC;aAClD;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,CAAC;gBACjE,WAAW,EAAE,mCAAmC;gBAChD,OAAO,EAAE,KAAK;aACf;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,oDAAoD;gBACjE,OAAO,EAAE,CAAC;gBACV,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,KAAK;aACf;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,UAAU,CAAC;gBAClD,WAAW,EAAE,qCAAqC;gBAClD,OAAO,EAAE,QAAQ;aAClB;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC;gBACrB,WAAW,EAAE,4BAA4B;gBACzC,OAAO,EAAE,MAAM;aAChB;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,gCAAgC;gBAC7C,OAAO,EAAE,CAAC;gBACV,OAAO,EAAE,CAAC;aACX;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,qDAAqD;gBAClE,OAAO,EAAE,CAAC;gBACV,OAAO,EAAE,KAAK;aACf;SACF;QACD,QAAQ,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,YAAY,CAAC;KAC7D;CACF,CAAC;AA2BF,SAAS,iBAAiB,CAAC,WAAmB;IAE5C,MAAM,WAAW,GAA2B;QAC1C,QAAQ,EAAE,QAAQ;QAClB,WAAW,EAAE,YAAY;QACzB,UAAU,EAAE,UAAU;QACtB,aAAa,EAAE,cAAc;QAC7B,gBAAgB,EAAE,iBAAiB;QACnC,gBAAgB,EAAE,iBAAiB;KACpC,CAAC;IAEF,MAAM,MAAM,GAAG,WAAW,CAAC,WAAW,CAAC,CAAC;IAExC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,CAAC,IAAI,CAAC,sCAAsC,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;QACrE,OAAO,WAAW,CAAC,WAAW,EAAE,CAAC;IACnC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AA2BD,SAAS,2BAA2B,CAAC,OAA2B;IAC9D,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO;QACL,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC9B,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,QAAQ,EAAE,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC;YAC5C,UAAU,EAAE,MAAM,CAAC,UAAU;SAC9B,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC;AAiCD,SAAS,uBAAuB,CAC9B,GAAQ,EACR,UAAoB;IAEpB,MAAM,MAAM,GAA2B;QACrC,MAAM,EAAE,CAAC;QACT,WAAW,EAAE,CAAC;QACd,GAAG,EAAE,CAAC;QACN,QAAQ,EAAE,CAAC;KACZ,CAAC;IAGF,IAAI,GAAG,CAAC,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QACxC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,KAAa,EAAE,EAAE;YAC9C,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;YACpC,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,CAAC,SAAS,CAAC,GAAG,GAAG,CAAC;YAC1B,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAGD,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC;IAChC,MAAM,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI,CAAC,CAAC;IAC1C,MAAM,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1B,MAAM,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,IAAI,CAAC,CAAC;IAEpC,OAAO,MAAM,CAAC;AAChB,CAAC;AAWD,SAAS,WAAW,CAClB,OAAiC,EACjC,MAAc,EACd,SAAiB;IAEjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACpB,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAW,CAAC;QACjC,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAW,CAAC;QAGjC,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI;YAAE,OAAO,CAAC,CAAC;QAClD,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI;YAAE,OAAO,CAAC,CAAC,CAAC;QAEnD,MAAM,SAAS,GAAG,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/C,OAAO,SAAS,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC;AAqCD,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,MAAW,EACX,MAAiB;IAEjB,IAAI,CAAC;QAKH,MAAM,CAAC,IAAI,CAAC,iCAAiC,EAAE;YAC7C,aAAa,EAAE,MAAM,CAAC,QAAQ;YAC9B,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,WAAW,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;YACxC,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,OAAO,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,cAAc;SAC5G,CAAC,CAAC;QAEH,MAAM,gBAAgB,GAAG,yBAAyB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAErE,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;YAC9B,MAAM,aAAa,GAAG,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;gBAC9D,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtE,OAAO,GAAG,IAAI,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;YACnC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEd,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE;gBACtC,MAAM,EAAE,aAAa;gBACrB,MAAM;aACP,CAAC,CAAC;YAEH,OAAO;gBACL,OAAO,EAAE,CAAC;wBACR,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;4BACnB,KAAK,EAAE,yBAAyB;4BAChC,OAAO,EAAE,aAAa;yBACvB,EAAE,IAAI,EAAE,CAAC,CAAC;qBACZ,CAAC;gBACF,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAED,MAAM,SAAS,GAAG,gBAAgB,CAAC,IAAI,CAAC;QAGxC,MAAM,EACJ,QAAQ,EACR,SAAS,EACT,OAAO,EACP,UAAU,EACV,OAAO,EACP,UAAU,GAAG,KAAK,EAClB,QAAQ,GAAG,KAAK,EAChB,MAAM,GAAG,QAAQ,EACjB,SAAS,GAAG,MAAM,EAClB,MAAM,GAAG,CAAC,EACV,KAAK,GACN,GAAG,SAAS,CAAC;QAMd,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;QAC9C,MAAM,mBAAmB,GAAG,MAAM,cAAc,CAAC,MAAM,CAAC,CAAC;QAEzD,IAAI,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrC,MAAM,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;YACpD,OAAO;gBACL,OAAO,EAAE,CAAC;wBACR,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;4BACnB,KAAK,EAAE,qBAAqB;4BAC5B,OAAO,EAAE,uIAAuI;yBACjJ,EAAE,IAAI,EAAE,CAAC,CAAC;qBACZ,CAAC;gBACF,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAED,MAAM,WAAW,GAAG,aAAa,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC;QAEjE,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;YACzB,MAAM,YAAY,GAAG,0BAA0B,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;YAClF,MAAM,CAAC,KAAK,CAAC,0BAA0B,EAAE;gBACvC,WAAW,EAAE,QAAQ;gBACrB,SAAS,EAAE,WAAW,CAAC,SAAS;gBAChC,gBAAgB,EAAE,WAAW,CAAC,YAAY,EAAE,MAAM,IAAI,CAAC;aACxD,CAAC,CAAC;YAEH,OAAO;gBACL,OAAO,EAAE,CAAC;wBACR,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;4BACnB,KAAK,EAAE,iCAAiC;4BACxC,OAAO,EAAE,YAAY;yBACtB,EAAE,IAAI,EAAE,CAAC,CAAC;qBACZ,CAAC;gBACF,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAED,MAAM,eAAe,GAAG,WAAW,CAAC,OAAO,CAAC;QAC5C,MAAM,CAAC,IAAI,CAAC,+BAA+B,EAAE;YAC3C,WAAW,EAAE,QAAQ;YACrB,OAAO,EAAE,eAAe,CAAC,WAAW;YACpC,SAAS,EAAE,WAAW,CAAC,SAAS;SACjC,CAAC,CAAC;QAMH,MAAM,OAAO,GAAQ;YACnB,SAAS;YACT,OAAO;YACP,UAAU;YACV,IAAI,EAAE,UAAU;YAChB,SAAS,EAAE,OAAO;YAClB,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC;YACnC,QAAQ,EAAE,CAAC;SACZ,CAAC;QAGF,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClC,MAAM,kBAAkB,GAAG,2BAA2B,CAAC,OAAO,CAAC,CAAC;YAChE,IAAI,kBAAkB,EAAE,CAAC;gBACvB,OAAO,CAAC,qBAAqB,GAAG,CAAC,kBAAkB,CAAC,CAAC;YACvD,CAAC;QACH,CAAC;QAED,MAAM,CAAC,KAAK,CAAC,0BAA0B,EAAE;YACvC,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,OAAO,EAAE,OAAO,CAAC,qBAAqB,EAAE,MAAM,IAAI,CAAC;YACnD,UAAU,EAAE,OAAO,CAAC,IAAI;YACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC,CAAC;QAMH,MAAM,CAAC,IAAI,CAAC,0BAA0B,EAAE;YACtC,QAAQ,EAAE,eAAe,CAAC,WAAW;YACrC,UAAU;YACV,SAAS,EAAE,GAAG,SAAS,OAAO,OAAO,EAAE;SACxC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC;YAClC,WAAW,EAAE,eAAe,CAAC,WAAW;YACxC,SAAS;YACT,OAAO;YACP,UAAU;YACV,OAAO,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAQ,CAAC,CAAC,CAAC,SAAS;YAClH,UAAU;YACV,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,SAAS,EAAE,OAAO;SACnB,CAAC,CAAC;QAGH,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9D,MAAM,CAAC,IAAI,CAAC,2BAA2B,EAAE;gBACvC,QAAQ,EAAE,eAAe,CAAC,WAAW;gBACrC,UAAU;aACX,CAAC,CAAC;YAEH,OAAO;gBACL,OAAO,EAAE,CAAC;wBACR,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;4BACnB,QAAQ,EAAE,eAAe,CAAC,WAAW;4BACrC,SAAS,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,OAAO,EAAE;4BAC7C,UAAU;4BACV,OAAO,EAAE,OAAO,IAAI,EAAE;4BACtB,UAAU;4BACV,MAAM;4BACN,SAAS;4BACT,OAAO,EAAE,EAAE;4BACX,UAAU,EAAE;gCACV,MAAM,EAAE,CAAC;gCACT,KAAK,EAAE,CAAC;gCACR,UAAU,EAAE,CAAC;gCACb,aAAa,EAAE,CAAC;gCAChB,YAAY,EAAE,CAAC;gCACf,QAAQ,EAAE,KAAK;6BAChB;yBACF,EAAE,IAAI,EAAE,CAAC,CAAC;qBACZ,CAAC;aACH,CAAC;QACJ,CAAC;QAMD,MAAM,CAAC,KAAK,CAAC,2BAA2B,EAAE;YACxC,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM;SAC/B,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAQ,EAAE,EAAE,CAC7C,uBAAuB,CAAC,GAAG,EAAE,UAAU,CAAC,CACzC,CAAC;QAMF,MAAM,CAAC,KAAK,CAAC,iBAAiB,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QACvD,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;QAMxC,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE;YAChC,SAAS,EAAE,OAAO,CAAC,MAAM;YACzB,MAAM;YACN,KAAK,EAAE,KAAK,IAAI,MAAM;SACvB,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;QAErD,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE;YAC7B,SAAS,EAAE,OAAO,CAAC,MAAM;YACzB,MAAM;YACN,KAAK,EAAE,OAAO,CAAC,UAAU,CAAC,KAAK;YAC/B,YAAY,EAAE,OAAO,CAAC,UAAU,CAAC,aAAa;YAC9C,WAAW,EAAE,OAAO,CAAC,UAAU,CAAC,YAAY;YAC5C,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,QAAQ;SACrC,CAAC,CAAC;QAMH,MAAM,cAAc,GAA0B;YAC5C,QAAQ,EAAE,eAAe,CAAC,WAAW;YACrC,SAAS,EAAE;gBACT,KAAK,EAAE,SAAS;gBAChB,GAAG,EAAE,OAAO;aACb;YACD,UAAU;YACV,OAAO,EAAE,OAAO,IAAI,EAAE;YACtB,UAAU;YACV,MAAM;YACN,SAAS;YACT,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,UAAU,EAAE,OAAO,CAAC,UAAU;SAC/B,CAAC;QAMF,MAAM,CAAC,IAAI,CAAC,uCAAuC,EAAE;YACnD,QAAQ,EAAE,eAAe,CAAC,WAAW;YACrC,UAAU;YACV,eAAe,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM;YACvC,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,QAAQ;SACrC,CAAC,CAAC;QAEH,OAAO;YACL,OAAO,EAAE,CAAC;oBACR,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;iBAC9C,CAAC;SACH,CAAC;IAEJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5E,MAAM,UAAU,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;QAEpE,MAAM,CAAC,KAAK,CAAC,+BAA+B,EAAE;YAC5C,KAAK,EAAE,YAAY;YACnB,KAAK,EAAE,UAAU;YACjB,MAAM;SACP,CAAC,CAAC;QAGH,IAAI,mBAAmB,GAAG,YAAY,CAAC;QAEvC,IAAI,YAAY,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YAC/E,mBAAmB,GAAG,kCAAkC,MAAM,CAAC,QAAQ,qDAAqD,CAAC;QAC/H,CAAC;aAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YACpF,mBAAmB,GAAG,YAAY,MAAM,CAAC,QAAQ,oEAAoE,CAAC;QACxH,CAAC;aAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YACpF,mBAAmB,GAAG,kJAAkJ,CAAC;QAC3K,CAAC;aAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1E,mBAAmB,GAAG,uBAAuB,YAAY,EAAE,CAAC;QAC9D,CAAC;aAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YACtF,mBAAmB,GAAG,0DAA0D,CAAC;QACnF,CAAC;QAED,OAAO;YACL,OAAO,EAAE,CAAC;oBACR,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;wBACnB,KAAK,EAAE,wBAAwB;wBAC/B,OAAO,EAAE,mBAAmB;qBAC7B,EAAE,IAAI,EAAE,CAAC,CAAC;iBACZ,CAAC;YACF,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/tools/query-by-keyword.d.ts

@@ -0,0 +1,115 @@
+import { z } from 'zod';
+import { GSCClient } from '../gsc/client.js';
+export interface ToolResponse {
+    content: Array<{
+        type: 'text';
+        text: string;
+    }>;
+    isError?: boolean;
+}
+export declare const QueryByKeywordSchema: z.ZodObject<{
+    property: z.ZodString;
+    keywords: z.ZodArray<z.ZodString, "many">;
+    startDate: z.ZodString;
+    endDate: z.ZodString;
+    searchType: z.ZodDefault<z.ZodOptional<z.ZodEnum<["web", "image", "video", "news", "discover", "googleNews"]>>>;
+    dimensions: z.ZodOptional<z.ZodArray<z.ZodEnum<["page", "device", "country", "searchAppearance", "date"]>, "many">>;
+    deviceType: z.ZodOptional<z.ZodEnum<["desktop", "mobile", "tablet"]>>;
+    country: z.ZodOptional<z.ZodString>;
+    offset: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    limit: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    startDate: string;
+    endDate: string;
+    searchType: "web" | "image" | "video" | "news" | "discover" | "googleNews";
+    property: string;
+    offset: number;
+    keywords: string[];
+    dimensions?: ("page" | "country" | "device" | "searchAppearance" | "date")[] | undefined;
+    limit?: number | undefined;
+    deviceType?: "desktop" | "mobile" | "tablet" | undefined;
+    country?: string | undefined;
+}, {
+    startDate: string;
+    endDate: string;
+    property: string;
+    keywords: string[];
+    dimensions?: ("page" | "country" | "device" | "searchAppearance" | "date")[] | undefined;
+    searchType?: "web" | "image" | "video" | "news" | "discover" | "googleNews" | undefined;
+    limit?: number | undefined;
+    deviceType?: "desktop" | "mobile" | "tablet" | undefined;
+    country?: string | undefined;
+    offset?: number | undefined;
+}>;
+export type QueryByKeywordParams = z.infer<typeof QueryByKeywordSchema>;
+export declare const queryByKeywordTool: {
+    name: string;
+    description: string;
+    inputSchema: {
+        type: string;
+        properties: {
+            property: {
+                type: string;
+                description: string;
+            };
+            keywords: {
+                type: string;
+                items: {
+                    type: string;
+                };
+                description: string;
+                minItems: number;
+                maxItems: number;
+            };
+            startDate: {
+                type: string;
+                description: string;
+                pattern: string;
+            };
+            endDate: {
+                type: string;
+                description: string;
+                pattern: string;
+            };
+            searchType: {
+                type: string;
+                enum: string[];
+                description: string;
+                default: string;
+            };
+            dimensions: {
+                type: string;
+                items: {
+                    type: string;
+                    enum: string[];
+                };
+                description: string;
+            };
+            deviceType: {
+                type: string;
+                enum: string[];
+                description: string;
+            };
+            country: {
+                type: string;
+                description: string;
+                pattern: string;
+            };
+            offset: {
+                type: string;
+                description: string;
+                default: number;
+                minimum: number;
+            };
+            limit: {
+                type: string;
+                description: string;
+                minimum: number;
+                maximum: number;
+            };
+        };
+        required: string[];
+    };
+};
+export declare function handleQueryByKeyword(params: any, client: GSCClient): Promise<ToolResponse>;
+//# sourceMappingURL=query-by-keyword.d.ts.map

package/dist/tools/query-by-keyword.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query-by-keyword.d.ts","sourceRoot":"","sources":["../../src/tools/query-by-keyword.ts"],"names":[],"mappings":"AA8BA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAc7C,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,KAAK,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;KACd,CAAC,CAAC;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAYD,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkD/B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAcxE,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkE9B,CAAC;AA0FF,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,GAAG,EACX,MAAM,EAAE,SAAS,GAChB,OAAO,CAAC,YAAY,CAAC,CAiSvB"}