https://github.com/adenot/mcp-google-search
https://github.com/adenot/mcp-google-search
Last synced: 14 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/adenot/mcp-google-search
- Owner: adenot
- License: mit
- Created: 2025-02-01T02:27:36.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-02-08T03:57:22.000Z (2 months ago)
- Last Synced: 2025-02-08T04:25:49.850Z (2 months ago)
- Language: JavaScript
- Size: 18.6 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mcp-zh - Google Custom Search
- awesome-mcp-servers - Google Custom Search - Provides web search and webpage content extraction using the Google Custom Search API (Table of Contents / Search)
- awesome-mcp-servers - Google Custom Search - Provides web search and webpage content extraction using the Google Custom Search API (Table of Contents / Search)
README
# mcp-google-server A MCP Server for Google Custom Search and Webpage Reading
[](https://smithery.ai/server/@adenot/mcp-google-search)
A Model Context Protocol server that provides web search capabilities using Google Custom Search API and webpage content extraction functionality.
## Setup
### Getting Google API Key and Search Engine ID
1. Create a Google Cloud Project:
- Go to [Google Cloud Console](https://console.cloud.google.com/)
- Create a new project or select an existing one
- Enable billing for your project
2. Enable Custom Search API:
- Go to [API Library](https://console.cloud.google.com/apis/library)
- Search for "Custom Search API"
- Click "Enable"
3. Get API Key:
- Go to [Credentials](https://console.cloud.google.com/apis/credentials)
- Click "Create Credentials" > "API Key"
- Copy your API key
- (Optional) Restrict the API key to only Custom Search API
4. Create Custom Search Engine:
- Go to [Programmable Search Engine](https://programmablesearchengine.google.com/create/new)
- Enter the sites you want to search (use www.google.com for general web search)
- Click "Create"
- On the next page, click "Customize"
- In the settings, enable "Search the entire web"
- Copy your Search Engine ID (cx)
## Development
Install dependencies:
```bash
npm install
```
Build the server:
```bash
npm run build
```
For development with auto-rebuild:
```bash
npm run watch
```
## Features
### Search Tool
Perform web searches using Google Custom Search API:
- Search the entire web or specific sites
- Control number of results (1-10)
- Get structured results with title, link, and snippet
### Webpage Reader Tool
Extract content from any webpage:
- Fetch and parse webpage content
- Extract page title and main text
- Clean content by removing scripts and styles
- Return structured data with title, text, and URL
## Installation
### Installing via Smithery
To install Google Custom Search Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@adenot/mcp-google-search):
```bash
npx -y @smithery/cli install @adenot/mcp-google-search --client claude
```
To use with Claude Desktop, add the server config with your Google API credentials:
On MacOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
```json
{
"mcpServers": {
"google-search": {
"command": "npx",
"args": [
"-y",
"@adenot/mcp-google-search"
],
"env": {
"GOOGLE_API_KEY": "your-api-key-here",
"GOOGLE_SEARCH_ENGINE_ID": "your-search-engine-id-here"
}
}
}
}
```
## Usage
### Search Tool
```json
{
"name": "search",
"arguments": {
"query": "your search query",
"num": 5 // optional, default is 5, max is 10
}
}
```
### Webpage Reader Tool
```json
{
"name": "read_webpage",
"arguments": {
"url": "https://example.com"
}
}
```
Example response from webpage reader:
```json
{
"title": "Example Domain",
"text": "Extracted and cleaned webpage content...",
"url": "https://example.com"
}
```
### Debugging
Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector), which is available as a package script:
```bash
npm run inspector
```
The Inspector will provide a URL to access debugging tools in your browser.