搜索分析工具

通过MCP服务器访问Google Search Console,提供搜索数据分析功能,适用于网站管理员和SEO专业人员。

  • by guchey
  • Python
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 guchey/mcp-server-google-search-console

使用说明

谷歌搜索控制台MCP服务器

使用模型上下文协议(MCP)服务器访问谷歌搜索控制台的工具。

特性

  • 检索搜索分析数据(支持维度)
  • 具有可定制报告期的详细数据分析

先决条件

  • Python 3.10或更高版本
  • 启用搜索控制台API的谷歌云项目
  • 具有搜索控制台访问权限的服务帐户凭据

安装

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:

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. 访问 谷歌云控制台
  2. 创建新项目或选择现有项目
  3. 启用API:
    • 转到“API和服务”>“库”
    • 搜索并启用“搜索控制台API”
  4. 创建凭据:
    • 转到“API和服务”>“凭据”
    • 点击“创建凭据”>“服务帐户”
    • 输入服务帐户详细信息
    • 以JSON格式创建新密钥
    • 凭据文件(.json)将自动下载
  5. 授予访问权限:
    • 打开搜索控制台
    • 添加服务帐户电子邮件地址(格式:name@project.iam.gserviceaccount.com)作为物业管理人

用法

设置环境变量以指定Google Search Console凭据文件的路径:

export GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json

启动MCP服务器

标准方法

mcp-server-gsc

使用uvx

使用uvx,您可以自动化虚拟环境和软件包安装:

# Run directly without installation
uvx run mcp-server-gsc

# Run with a specific Python version
uvx --python=3.11 run mcp-server-gsc

# Run with specified environment variables
uvx run -e GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json mcp-server-gsc

Claude桌面应用程序的配置

标准配置

{
  "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"
      }
    }
  }
}

可用工具

搜索分析

从谷歌搜索控制台检索搜索性能数据:

所需参数:

  • 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。

许可证

麻省理工学院

贡献

欢迎投稿!在提交拉取请求之前,请阅读贡献指南。