MCP Google Cse

🚀 Google Custom Search API

Google Custom Search JSON API enables developers to submit query requests to the Google search engine via the HTTP protocol and obtain structured search result data. This guide provides a detailed introduction on how to use this API.

🚀 Quick Start

1. Obtain an API Key

First, create a project in the Google Cloud Console and enable the Custom Search JSON API. Then, generate an API key. This key is used for authentication, so please keep it secure.

2. Construct a Query Request

Construct a standard HTTP GET request in the following format:

https://www.googleapis.com/customsearch/v1?q={search_term}&key={API_key}

Where:

• q: A required parameter representing the content to be queried.
• key: A required parameter for authentication.

3. Request Example

Suppose we want to search for "Artificial Intelligence". The request URL is as follows:

https://www.googleapis.com/customsearch/v1?q=Artificial Intelligence&key=your_API_key

4. Response Result Structure

The JSON data format of the response is as follows:

{
  "items": [
    {
      "title": "Title", // Article title
      "link": "Link URL", // URL link
      "snippet": "Summary" // Summary description
    },
    ...
  ]
}

5. Explanation of Common Parameters

• cx: The website search context ID, used to specify a particular Google Custom Search engine.
• num: The number of results returned per page, with a default value of 10.
• start: The result offset, used for paginated queries.
• gl: The country code, used to restrict the search area.
• hl: The language code, used to limit the language of the returned results.

6. Example Code

Here is a simple Python call example:

import requests

def custom_search(query, api_key):
    url = "https://www.googleapis.com/customsearch/v1"
    params = {
        'q': query,
        'key': api_key
    }
    response = requests.get(url, params=params)
    return response.json()

# Usage example
result = custom_search("Artificial Intelligence", "your_API_key")
print(result)

✨ Features

1. Support for JSON Response Format: The API returns data in the standard JSON format, facilitating program processing.
2. Abundant Parameter Options: Multiple optional parameters are provided to control the search behavior and the way results are presented.
3. Developer-Friendly Design: High-quality search results can be obtained through simple HTTP requests.

⚠️ Important Notes

1. Rate Limitations: Google imposes limitations on the number of API calls, which depend on the project level being used.
2. Error Handling: It is recommended to add an exception-catching mechanism to your code to ensure program robustness.
3. Compliance with Terms: You must comply with Google's Terms of Service when using this API.

📚 Documentation

For more detailed information, please refer to the official documentation: Custom Search JSON API Documentation