MCP Server Google Search Console

🚀 Google 搜索控制台 MCP 服务器

这是一个借助模型上下文协议（MCP）服务器来访问 Google 搜索控制台的实用工具。它能让你便捷地获取搜索分析数据，并支持对数据进行详细显示与自定义报告周期分析。

🚀 快速开始

使用该工具前，你需要满足以下先决条件：

• Python 3.10 或更高版本
• 启用了 Search Console API 的 Google Cloud 项目
• 具有搜索控制台访问权限的服务账户凭证

✨ 主要特性

• 获取搜索分析数据（支持维度）
• 详细的数据显示与自定义报告周期分析

📦 安装指南

你可以通过以下两种方式安装本工具：

通过 pip 安装

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 venv

激活虚拟环境：

• Linux/macOS：

source .venv/bin/activate

• Windows：

.venv\Scripts\activate

安装依赖项

克隆仓库后安装依赖项：

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 搜索控制台 API 凭证的步骤如下：

1. 访问 Google Cloud Console
2. 创建新项目或选择现有项目
3. 启用 API：转到 "APIs & 服务" > "库"
4. 创建具有搜索控制台访问权限的服务账户，并下载 JSON 凭证文件

使用方法

基本使用

# 安装包
pip install mcp-server-google-search-console

# 运行示例
python -m mcp_server.search_console_demo

可用工具

搜索控制台 API 调用

要调用 Google 搜索控制台的 API，请按照以下步骤操作：

1. 安装依赖项

pip install google-api-python-client google-auth_oauthlib

2. 配置项目 创建 config.py 文件：

import os
from google.oauth2 import service_account

# 加载服务账户凭证
credential_path = os.path.join(os.getcwd(), "service-account.json")
credentials = service_account.Credentials.from_service_account_file(
    credential_path, scopes=["https://www.googleapis.com/auth/searchconsole"])

3. 创建 MCP 服务器

from mcp_server.search_console import SearchConsoleMCP

# 初始化 MCP 服务器
search_console = SearchConsoleMCP(config)

发布流程

该项目会在创建 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 许可证。

🤝 贡献

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