使用说明

项目简介

该项目是一个Model Context Protocol (MCP) 服务器,旨在为大型语言模型 (LLM) 客户端提供访问 Google Search Console (GSC) 数据的能力。通过此服务器,LLM 可以调用工具来获取网站的搜索性能数据、索引状态、站点地图等信息,从而更好地理解和分析网站在 Google 搜索中的表现。

主要功能点

  • 搜索分析数据检索: 获取网站在 Google 搜索中的性能数据,例如关键词排名、点击次数、展示次数等。支持按多种维度(如查询、页面、国家/地区、设备等)细分数据。
  • 索引状态检查: 检查特定 URL 是否已被 Google 索引,以及索引状态的详细信息。
  • 站点地图管理: 列出、获取和提交网站的站点地图。

安装步骤

  1. 安装 Node.js: 确保你的系统已安装 Node.js 18 或更高版本。
  2. 安装 npm 包: 在命令行中执行 'npm install mcp-server-gsc' 命令安装该 MCP 服务器。
  3. 配置 Google Cloud 项目:
    • 创建或选择一个 Google Cloud 项目。
    • 启用 "Search Console API"。
    • 创建服务帐户并下载 JSON 格式的凭据文件 ('credentials.json')。
    • 在 Google Search Console 中,将服务帐户的邮箱地址添加为网站资源的管理用户。

服务器配置

MCP 客户端需要配置以下 JSON 对象来连接到此 MCP 服务器。例如,在 Claude Desktop 客户端中,你需要在配置文件中添加 'mcpServers' 部分:

{
  "mcpServers": {
    "gsc": { // 服务器名称,可以自定义
      "command": "npx", // 启动命令,通常为 npx 或 node
      "args": ["-y", "mcp-server-gsc"], // 启动参数,这里是执行 mcp-server-gsc 包
      "env": {
        "GOOGLE_APPLICATION_CREDENTIALS": "/path/to/credentials.json" // 环境变量,指向你的 Google 服务帐户凭据文件路径
      }
    }
  }
}

请将 '/path/to/credentials.json' 替换为实际的凭据文件路径。

基本使用方法

  1. 启动 MCP 服务器:根据 MCP 客户端的配置方式启动服务器。例如,Claude Desktop 会自动根据配置启动。

  2. 在 LLM 客户端中,可以使用以下工具调用来访问 Google Search Console 数据:

    • 'list_sites': 列出所有已验证的网站。
    • 'search_analytics': 获取搜索分析数据,需要提供 'siteUrl'、'startDate'、'endDate' 等参数。
    • 'index_inspect': 检查 URL 的索引状态,需要提供 'siteUrl' 和 'inspectionUrl' 参数。
    • 'list_sitemaps': 列出站点地图,需要提供 'siteUrl' 参数。
    • 'get_sitemap': 获取站点地图内容,需要提供 'siteUrl' 和 'feedpath' 参数。
    • 'submit_sitemap': 提交站点地图,需要提供 'siteUrl' 和 'feedpath' 参数。

    具体的工具参数和使用方法可以参考仓库的 README 文件和工具的 'inputSchema' 定义。

信息

分类

网页与API