Google Custom Search

by limklister

15 stars

Not rated

GitHub

About

Integrates the Google Custom Search API to enable web searches for retrieving and analyzing online content.

Details

Author: limklister
Repository: limklister/mcp-google-custom-search-server
GitHub stars: 15
License: MIT License
Categories: Developer Tools, Design, AI, Media, Search, Frontend, API, Infrastructure, Knowledge Base

- Seamless integration with Google Custom Search API
- Model Context Protocol (MCP) compliant server implementation
- Type-safe implementation using TypeScript
- Environment variable configuration
- Input validation using Zod
- Configurable search results (up to 10 per query)
- Formatted search results including titles, URLs, and descriptions
- Error handling and validation
- Compatible with Claude Desktop and other MCP clients

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below
Plugin Name Google Custom Search

Command (node, npx, python, etc.) node
Arguments
- Argument 1 /absolute/path/to/mcp-google-custom-search-server/build/index.js
Environment
- GOOGLE_API_KEY your-api-key
- GOOGLE_SEARCH_ENGINE_ID your-search-engine-id
Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "google custom search": {
            "env": {
                "GOOGLE_API_KEY": "your-api-key",
                "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
            },
            "args": [
                "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
            ],
            "command": "node"
        }
    }
}

JSON

{
    "mcpServers": {
        "google custom search": {
            "env": {
                "GOOGLE_API_KEY": "your-api-key",
                "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
            },
            "args": [
                "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
            ],
            "command": "node"
        }
    }
}

JSON

{
    "mcpServers": {
        "google custom search": {
            "env": {
                "GOOGLE_API_KEY": "your-api-key",
                "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
            },
            "args": [
                "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
            ],
            "command": "node"
        }
    }
}

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

{
    "mcpServers": {
        "google custom search": {
            "env": {
                "GOOGLE_API_KEY": "your-api-key",
                "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
            },
            "args": [
                "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
            ],
            "command": "node"
        }
    }
}

JSON

{
    "mcpServers": {
        "google custom search": {
            "env": {
                "GOOGLE_API_KEY": "your-api-key",
                "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
            },
            "args": [
                "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
            ],
            "command": "node"
        }
    }
}

JSON

{
    "mcpServers": {
        "google custom search": {
            "env": {
                "GOOGLE_API_KEY": "your-api-key",
                "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
            },
            "args": [
                "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
            ],
            "command": "node"
        }
    }
}

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "google custom search": {
            "env": {
                "GOOGLE_API_KEY": "your-api-key",
                "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
            },
            "args": [
                "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
            ],
            "command": "node"
        }
    }
}

JSON

{
    "mcpServers": {
        "google custom search": {
            "env": {
                "GOOGLE_API_KEY": "your-api-key",
                "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
            },
            "args": [
                "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
            ],
            "command": "node"
        }
    }
}

JSON

{
    "mcpServers": {
        "google custom search": {
            "env": {
                "GOOGLE_API_KEY": "your-api-key",
                "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
            },
            "args": [
                "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
            ],
            "command": "node"
        }
    }
}

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

{
    "mcpServers": {
        "google custom search": {
            "env": {
                "GOOGLE_API_KEY": "your-api-key",
                "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
            },
            "args": [
                "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
            ],
            "command": "node"
        }
    }
}

JSON

{
    "mcpServers": {
        "google custom search": {
            "env": {
                "GOOGLE_API_KEY": "your-api-key",
                "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
            },
            "args": [
                "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
            ],
            "command": "node"
        }
    }
}

JSON

{
    "mcpServers": {
        "google custom search": {
            "env": {
                "GOOGLE_API_KEY": "your-api-key",
                "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
            },
            "args": [
                "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
            ],
            "command": "node"
        }
    }
}

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "google custom search": {
            "env": {
                "GOOGLE_API_KEY": "your-api-key",
                "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
            },
            "args": [
                "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
            ],
            "command": "node"
        }
    }
}

JSON

{
    "mcpServers": {
        "google custom search": {
            "env": {
                "GOOGLE_API_KEY": "your-api-key",
                "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
            },
            "args": [
                "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
            ],
            "command": "node"
        }
    }
}

JSON

{
    "mcpServers": {
        "google custom search": {
            "env": {
                "GOOGLE_API_KEY": "your-api-key",
                "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
            },
            "args": [
                "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
            ],
            "command": "node"
        }
    }
}

From the repository

1. Clone the repository:

   git clone https://github.com/limklister/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

| Variable | Description | Required |
| ----------------------- | --------------------------------- | -------- |
| GOOGLE_API_KEY | Your Google Custom Search API key | Yes |
| GOOGLE_SEARCH_ENGINE_ID | Your Custom Search Engine ID | Yes |

`search`

Performs a web search using Google Custom Search API. Parameters: query (string, required) - The search query to execute, numResults (number, optional) - Number of results to return (default: 5, maximum: 10).

search

Performs a web search using Google Custom Search API.

Parameters:

- query (string, required): The search query to execute
- numResults (number, optional): Number of results to return
- Default: 5
- Maximum: 10

Example Response:

```
Result 1:

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "google custom search": {
            "env": {
                "GOOGLE_API_KEY": "your-api-key",
                "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
            },
            "args": [
                "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
            ],
            "command": "node"
        }
    }
}

Linux

{
    "env": {
        "GOOGLE_API_KEY": "your-api-key",
        "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
    },
    "args": [
        "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
    ],
    "command": "node"
}

Macos

{
    "env": {
        "GOOGLE_API_KEY": "your-api-key",
        "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
    },
    "args": [
        "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
    ],
    "command": "node"
}

Windows

{
    "env": {
        "GOOGLE_API_KEY": "your-api-key",
        "GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id"
    },
    "args": [
        "/absolute/path/to/mcp-google-custom-search-server/build/index.js"
    ],
    "command": "node"
}

MCP Google Custom Search Server

A Model Context Protocol (MCP) server that provides web search capabilities through Google's Custom Search API. This server enables Language Learning Models (LLMs) to perform web searches using a standardized interface.

🌟 Features

📋 Prerequisites

Before you begin, ensure you have:

1. A Google Cloud Project with Custom Search API enabled

- Visit Google Cloud Console
- Enable the Custom Search API
- Create API credentials

2. A Custom Search Engine ID

- Visit Programmable Search Engine
- Create a new search engine
- Get your Search Engine ID

3. Local development requirements:
- Node.js (v18 or higher)
- npm (comes with Node.js)

🚀 Quick Start

1. Clone the repository:

   git clone https://github.com/limklister/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

Claude Desktop Integration

Add this configuration to your Claude Desktop config file (typically 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

Performs a web search using Google Custom Search API.

Parameters:

- query (string, required): The search query to execute
- numResults (number, optional): Number of results to return
- Default: 5
- Maximum: 10

Example Response:

```
Result 1:

No reviews yet — be the first

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

About

Details

Jump to

Setting up with Highlight

From the repository

search

search

Claude Desktop / Cursor

Linux

Macos

Windows

MCP Google Custom Search Server

🌟 Features

📋 Prerequisites

🚀 Quick Start

🔧 Configuration

Environment Variables

Claude Desktop Integration

📖 API Reference

Available Tools

search

Install

More like this

Sentry

Github

Git

GitLab

Context 7

1Panel

`search`