MCP Google Custom Search Server

MCP Google Custom Search Server

一个通过 Google Custom Search API 提供网络搜索功能的 Model Context Protocol（MCP）服务。此服务可让大语言模型（LLM）通过标准化接口执行网络搜索。

🌟 功能

• 与 Google Custom Search API 无缝集成
• 符合 Model Context Protocol（MCP）的服务实现
• 使用 TypeScript 实现类型安全
• 通过环境变量进行配置
• 使用 Zod 进行输入验证
• 可配置搜索结果数量（每次查询最多 10 条）
• 格式化搜索结果，包括标题、URL 和描述
• 错误处理与验证
• 兼容 Claude Desktop 和其他 MCP 客户端

📋 先决条件

开始之前，请确保你已准备好：

1. 已启用 Custom Search API 的 Google Cloud 项目

   • 访问 Google Cloud Console
   • 启用 Custom Search API
   • 创建 API 凭据

2. Custom Search Engine ID

   • 访问 Programmable Search Engine
   • 创建新的搜索引擎
   • 获取 Search Engine ID

3. 本地开发环境要求：

   • Node.js（v18 或更高版本）
   • npm（随 Node.js 一同安装）

🚀 快速开始

1. 克隆代码库：

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

2. 安装依赖：

   npm install
   

3. 创建 .env 文件：

   GOOGLE_API_KEY=your-api-key
   GOOGLE_SEARCH_ENGINE_ID=your-search-engine-id
   

4. 构建服务：

   npm run build
   

5. 启动服务：

   npm start
   

🔧 配置

环境变量

变量	描述	必填
GOOGLE_API_KEY	你的 Google Custom Search API 密钥	是
GOOGLE_SEARCH_ENGINE_ID	你的 Custom Search Engine ID	是

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": "your-api-key",
        "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
      }
    }
  }
}

📖 API 参考

可用工具

search

使用 Google Custom Search API 执行网络搜索。

参数：

• query（字符串，必填）：要执行的搜索查询
• numResults（数字，可选）：要返回的结果数量
  • 默认值：5
  • 最大值：10

响应示例：

Result 1:
Title: Example Search Result
URL: https://example.com
Description: This is an example search result description
---

Result 2:
...

🛠️ 开发

项目结构

mcp-google-custom-search-server/
├── src/
│   └── index.ts          # Main server implementation
├── build/                # Compiled JavaScript output
├── .env                  # Environment variables
├── package.json          # Project dependencies and scripts
├── tsconfig.json         # TypeScript configuration
└── README.md            # Project documentation

可用脚本

• npm run build：将 TypeScript 编译为 JavaScript
• npm start：启动 MCP 服务
• npm run dev：开发监视模式

测试

1. 使用 MCP Inspector：

   npx @modelcontextprotocol/inspector node build/index.js
   

2. 使用示例查询进行手动测试：

   # After starting the server
   {"jsonrpc":"2.0","id":1,"method":"callTool","params":{"name":"search","arguments":{"query":"example search"}}}
   

📝 许可证

本项目采用 MIT 许可证授权，详情请参阅 LICENSE 文件。

🙏 致谢

• 使用 Model Context Protocol (MCP) 构建
• 使用 Google Custom Search API
• 灵感源于 LLM 应用对更强大搜索能力的需求