Google Search Console Mcp Server

by Shin-sibainu

295 downloads
Not rated
GitHub

About

A Model Context Protocol (MCP) server that provides programmatic access to Google Search Console API data through Claude Code and Cursor.

Details

Author
Shin-sibainu
Downloads
295
Categories
Search

- List all Search Console properties you have access to
- Query search performance data with flexible filtering
- Retrieve sitemap status and indexing statistics
- Check detailed indexing status of specific URLs
- Submit URLs for indexing or removal
- Compare search performance between two time periods

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Google Search Console Mcp Server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Configure a .mcp.json file with your Google OAuth credentials (GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET, GOOGLE_REDIRECT_URI, GOOGLE_REFRESH_TOKEN). Run the setup command (npx -y google-search-console-mcp-setup) to generate a refresh token, then use natural language prompts in Claude Desktop or Claude Code to interact with Search Console data.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "google search console mcp server": {
            "google-search-console": {
                "command": "npx",
                "args": [
                    "google-search-console-mcp-server"
                ],
                "env": {
                    "GOOGLE_CLIENT_ID": "your-client-id.apps.googleusercontent.com",
                    "GOOGLE_CLIENT_SECRET": "your-client-secret",
                    "GOOGLE_REDIRECT_URI": "http://localhost:8080",
                    "GOOGLE_REFRESH_TOKEN": "your-refresh-token"
                }
            }
        }
    }
}

McpServers

{
    "google-search-console": {
        "command": "npx",
        "args": [
            "google-search-console-mcp-server"
        ],
        "env": {
            "GOOGLE_CLIENT_ID": "your-client-id.apps.googleusercontent.com",
            "GOOGLE_CLIENT_SECRET": "your-client-secret",
            "GOOGLE_REDIRECT_URI": "http://localhost:8080",
            "GOOGLE_REFRESH_TOKEN": "your-refresh-token"
        }
    }
}

Google Search Console MCP Server

A Model Context Protocol (MCP) server that provides programmatic access to Google Search Console API data through Claude Code and Cursor.

Quick Start

New to this MCP server? Jump to Step-by-Step Setup Guide for complete instructions.

Features

- ๐Ÿ” List Sites - Get all Search Console properties you have access to - ๐Ÿ“Š Search Analytics - Query search performance data with flexible filtering - ๐Ÿ—บ๏ธ Sitemap Information - Retrieve sitemap status and indexing statistics - ๐Ÿ”Ž URL Inspection - Check detailed indexing status of specific URLs - ๐Ÿ“ค Submit URL for Indexing - Request Google to index or remove URLs - ๐Ÿ“ˆ Compare Periods - Compare search performance between two time periods - ๐Ÿ›ก๏ธ Robust Error Handling - Detailed error messages with actionable guidance - ๐Ÿ”„ Automatic Retry Logic - Handles rate limits and transient failures - โœ… Input Validation - Validates all parameters before API calls

Setup

1. Configure Claude Code

Create .mcp.json in your project root: ``json { "mcpServers": { "google-search-console": { "command": "npx", "args": ["google-search-console-mcp-server"], "env": { "GOOGLE_CLIENT_ID": "your-client-id.apps.googleusercontent.com", "GOOGLE_CLIENT_SECRET": "your-client-secret", "GOOGLE_REDIRECT_URI": "http://localhost:8080", "GOOGLE_REFRESH_TOKEN": "your-refresh-token" } } } } `

2. Get Google OAuth Credentials

1. Go to Google Cloud Console 2. Create a project and enable Google Search Console API (and optionally Indexing API) 3. Create OAuth 2.0 Client ID (Desktop app) 4. Add
http://localhost:8080 to Authorized redirect URIs 5. Add your email to Test users in OAuth consent screen

3. Get Refresh Token

Run the setup command and follow the browser authentication flow:
`bash npx -y google-search-console-mcp-setup ` You'll be prompted to enter your GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET, and GOOGLE_REDIRECT_URI. Copy the GOOGLE_REFRESH_TOKEN from the output and paste it into your .mcp.json. Reload Claude Code window.

Usage

Once configured, you can use the tools in Claude Desktop or Claude Code:
` Show me my Google Search Console sites ` or ` Get search performance data for example.com for the last 7 days `

Available Tools

1. list_sites

Get all Search Console sites you have access to. Parameters: None Example: ` Search Consoleใฎใ‚ตใ‚คใƒˆไธ€่ฆงใ‚’ๆ•™ใˆใฆ `

2. get_analytics

Query search performance data for a specified date range. Parameters: - siteUrl (required): Site URL (e.g., "https://example.com/") - startDate (required): Start date (YYYY-MM-DD) - endDate (required): End date (YYYY-MM-DD) - dimensions (optional): Array of dimensions ["query", "page", "country", "device", "searchAppearance"] - rowLimit (optional): Max rows (default: 100, max: 25000) - startRow (optional): Starting row for pagination Example: ` example.comใฎ้ŽๅŽป7ๆ—ฅ้–“ใฎใƒˆใƒƒใƒ—ใ‚ฏใ‚จใƒชใ‚’ๅ–ๅพ—ใ—ใฆ example.comใฎ2025ๅนด1ๆœˆ1ๆ—ฅใ‹ใ‚‰1ๆœˆ31ๆ—ฅใพใงใฎใ€ ใƒšใƒผใ‚ธๅˆฅใจใƒ‡ใƒใ‚คใ‚นๅˆฅใฎใƒ‘ใƒ•ใ‚ฉใƒผใƒžใƒณใ‚นใ‚’500ไปถๅ–ๅพ—ใ—ใฆ `

3. get_sitemaps

Retrieve sitemap information for a site. Parameters: - siteUrl (required): Site URL Example: ` example.comใฎใ‚ตใ‚คใƒˆใƒžใƒƒใƒ—ๆƒ…ๅ ฑใ‚’็ขบ่ชใ—ใฆ `

4. inspect_url

Inspect the indexing status of a specific URL. Parameters: - siteUrl (required): Site URL (e.g., "https://example.com/") - inspectionUrl (required): Full URL to inspect Example: ` https://example.com/blog/article ใฎใ‚คใƒณใƒ‡ใƒƒใ‚ฏใ‚น็Šถๆ…‹ใ‚’ๆคœๆŸปใ—ใฆ `

