MCP Server Ga4

🚀 Google Analytics 4 MCP Server

This server provides MCP (Model Context Protocol) functionality for Google Analytics 4, enabling users to access various data metrics and resources.

🚀 Quick Start

This server is an ongoing project. It has not been fully tested yet, so please use it with caution.

✨ Features

This server offers the following MCP features:

Tools

• get-page-views: Retrieve page view metrics within a specified date range.
• get-active-users: Retrieve active user metrics within a specified date range.
• get-events: Retrieve event metrics within a specified date range.
• get-user-behavior: Retrieve user behavior metrics, such as session duration and bounce rate.

Resources

• ga4://property-info: Metadata of GA4 properties, including available dimensions, metrics, and comparison items.

The following are lighter-weight resources:

• ga4://dimensions: List of available dimensions in GA4.
• ga4://filters-help: Help documentation for using GA4 filters.
• ga4://metrics: List of available metrics in GA4.

Tips

• analyze-data: Data analysis assistant.
• create-report: Report generation template.
• select-dimensions: Assist in selecting dimensions suitable for the analysis objective.

📦 Installation

Prerequisites

• A Google Analytics 4 property.
• A Google Cloud service account with GA4 API access.
• Node.js 20 or higher.
• pnpm package manager.

Installation Steps

# Clone the repository
git clone https://github.com/yourusername/mcp-server-ga4.git
cd mcp-server-ga4

# Install dependencies using pnpm
pnpm install

# Create a .env file
cp .env.example .env

# Edit the .env file and set your credentials
# GOOGLE_CLIENT_EMAIL=your-service-account-email@example.iam.gserviceaccount.com
# GOOGLE_PRIVATE_KEY=your-private-key
# GA_PROPERTY_ID=your-ga4-property-id

Authentication

If GOOGLE_CLIENT_EMAIL and GOOGLE_PRIVATE_KEY are set, the server will authenticate using the service account. If not set, it will use the Application Default Credentials by default.

Please ensure that the Google Analytics API is enabled in your project and your service account has the necessary permissions (https://www.googleapis.com/auth/analytics.readonly).

Here's how to set up Google Application Default Credentials:

1. Install the Google Cloud SDK.
2. Run the following command to authenticate:

gcloud auth application-default login

💻 Usage Examples

Resource Path Examples

• ga4://property-info: Retrieve metadata of GA4 properties, including available dimensions, metrics, and comparison items.
• ga4://dimensions: List all available dimensions in GA4.
• ga4://metrics: List all available metrics in GA4.

Tip Function Examples

• analyze-data: Assist in analyzing data and providing insights.
• create-report: Generate a custom report template.
• select-dimensions: Select the most suitable dimensions based on the objective.

🛠️ Troubleshooting

• Authentication errors: Check the service account key and permissions.
• No data displayed: Confirm that the date range and property ID are correct.
• Connection errors: Check the network settings and firewall configuration.

🧪 Testing

Test using the MCP inspector:

pnpm dlx @modelcontextprotocol/inspector node /path/to/mcp-server-ga4/dist/index.js

(Note: pnpm dlx is equivalent to npx for executing packages)

📄 License

MIT

🙏 Acknowledgments

• https://github.com/lapras-inc/lapras-mcp-server/tree/main
  • This project borrowed the class structure implementation from this repository.
• https://github.com/ruchernchong/mcp-server-google-analytics
  • Based on the basic implementation of the Google Analytics API.