项目简介
这是一个实现了 Model Context Protocol (MCP) 的服务器,专门用于连接 Google Search Console API。通过此服务器,LLM(大型语言模型)客户端可以安全、便捷地获取网站在 Google 搜索中的表现数据,以及管理网站的站点地图和索引状态。
主要功能点
- 搜索分析数据检索: 获取网站在 Google 搜索中的性能数据,例如关键词的点击次数、展示次数、排名等。支持按日期范围、维度(如查询词、页面、国家/地区、设备等)和搜索类型(网页、图片、视频、新闻)进行筛选和分析。
- 站点地图管理:
- 列出站点地图: 获取指定网站已提交的站点地图列表。
- 获取站点地图: 下载并查看指定站点地图的内容。
- 提交站点地图: 向 Google Search Console 提交新的站点地图,加速网站内容被 Google 索引。
- URL 索引检查: 检查特定 URL 是否已被 Google 索引,并获取索引状态的详细信息,帮助诊断索引问题。
安装步骤
- 安装 Node.js: 确保你的系统中已安装 Node.js 18 或更高版本。
- 安装 MCP Server GSC: 打开终端,运行以下命令安装 'mcp-server-gsc' 包:
npm install mcp-server-gsc - 配置 Google Cloud 项目和 Search Console API:
- 访问 Google Cloud Console 并创建一个新的 Google Cloud 项目或选择现有项目。
- 启用 Search Console API:在 "API 和服务" -> "库" 中搜索并启用 "Search Console API"。
- 创建服务账号凭据:在 "API 和服务" -> "凭据" 中,点击 "创建凭据" -> "服务账号"。填写服务账号详细信息,并创建一个 JSON 格式的密钥。下载凭据文件(.json)。
- 授权服务账号访问 Search Console:打开 Google Search Console,将服务账号的邮箱地址(格式为 '[email protected]')添加到你的 Search Console 属性中,并授予 "所有者" 或 "管理员" 权限。
- 设置环境变量: 设置环境变量 'GOOGLE_APPLICATION_CREDENTIALS' 指向你下载的凭据文件(.json)的路径。例如:
请将 '/path/to/your/credentials.json' 替换为实际的文件路径。export GOOGLE_APPLICATION_CREDENTIALS=/path/to/your/credentials.json
服务器配置 (MCP 客户端配置)
要将此 MCP 服务器配置到 MCP 客户端(例如 Claude Desktop),你需要提供以下 JSON 配置信息。请根据你的实际情况进行配置:
{ "mcpServers": { "gsc": { // 服务器名称,可以自定义,例如 "gsc" "command": "npx", // 启动服务器的命令,这里使用 npx 运行 npm 包 "args": ["-y", "mcp-server-gsc"], // 启动服务器的参数,"-y" 表示跳过 npm 提示,"mcp-server-gsc" 是要运行的 npm 包名 "env": { "GOOGLE_APPLICATION_CREDENTIALS": "/path/to/credentials.json" // 环境变量,指定 Google 服务账号凭据文件路径,请替换为实际路径 } } } }
配置说明:
- '"gsc"': 是你在 MCP 客户端中为这个服务器定义的名称,可以根据需要修改。
- '"command": "npx"' 和 '"args": ["-y", "mcp-server-gsc"]': 这两行配置指示 MCP 客户端使用 'npx' 命令来运行 'mcp-server-gsc' npm 包。这是一种便捷的运行本地安装的 npm 包的方式。
- '"env": { "GOOGLE_APPLICATION_CREDENTIALS": "/path/to/credentials.json" }': 这部分配置设置了服务器运行时的环境变量。'GOOGLE_APPLICATION_CREDENTIALS' 环境变量是 'mcp-server-gsc' 服务器用来查找 Google 服务账号凭据文件的关键配置。请务必将 '/path/to/credentials.json' 替换为你实际保存凭据文件的路径。
将上述 JSON 配置添加到你的 MCP 客户端的配置文件中 (通常是 JSON 格式),客户端即可识别并连接到此 GSC MCP 服务器。
基本使用方法
配置完成后,你的 MCP 客户端应该能够发现此服务器提供的工具。你可以通过客户端的功能调用这些工具,例如:
- 调用 'search_analytics' 工具: 可以指定 'siteUrl' (网站 URL)、'startDate' (开始日期)、'endDate' (结束日期) 等参数,检索网站的搜索分析数据。例如,你可以查询过去一个月内,用户通过哪些关键词访问了你的网站。
- 调用 'list_sitemaps' 工具: 可以指定 'siteUrl',获取该网站已提交的站点地图列表。
- 调用 'index_inspect' 工具: 可以指定 'inspectionUrl' (要检查的 URL),查询该 URL 在 Google 索引中的状态。
具体工具的使用方法和参数,请参考仓库的 'README.md' 文件或工具的描述信息。你可以在 MCP 客户端中查看可用的工具列表及其详细信息。
信息
分类
网页与API