MCP Google Custom Search Server

🚀 MCP Google Custom Search Server

A server compliant with the Model Context Protocol (MCP) that provides web search functionality through Google's Custom Search API. This server enables Large Language Models (LLMs) to perform web searches via a unified interface.

✨ Features

• Seamless integration with Google Custom Search API
• Implementation compliant with the Model Context Protocol (MCP)
• Type-safe implementation using TypeScript
• Configuration via environment variables
• Input validation with Zod
• Configurable number of search results (up to 10)
• Formatted search results including title, URL, and description
• Error handling and validation
• Compatibility with Claude Desktop and other MCP clients

📋 Prerequisites

Before you start, make sure the following conditions are met:

1. Enable the Custom Search API in the Google Cloud Console:

   • Visit the Google Cloud Console.
   • Enable the Custom Search API.
   • Create API credentials.

2. Obtain a Custom Search Engine ID:

   • Visit the Programmable Search Engine.
   • Create a new search engine.
   • Get your search engine ID.

3. Requirements for local development:

   • Node.js (v18 or higher)
   • npm (provided with Node.js)

🚀 Quick Start

1. Clone the repository:

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

2. Install dependencies:

   npm install
   

3. Create a .env file:

   GOOGLE_API_KEY=your_API_key
   GOOGLE_SEARCH_ENGINE_ID=your_search_engine_ID
   

4. Build the server:

   npm run build
   

5. Start the server:

   npm start
   

🔧 Configuration

Environment Variables

Integration with Claude Desktop

Add the following content to the Claude Desktop configuration file (usually located at ~/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 Reference

Available Tools

search

Perform a web search using the Google Custom Search API.

Parameters:

• query (string): The keyword to search for.
• num (integer, optional): The number of results to return, default is 10.

Return Format:

{
  "items": [
    {
      "title": "Result title",
      "link": "Result URL",
      "snippet": "Result description"
    },
    ...
  ]
}

📁 Project Structure

• src/: Contains the core business logic.
• build/: Output files after building.

Available Scripts

• npm run build: Build the server.
• npm start: Start the server.
• npm test: Run test cases.

📚 Documentation

The project documentation is located in the GitHub repository, which details how to use and extend the library.

🎁 Acknowledgments

Thanks to the support and contributions of the open-source community. This project is based on the following libraries:

• express
• node-fetch

We hope this project will facilitate your development work! If you have any questions or suggestions, please feel free to submit an Issue.