@getmcpads/google-search-console-mcp-server 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,16 @@
+google-search-console-mcp-server
+Copyright 2026 GetMCPAds
+
+This product includes software developed at GetMCPAds (https://www.getmcpads.com).
+
+An open-source Model Context Protocol server for Google Search Console.
+It is self-hosted, read-only, and unaffiliated with Google.
+
+GetMCPAds also runs a managed gateway that covers Search Console alongside
+Meta Ads, Google Ads, TikTok Ads, Pinterest Ads and Google Analytics, with
+hosted OAuth and cross-platform reporting: https://www.getmcpads.com
+
+---
+
+Google and Google Search Console are trademarks of Google LLC. This project
+is not affiliated with, endorsed by, or sponsored by Google LLC.

package/README.md

@@ -0,0 +1,304 @@
+# google-search-console-mcp-server
+
+[![CI](https://github.com/getmcpads-com/google-search-console-mcp-server/actions/workflows/ci.yml/badge.svg)](https://github.com/getmcpads-com/google-search-console-mcp-server/actions/workflows/ci.yml)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Node](https://img.shields.io/badge/node-%E2%89%A518-brightgreen.svg)](package.json)
+
+An open-source [Model Context Protocol](https://modelcontextprotocol.io) server for
+**Google Search Console**. It lets Claude, ChatGPT, Cursor or any MCP client query your
+search performance, inspect indexing, and analyse sitemaps.
+
+**Read-only, with no way to turn that off.** You run it, and your credentials stay on your
+machine.
+
+```bash
+npx -y @getmcpads/google-search-console-mcp-server
+```
+
+> **Prefer not to run it yourself?** [getmcpads.com](https://www.getmcpads.com) is the hosted
+> version of this server, with Search Console alongside Meta Ads, Google Ads, TikTok Ads,
+> Pinterest Ads and Google Analytics behind a single endpoint, hosted OAuth, and
+> cross-platform reporting. Same tools, same safety model, no setup.
+
+---
+
+## What you get
+
+| | |
+|---|---|
+| **20 read tools** | Search Analytics, sites, sitemaps, URL Inspection, and analyses built on top of them |
+| **SEO analyses, not just an API wrapper** | Cannibalisation detection, query clustering, wins and losses between periods, indexation watchlists, large-site sampling plans |
+| **7 resources** | Live catalogues the model can read: metrics, dimensions, filters, compatibility rules, 8 workflow recipes, read-only playbooks |
+| **Quota guardrails** | Every URL Inspection call is capped at 10 URLs, so one exploratory question cannot burn a day of quota |
+| **No writes at all** | Not a flag, a property of the code. See below |
+
+### What it does beyond fetching rows
+
+Search Console answers questions about rows. Most real questions are about **change**: which
+queries did we lose, which pages compete for the same term, is indexing drifting.
+
+These tools do that work rather than leaving it to the model:
+
+| Tool | Question it answers |
+|---|---|
+| `gsc_detect_cannibalization` | Which pages compete for the same query |
+| `gsc_find_losses_gains` | What we won and lost between two periods |
+| `gsc_cluster_queries` | Which queries belong to the same intent |
+| `gsc_compare_search_types` | How web, image, video and news differ |
+| `gsc_analyze_search_appearance_trends` | How rich results evolve |
+| `gsc_indexation_watchlist` | Which URLs changed indexing verdict |
+| `gsc_plan_large_site_sampling` | Which URLs to inspect, when you cannot inspect them all |
+
+---
+
+## One thing to know before you trust a number
+
+**Search Console returns a top N, not a site total.**
+
+When you query with a dimension such as `query` or `page`, the API returns the highest
+ranked rows up to your row limit, ordered by clicks. Summing the clicks of those rows does
+**not** give you the site total: the long tail is missing, and on a large site it can be most
+of the traffic.
+
+To get a real total, query **without dimensions**. To compare periods, compare like with
+like: same dimensions, same row limit, same search type.
+
+`gsc_query_search_analytics` reports what it actually returned, and `gsc_validate_query`
+checks a combination before it runs. But the arithmetic mistake is yours to avoid, and it is
+the most common one in Search Console analysis.
+
+Two other limits worth carrying in your head:
+
+- **Roughly 16 months of history.** Anything older is gone, not slow.
+- **Data settles over about three days.** `gsc_get_data_freshness` tells you what is final.
+
+---
+
+## Read-only, and why it stays that way
+
+There are no write tools, and no environment variable that adds any. The Search Console API
+can submit and delete sitemaps, add and remove properties, and request indexing. **This
+server exposes none of that.**
+
+The scope it asks for reflects that: `webmasters.readonly`, not `webmasters`. Even if the
+model tried, the token cannot write.
+
+Our ad platform servers, where writes make sense, do have them, guarded by a mandatory
+preview:
+[Meta Ads](https://github.com/getmcpads-com/meta-ads-mcp-server) ·
+[Google Ads](https://github.com/getmcpads-com/google-ads-mcp-server) ·
+[TikTok Ads](https://github.com/getmcpads-com/tiktok-ads-mcp-server)
+
+The hosted version at [getmcpads.com](https://www.getmcpads.com) keeps the same rule: Search
+Console stays read-only there too.
+
+---
+
+## Getting credentials
+
+Three values, obtained once.
+
+### 1. OAuth client
+
+In a [Google Cloud project](https://console.cloud.google.com/), enable the **Google Search
+Console API**, then create an OAuth client under **APIs & Services → Credentials**. Choose
+**Desktop app** for local use. Note the **client ID** and **client secret**.
+
+### 2. Refresh token
+
+Run the OAuth consent flow once, signed in as a Google account that owns or can read your
+properties, and keep the **refresh token**. Request `webmasters.readonly` and nothing more.
+
+📖 [Google OAuth for installed apps](https://developers.google.com/identity/protocols/oauth2/native-app)
+
+**The refresh token does not expire.** Use an OAuth client dedicated to this server so you
+can revoke it on its own.
+
+For a quick trial you can set `GSC_ACCESS_TOKEN` to a short-lived token instead, but it
+expires within the hour and is useless for daily work.
+
+If setting up an OAuth client is more than you want to do for one property,
+[getmcpads.com](https://www.getmcpads.com) handles the consent flow for you and gives you the
+same tools behind a hosted endpoint.
+
+### 3. Site URL, optional
+
+Set `GSC_SITE_URL` to avoid passing it on every call. Both property forms work:
+
+| Property type | Value |
+|---|---|
+| URL-prefix | `https://example.com/` (the trailing slash matters) |
+| Domain | `sc-domain:example.com` |
+
+List what you can reach with `gsc_list_sites`, and run **`gsc_health_check`** as your first
+call. It verifies the credentials without printing any secret.
+
+---
+
+## Setup
+
+### Claude Desktop
+
+`~/Library/Application Support/Claude/claude_desktop_config.json` (macOS)
+or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
+
+```json
+{
+  "mcpServers": {
+    "search-console": {
+      "command": "npx",
+      "args": ["-y", "@getmcpads/google-search-console-mcp-server"],
+      "env": {
+        "GSC_CLIENT_ID": "your-client-id",
+        "GSC_CLIENT_SECRET": "your-client-secret",
+        "GSC_REFRESH_TOKEN": "your-refresh-token"
+      }
+    }
+  }
+}
+```
+
+Restart Claude Desktop. Ask it: *"which queries did we lose last month?"*.
+
+### Claude Code
+
+```bash
+claude mcp add search-console --env GSC_CLIENT_ID=... --env GSC_CLIENT_SECRET=... --env GSC_REFRESH_TOKEN=... -- npx -y @getmcpads/google-search-console-mcp-server
+```
+
+### Cursor
+
+`.cursor/mcp.json` in your project, same shape as the Claude Desktop config above.
+
+### From source
+
+```bash
+git clone https://github.com/getmcpads-com/google-search-console-mcp-server.git
+cd google-search-console-mcp-server
+npm install && npm run build
+cp .env.example .env   # then fill in your credentials
+npm start
+```
+
+### Configuration
+
+| Variable | Default | Meaning |
+|---|---|---|
+| `GSC_CLIENT_ID` | none | OAuth client ID |
+| `GSC_CLIENT_SECRET` | none | OAuth client secret |
+| `GSC_REFRESH_TOKEN` | none | From the consent flow |
+| `GSC_ACCESS_TOKEN` | none | Alternative to the three above, expires within the hour |
+| `GSC_SITE_URL` | none | Optional default property |
+| `LOG_LEVEL` | `info` | `debug`, `info`, `warn`, `error` |
+
+Either the three OAuth values, or `GSC_ACCESS_TOKEN`. The server refuses to start with neither.
+
+```bash
+npm run doctor
+```
+
+---
+
+## Tools
+
+<details>
+<summary><b>20 read tools</b></summary>
+
+### Discovery and health
+| Tool | Purpose |
+|---|---|
+| `gsc_health_check` | Validates credentials and reachable properties |
+| `gsc_list_sites` / `gsc_get_site` | Properties you can reach, and their permission level |
+| `gsc_get_data_freshness` | How settled the most recent data is |
+
+### Search Analytics
+| Tool | Purpose |
+|---|---|
+| `gsc_query_search_analytics` | The main reporting tool. Dimensions, filters, date ranges |
+| `gsc_validate_query` | Check a combination *before* running it |
+| `gsc_compare_search_types` | Web, image, video, news and discover side by side |
+| `gsc_analyze_search_appearance_trends` | How rich results evolve over time |
+
+### SEO analysis
+| Tool | Purpose |
+|---|---|
+| `gsc_detect_cannibalization` | Pages competing for the same query |
+| `gsc_find_losses_gains` | Queries and pages won or lost between two periods |
+| `gsc_cluster_queries` | Group queries by shared intent |
+
+### Indexing
+| Tool | Purpose |
+|---|---|
+| `gsc_inspect_url` | Crawl and index status for one URL |
+| `gsc_bulk_inspect_urls` | Up to 10 URLs per call, to protect your quota |
+| `gsc_indexation_watchlist` | Track URLs whose verdict changed |
+| `gsc_monitor_indexation_freshness` | Freshness and indexation drift together |
+| `gsc_plan_large_site_sampling` | Build an inspection sample when you cannot inspect everything |
+
+### Sitemaps
+| Tool | Purpose |
+|---|---|
+| `gsc_list_sitemaps` / `gsc_get_sitemap` | Submitted sitemaps and their status |
+| `gsc_get_sitemap_health` | Errors, warnings and pending states |
+| `gsc_track_sitemap_deltas` | What changed against a baseline you supply |
+
+</details>
+
+<details>
+<summary><b>7 resources</b></summary>
+
+| URI | Contents |
+|---|---|
+| `gsc://manifest` | What this server exposes, and which tool to run first |
+| `gsc://metrics` | The 8 Search Analytics metrics, raw and derived |
+| `gsc://dimensions` | The 7 dimensions and where they are valid |
+| `gsc://filters` | The 5 filter operators and their accepted values |
+| `gsc://compatibility` | Which dimensions work with which search types and data states |
+| `gsc://recipes` | 8 step-by-step workflows |
+| `gsc://p2-readonly-playbooks` | Monitoring playbooks and their invariants |
+
+</details>
+
+---
+
+## Security
+
+- **The client secret and refresh token are never logged**, at any log level, or written to disk.
+- **Four hosts are contacted, and only four**: `searchconsole.googleapis.com` and
+  `www.googleapis.com` for the API, `oauth2.googleapis.com` and `accounts.google.com` for
+  OAuth. *A test fails the build if a fifth host appears in the source.*
+- **No fetch follows a redirect.** Every outbound call sets `redirect: "error"`, so a redirect
+  cannot forward a bearer token or client secret to another host. *A test fails the build if
+  any fetch omits this.*
+- **The scope is `webmasters.readonly`.** The token itself cannot write.
+- **No telemetry.** The server makes no network call other than to Google.
+
+Full policy: [SECURITY.md](SECURITY.md).
+
+---
+
+## Looking for a managed, multi-platform version?
+
+This server does one platform, on your machine, with your credentials. That is on purpose.
+
+If you'd rather not run it yourself, or you need Search Console **alongside Meta Ads, Google
+Ads, TikTok Ads, Pinterest Ads and Google Analytics** behind one endpoint, with hosted OAuth
+and cross-platform reporting, that's what we build at **[getmcpads.com](https://www.getmcpads.com)**.
+
+Same philosophy, less plumbing. This project stays open source and independently useful
+either way.
+
+---
+
+## Contributing
+
+Issues and pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md).
+Please read [SECURITY.md](SECURITY.md) before reporting anything security-related.
+
+## Licence
+
+[Apache License 2.0](LICENSE). See also [NOTICE](NOTICE).
+
+Google and Google Search Console are trademarks of Google LLC.
+**This project is not affiliated with, endorsed by, or sponsored by Google LLC.**
+It is an independent client of a public API.

package/dist/cli.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node