Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ahonn/mcp-server-gsc
A Model Context Protocol (MCP) server providing access to Google Search Console
https://github.com/ahonn/mcp-server-gsc
Last synced: about 2 months ago
JSON representation
A Model Context Protocol (MCP) server providing access to Google Search Console
- Host: GitHub
- URL: https://github.com/ahonn/mcp-server-gsc
- Owner: ahonn
- Created: 2024-12-04T04:10:53.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2024-12-04T08:02:51.000Z (about 2 months ago)
- Last Synced: 2024-12-04T08:28:50.365Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-mcp-servers - Google Search Console - A Model Context Protocol (MCP) server providing access to Google Search Console. (Community Servers)
- awesome-mcp-servers - Google Search Console - A Model Context Protocol (MCP) server providing access to Google Search Console. (Community Servers)
README
# Google Search Console MCP Server
A Model Context Protocol (MCP) server providing access to Google Search Console.
## Features
- Search analytics data retrieval with dimensions support
- Rich data analysis with customizable reporting periods
## Prerequisites
- Node.js 18 or later
- Google Cloud Project with Search Console API enabled
- Service Account credentials with Search Console access
## Installation
```bash
npm install mcp-server-gsc
```
## Authentication Setup
To obtain Google Search Console API credentials:
1. Visit the [Google Cloud Console](https://console.cloud.google.com/)
2. Create a new project or select an existing one
3. Enable the API:
- Go to "APIs & Services" > "Library"
- Search for and enable ["Search Console API"](https://console.cloud.google.com/marketplace/product/google/searchconsole.googleapis.com)
4. Create credentials:
- Navigate to ["APIs & Services" > "Credentials"](https://console.cloud.google.com/apis/credentials)
- Click "Create Credentials" > "Service Account"
- Fill in the service account details
- Create a new key in JSON format
- The credentials file (.json) will download automatically
5. Grant access:
- Open Search Console
- Add the service account email (format: [email protected]) as a property administrator
## Usage
### Claude Desktop Configuration
```json
{
"mcpServers": {
"gsc": {
"command": "npx",
"args": ["-y", "mcp-server-gsc"],
"env": {
"GOOGLE_APPLICATION_CREDENTIALS": "/path/to/credentials.json"
}
}
}
}
```
## Available Tools
### search_analytics
Get search performance data from Google Search Console with customizable parameters:
**Required Parameters:**
- `siteUrl`: Site URL (format: `http://www.example.com/` or `sc-domain:example.com`)
- `startDate`: Start date (YYYY-MM-DD)
- `endDate`: End date (YYYY-MM-DD)
**Optional Parameters:**
- `dimensions`: Comma-separated list (`query,page,country,device,searchAppearance`)
- `type`: Search type (`web`, `image`, `video`, `news`)
- `aggregationType`: Aggregation method (`auto`, `byNewsShowcasePanel`, `byProperty`, `byPage`)
- `rowLimit`: Maximum rows to return (default: 1000)
Example:
```json
{
"siteUrl": "https://example.com",
"startDate": "2024-01-01",
"endDate": "2024-01-31",
"dimensions": "query,country",
"type": "web",
"rowLimit": 500
}
```
## License
MIT
## Contributing
Contributions are welcome! Please read our contributing guidelines before submitting pull requests.