MCP Google Custom Search Server

🚀 MCP 谷歌自定义搜索服务器

MCP 谷歌自定义搜索服务器是一个符合模型上下文协议（MCP）的服务器，借助谷歌的自定义搜索 API 提供网络搜索功能。它为语言学习模型（LLMs）提供了统一接口，使其能够便捷地执行网络搜索。

🚀 快速开始

如果你想快速使用 MCP 谷歌自定义搜索服务器，可按以下步骤操作：

1. 克隆仓库：

   git clone https://github.com/yourusername/mcp-google-custom-search-server.git
   cd mcp-google-custom-search-server
   

2. 安装依赖：

   npm install
   

3. 创建.env 文件：

   GOOGLE_API_KEY=你的API密钥
   GOOGLE_SEARCH_ENGINE_ID=你的搜索引擎ID
   

4. 构建服务器：

   npm run build
   

5. 启动服务器：

   npm start
   

✨ 主要特性

• 与谷歌自定义搜索 API 实现无缝集成，确保搜索功能稳定高效。
• 严格符合模型上下文协议（MCP），为语言学习模型提供统一接口。
• 使用 TypeScript 编写，保证代码的类型安全。
• 支持通过环境变量进行灵活配置。
• 利用 Zod 进行输入验证，提高系统的健壮性。
• 搜索结果数量可配置，最多可返回 10 条结果。
• 搜索结果经过格式化处理，包含标题、URL 和描述，方便查看。
• 具备完善的错误处理与验证机制。
• 兼容 Claude Desktop 和其他 MCP 客户端。

📦 安装指南

先决条件

在开始使用前，请确保完成以下准备工作：

1. 在谷歌云控制台启用自定义搜索 API：
   • 访问谷歌云控制台。
   • 启用自定义搜索 API。
   • 创建 API 凭证。
2. 获取自定义搜索引擎 ID：
   • 访问可编程搜索引擎。
   • 创建新的搜索引擎。
   • 获取你的搜索引擎 ID。
3. 本地开发要求：
   • 安装 Node.js（v18 或更高版本）。
   • 安装 npm（随 Node.js 提供）。

🔧 技术细节

配置

环境变量

Claude Desktop 集成

在 Claude Desktop 配置文件中添加以下内容（通常位于~/Library/Application Support/Claude/claude_desktop_config.json）：

{
  "mcpServers": {
    "google-search": {
      "command": "node",
      "args": [
        "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
      ],
      "env": {
        "GOOGLE_API_KEY": "你的API密钥",
        "GOOGLE_SEARCH_ENGINE_ID": "你的搜索引擎ID"
      }
    }
  }
}

📄 API 文档

可用工具

search

使用谷歌自定义搜索 API 执行网络搜索。 参数：

• query（字符串）：要搜索的关键词。
• num（整数，可选）：返回的结果数量，默认为 10。 返回格式：

{
  "items": [
    {
      "title": "结果标题",
      "link": "结果链接",
      "snippet": "结果摘要"
    },
    ...
  ]
}

📚 详细文档

项目文档位于GitHub 仓库中，详细介绍了如何使用和扩展该库。

📁 项目结构

• src/: 包含核心业务逻辑。
• build/: 构建后的输出文件。

可用脚本

• npm run build：构建服务器。
• npm start：启动服务器。
• npm test：运行测试用例。

🎁 致谢

感谢开源社区的支持与贡献。本项目基于以下库实现：

• express
• node-fetch

希望这个项目能为你的开发工作提供便利！如果有任何问题或建议，请随时提交 Issues。