5. submit_url_for_indexing

Submit a URL to Google for indexing or request URL removal using the Indexing API. Parameters: - url (required): Full URL to submit (e.g., "https://example.com/page") - type (optional): Notification type - "URL_UPDATED" (default) or "URL_DELETED" Example: ` https://example.com/new-article ใ‚’ใ‚คใƒณใƒ‡ใƒƒใ‚ฏใ‚นใซ้€ไฟกใ—ใฆ https://example.com/old-page ใ‚’ๅ‰Š้™ค็”ณ่ซ‹ใ—ใฆ๏ผˆtype: URL_DELETED๏ผ‰ ` Note: Requires Indexing API to be enabled in Google Cloud Console and the https://www.googleapis.com/auth/indexing scope.

6. compare_periods

Compare search performance metrics between two time periods (e.g., this week vs last week). Parameters: - siteUrl (required): Site URL (e.g., "https://example.com/") - currentStartDate (required): Current period start date (YYYY-MM-DD) - currentEndDate (required): Current period end date (YYYY-MM-DD) - previousStartDate (required): Previous period start date (YYYY-MM-DD) - previousEndDate (required): Previous period end date (YYYY-MM-DD) - dimensions (optional): Array of dimensions to group by - rowLimit (optional): Max rows (default: 100, max: 25000) Example: ` Compare this week vs last week performance for example.com Compare query performance for example.com between January 2025 and December 2024 (currentStartDate: 2025-01-01, currentEndDate: 2025-01-31, previousStartDate: 2024-12-01, previousEndDate: 2024-12-31, dimensions: ["query"]) `

API Limits

- Daily quota: 2,000 requests per project - Per 100 seconds: 600 requests - Data availability: Up to 16 months of historical data - Data latency: Typically 2-3 days

Error Handling & Retry Logic

This MCP server includes comprehensive error handling:

Automatic Retries

- Rate Limiting (429): Automatically retries with exponential backoff - Server Errors (5xx): Retries up to 3 times with increasing delays - Transient Failures: Smart retry logic with jitter to prevent thundering herd

Input Validation

All tools validate inputs before making API calls: - Site URL: Validates URL format and structure - Dates: Validates YYYY-MM-DD format and logical date ranges - Row Limits: Ensures limits are within API constraints (1-25,000)

Detailed Error Messages

Error messages include: - Clear description of what went wrong - HTTP status code - Actionable steps to resolve the issue Example:
` Access denied for list sites (403) Verify your authentication credentials and ensure you have access to this Search Console property. You may need to add your account as a test user in Google Cloud Console. `

Troubleshooting

"Missing required environment variables"

Make sure your
.env file exists and contains valid GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET.

"redirect_uri_mismatch"

Ensure
http://localhost:8080 is added to Authorized redirect URIs in Google Cloud Console.

"Error 403: access_denied"

Add your Google account email to the Test users section in OAuth consent screen.

"Invalid site URL format"

Site URLs must be complete URLs like: -
https://example.com/ (for URL-prefix properties) - sc-domain:example.com (for domain properties)

"Date range too old"

Search Console data is only available for the last 16 months.

"Rate limit exceeded"

The tool will automatically retry with backoff. If you continue to hit limits: - Wait a few minutes between requests - Reduce
rowLimit in analytics queries - API Limits: 2,000 requests/day, 600 requests/100 seconds

Token Expired

Re-run the authentication setup:
`bash node build/auth/setup-auth.js `

Development

Build

`bash npm run build `

Watch Mode

`bash npm run dev `

Re-authenticate

`bash node build/auth/setup-auth.js `

Project Structure

` src/ โ”œโ”€โ”€ index.ts # MCP server entry point โ”œโ”€โ”€ auth/ โ”‚ โ”œโ”€โ”€ google-auth.ts # OAuth 2.0 client โ”‚ โ””โ”€โ”€ setup-auth.ts # Authentication CLI โ”œโ”€โ”€ tools/ โ”‚ โ”œโ”€โ”€ list-sites.ts # List sites tool โ”‚ โ”œโ”€โ”€ get-analytics.ts # Search analytics tool โ”‚ โ”œโ”€โ”€ get-sitemaps.ts # Sitemap info tool โ”‚ โ”œโ”€โ”€ inspect-url.ts # URL inspection tool โ”‚ โ”œโ”€โ”€ submit-url.ts # Submit URL for indexing โ”‚ โ””โ”€โ”€ compare-periods.ts # Compare time periods โ”œโ”€โ”€ types/ โ”‚ โ””โ”€โ”€ index.ts # Type definitions โ””โ”€โ”€ utils/ โ””โ”€โ”€ error-handler.ts # Error handling & validation `

Security Notes

- Never commit
.env or .mcp.json files to version control - Keep your refresh token secure - Use readonly scope (webmasters.readonly`) when possible - Refresh tokens provide persistent access - store them securely

License

MIT

Contributing

Contributions are welcome! Please feel free to submit issues or pull requests. ---

Resources

- Google Search Console API Documentation - Model Context Protocol - Claude Code Documentation
No reviews yet โ€” be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.