README Documentation
google-search-mcp
A Model Context Protocol (MCP) server that provides Google Search functionality.
🚀 Features
- StreamableHTTP Transport: High-performance and scalable HTTP communication
- Google Custom Search: Real-time web search capabilities
- Secure: Proper authentication and error handling
- Health Check: Standard health check endpoint support
🛠 Requirements
- Node.js 18 or higher
- Google Custom Search API key
📦 Setup
1. Install dependencies
npm install
2. Set environment variables
GOOGLE_SEARCH_API_KEY=your_actual_google_search_api_key
GOOGLE_CSE_ID=your_actual_custom_search_engine_id
cp env.example .env
3. Local development
npm run dev
🔧 API Endpoints
Once the server is running, the following endpoints are available:
Endpoint | Description |
---|---|
/mcp | MCP protocol communication |
/health | Health check |
/ | Status |
🔌 Client Configuration
Cursor IDE / Claude Desktop Configuration
Example configuration for using the server from MCP clients:
{
"mcpServers": {
"google_search": {
"url": "http://localhost:3000/mcp"
}
}
}
📊 Monitoring
Health Check
curl http://localhost:3000/health
🧪 Available Tools
search
Performs a web search using the Google Search API.
Parameters:
query
(string, required): Search querynum
(number, optional): Number of results to return (1-10, default: 5)
Example:
{
"name": "search",
"arguments": {
"query": "artificial intelligence",
"num": 5
}
}
🔑 Google Custom Search Setup
- Go to Google Cloud Console
- Create a new project or select an existing one
- Enable the Custom Search API
- Create credentials (API Key)
- Set up a Custom Search Engine
- Get your Search Engine ID
📝 Development
Build
npm run build
Lint
npm run lint
Format
npm run format
Note: This server is designed for StreamableHTTP mode only. It does not support stdio mode.
Quick Actions
Key Features
Model Context Protocol
Secure Communication
Real-time Updates
Open Source