Mcp Google Server A Mcp Server For Google Custom Search And Webpage Reading
Overview
What is mcp-google-search?
The ### mcp-google-search is a public repository created by the user ### adenot on GitHub. This project focuses on enhancing the search capabilities within Google, potentially providing users with improved search results and functionalities. It is designed to be an open-source solution, allowing developers to contribute and enhance its features.
Features of mcp-google-search
- Open Source: The repository is publicly accessible, allowing anyone to view, use, and contribute to the code.
- Enhanced Search Functionality: The project aims to improve the way users interact with Google search, potentially offering features that streamline the search process.
- Community Driven: As an open-source project, it encourages collaboration among developers, fostering a community that can contribute to its growth and improvement.
- Documentation: Comprehensive documentation is provided to help users understand how to implement and utilize the features of the repository effectively.
How to Use mcp-google-search
-
Clone the Repository: Start by cloning the repository to your local machine using the command:
git clone https://github.com/adenot/mcp-google-search.git
-
Install Dependencies: Navigate to the project directory and install any necessary dependencies. This can typically be done using package managers like npm or yarn, depending on the project's setup.
-
Run the Application: Follow the instructions in the documentation to run the application. This may involve starting a local server or executing specific scripts.
-
Contribute: If you wish to contribute to the project, check the contribution guidelines provided in the repository. You can submit issues, feature requests, or even pull requests with your enhancements.
Frequently Asked Questions
What programming languages are used in mcp-google-search?
The project primarily utilizes JavaScript, but it may also include HTML and CSS for front-end development.
How can I report issues or bugs?
You can report issues by navigating to the "Issues" tab in the repository and submitting a new issue with detailed information about the problem.
Is there a license for mcp-google-search?
Yes, the repository is licensed under the MIT License, which allows for free use, modification, and distribution of the software.
How can I stay updated on changes to the repository?
You can watch the repository on GitHub to receive notifications about updates, or you can follow the project on social media platforms if available.
Can I contribute to the project?
Absolutely! Contributions are welcome. Please refer to the contribution guidelines in the repository for more information on how to get involved.
Details
mcp-google-server A MCP Server for Google Custom Search and Webpage Reading
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
-
Create a Google Cloud Project:
- Go to Google Cloud Console
- Create a new project or select an existing one
- Enable billing for your project
-
Enable Custom Search API:
- Go to API Library
- Search for "Custom Search API"
- Click "Enable"
-
Get API Key:
- Go to Credentials
- Click "Create Credentials" > "API Key"
- Copy your API key
- (Optional) Restrict the API key to only Custom Search API
-
Create Custom Search Engine:
- Go to Programmable Search Engine
- 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:
npm install
Build the server:
npm run build
For development with auto-rebuild:
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:
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
{
"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
{
"name": "search",
"arguments": {
"query": "your search query",
"num": 5 // optional, default is 5, max is 10
}
}
Webpage Reader Tool
{
"name": "read_webpage",
"arguments": {
"url": "https://example.com"
}
}
Example response from webpage reader:
{
"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, which is available as a package script:
npm run inspector
The Inspector will provide a URL to access debugging tools in your browser.
Server Config
{
"mcpServers": {
"mcp-google-search": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"ghcr.io/metorial/mcp-container--adenot--mcp-google-search--mcp-google-search",
"node ./build/index.js"
],
"env": {
"GOOGLE_API_KEY": "google-api-key",
"GOOGLE_SEARCH_ENGINE_ID": "google-search-engine-id"
}
}
}
}