Google Search Console MCP 服务器

一个使用模型上下文协议 (MCP) 服务器访问 Google Search Console 的工具。

功能

• 检索搜索分析数据（支持维度）
• 通过可定制的报告周期进行详细的数据分析

前提条件

• Python 3.10 或更高版本
• 启用了 Search Console API 的 Google Cloud 项目
• 具有 Search Console 访问权限的服务帐户凭据

安装

pip install mcp-server-google-search-console

或者从源代码安装：

git clone https://github.com/yourusername/mcp-server-google-search-console.git
cd mcp-server-google-search-console
pip install -e .

设置开发环境 (uv)

此项目使用 uv 来实现更快的包管理和安装。

安装 uv 和 uvx

首先，安装 uv 和 uvx：

pip install uv uvx

创建和管理虚拟环境

要使用 uv 创建新的虚拟环境：

uv venv
source .venv/bin/activate  # Linux/macOS
.venv\Scripts\activate     # Windows

安装依赖项

克隆存储库后，安装依赖项：

git clone https://github.com/yourusername/mcp-server-google-search-console.git
cd mcp-server-google-search-console
pip install -e .

要单独安装 MCP 包：

pip install "mcp[cli]"

安装开发依赖项

要安装开发所需的其他工具，请运行：

pip install -e ".[dev]"

身份验证设置

要获取 Google Search Console API 凭据：

1. 访问 Google Cloud Console
2. 创建一个新项目或选择一个现有项目
3. 启用 API：
   • 转到“API 和服务”>“库”
   • 搜索并启用“Search Console API”
4. 创建凭据：
   • 转到“API 和服务”>“凭据”
   • 点击“创建凭据”>“服务帐户”
   • 输入服务帐户详细信息
   • 以 JSON 格式创建一个新密钥
   • 凭据文件 (.json) 将自动下载
5. 授予访问权限：
   • 打开 Search Console
   • 将服务帐户电子邮件地址（格式：name@project.iam.gserviceaccount.com）添加为属性管理员

用法

设置一个环境变量来指定 Google Search Console 凭据文件的路径：

export GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json

启动 MCP 服务器

标准方法

mcp-server-gsc

使用 uvx

使用 uvx，您可以自动执行虚拟环境和包安装：

# 无需安装即可直接运行
uvx run mcp-server-gsc

# 使用特定的 Python 版本运行
uvx --python=3.11 run mcp-server-gsc

# 使用指定的环境变量运行
uvx run -e GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json mcp-server-gsc

Claude Desktop Application 的配置

标准配置

{
  "mcpServers": {
    "gsc": {
      "command": "mcp-server-gsc",
      "env": {
        "GOOGLE_APPLICATION_CREDENTIALS": "/path/to/credentials.json"
      }
    }
  }
}

使用 uvx 的配置

{
  "mcpServers": {
    "gsc": {
      "command": "uvx",
      "args": ["run", "mcp-server-gsc"],
      "env": {
        "GOOGLE_APPLICATION_CREDENTIALS": "/path/to/credentials.json"
      }
    }
  }
}

可用工具

search_analytics

从 Google Search Console 检索搜索效果数据：

必需参数：

• siteUrl：站点 URL（格式：http://www.example.com/ 或 sc-domain:example.com）
• startDate：开始日期 (YYYY-MM-DD)
• endDate：结束日期 (YYYY-MM-DD)

可选参数：

• dimensions：逗号分隔的列表 (query,page,country,device,searchAppearance)
• type：搜索类型 (web, image, video, news)
• aggregationType：聚合方法 (auto, byNewsShowcasePanel, byProperty, byPage)
• rowLimit：要返回的最大行数（默认值：1000）

用法示例：

{
  "siteUrl": "https://example.com",
  "startDate": "2024-01-01",
  "endDate": "2024-01-31",
  "dimensions": "query,country",
  "type": "web",
  "rowLimit": 500
}

发布流程

当创建 GitHub 发布标签时，此项目会自动发布到 PyPI。

要发布新版本：

1. 运行版本更新脚本：

   python scripts/bump_version.py [major|minor|patch]
   

2. 按照显示的说明推送到 GitHub：

   git add pyproject.toml
   git commit -m "Bump version to x.y.z"
   git tag vx.y.z
   git push origin main vx.y.z
   

3. 在 GitHub 存储库页面上创建一个发布：

   • 选择标签：vx.y.z
   • 输入标题：vx.y.z
   • 填写发行说明
   • 点击“发布”

4. GitHub Actions 将被触发并自动将软件包发布到 PyPI。

许可证

MIT

贡献

欢迎贡献！在提交拉取请求之前，请阅读贡献指南。