MCP Google Custom Search Server

一个模型上下文协议 (MCP) 服务器，通过 Google Custom Search API 提供网络搜索功能。此服务器使语言学习模型 (LLM) 能够使用标准化接口执行网络搜索。

🌟 特性

• 与 Google Custom Search API 无缝集成
• 符合模型上下文协议 (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/yourusername/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 (string, 必需): 要执行的搜索查询
• numResults (number, 可选): 要返回的结果数
  • 默认值: 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          # 主要服务器实现
├── build/                # 编译后的 JavaScript 输出
├── .env                  # 环境变量
├── package.json          # 项目依赖项和脚本
├── tsconfig.json         # TypeScript 配置
└── README.md            # 项目文档

可用脚本

• npm run build: 将 TypeScript 编译为 JavaScript
• npm start: 启动 MCP 服务器
• npm run dev: 开发模式下的监听模式

测试

1. 使用 MCP Inspector:

   npx @modelcontextprotocol/inspector node build/index.js
   

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

   # 启动服务器后
   {"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 应用程序中对更好搜索功能的需求的启发