@pipeworx/mcp-google_analytics 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Pipeworx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,38 @@
+# mcp-google_analytics
+
+Google Analytics MCP Pack
+
+Part of the [Pipeworx](https://pipeworx.io) open MCP gateway.
+
+## Tools
+
+| Tool | Description |
+|------|-------------|
+| `ga_run_report` | Run a report on a Google Analytics 4 property. Specify dimensions (e.g., "city", "pagePath"), metrics (e.g., "activeUsers", "sessions"), and date ranges to retrieve analytics data. |
+| `ga_list_properties` | List all Google Analytics 4 properties accessible by the authenticated user. Uses the Admin API to fetch account summaries with property details. |
+| `ga_get_realtime` | Get a realtime report for a Google Analytics 4 property. Shows currently active users and realtime metrics. |
+| `ga_get_metadata` | List all available dimensions and metrics for a Google Analytics 4 property. Useful for discovering what fields can be used in reports. |
+
+## Quick Start
+
+Add to your MCP client config:
+
+```json
+{
+  "mcpServers": {
+    "google_analytics": {
+      "url": "https://gateway.pipeworx.io/google_analytics/mcp"
+    }
+  }
+}
+```
+
+Or use the CLI:
+
+```bash
+npx pipeworx use google_analytics
+```
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@pipeworx/mcp-google_analytics",
+  "version": "0.1.0",
+  "description": "Google Analytics MCP Pack",
+  "type": "module",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "keywords": ["mcp", "mcp-server", "model-context-protocol", "pipeworx", "google_analytics"],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pipeworx-io/mcp-google_analytics"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.0"
+  }
+}

package/server.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
+  "name": "io.github.pipeworx-io/google_analytics",
+  "title": "google_analytics",
+  "description": "Google Analytics MCP Pack",
+  "version": "0.1.0",
+  "websiteUrl": "https://pipeworx.io/packs/google_analytics",
+  "repository": {
+    "url": "https://github.com/pipeworx-io/mcp-google_analytics",
+    "source": "github"
+  },
+  "remotes": [
+    {
+      "type": "streamable-http",
+      "url": "https://gateway.pipeworx.io/google_analytics/mcp"
+    }
+  ]
+}

package/src/index.ts

@@ -0,0 +1,196 @@
+interface McpToolDefinition {
+  name: string;
+  description: string;
+  inputSchema: {
+    type: 'object';
+    properties: Record<string, unknown>;
+    required?: string[];
+  };
+}
+
+interface McpToolExport {
+  tools: McpToolDefinition[];
+  callTool: (name: string, args: Record<string, unknown>) => Promise<unknown>;
+}
+
+/**
+ * Google Analytics MCP Pack
+ *
+ * Requires OAuth connection — gateway injects credentials via _context.google_analytics.
+ * Tools: run report, list properties, get realtime data, get metadata.
+ *
+ * Uses the Google Analytics Data API (v1beta) for reports and the
+ * Google Analytics Admin API (v1beta) for property listing.
+ */
+
+
+interface AnalyticsContext {
+  google_analytics?: { accessToken: string };
+}
+
+const DATA_API = 'https://analyticsdata.googleapis.com/v1beta';
+const ADMIN_API = 'https://analyticsadmin.googleapis.com/v1beta';
+
+async function gFetch(ctx: AnalyticsContext, url: string, options: RequestInit = {}) {
+  if (!ctx.google_analytics) {
+    return { error: 'connection_required', message: 'Connect your Google account at https://pipeworx.io/account' };
+  }
+  const res = await fetch(url, {
+    ...options,
+    headers: {
+      Authorization: `Bearer ${ctx.google_analytics.accessToken}`,
+      'Content-Type': 'application/json',
+      ...(options.headers ?? {}),
+    },
+  });
+  if (!res.ok) {
+    const text = await res.text();
+    throw new Error(`Google Analytics API error (${res.status}): ${text}`);
+  }
+  return res.json();
+}
+
+const tools: McpToolExport['tools'] = [
+  {
+    name: 'ga_run_report',
+    description: 'Run a report on a Google Analytics 4 property. Specify dimensions (e.g., "city", "pagePath"), metrics (e.g., "activeUsers", "sessions"), and date ranges to retrieve analytics data.',
+    inputSchema: {
+      type: 'object' as const,
+      properties: {
+        property_id: { type: 'string', description: 'GA4 property ID (numeric, e.g., "123456789")' },
+        dimensions: {
+          type: 'array',
+          description: 'List of dimension names (e.g., ["city", "pagePath", "date"])',
+          items: { type: 'string' },
+        },
+        metrics: {
+          type: 'array',
+          description: 'List of metric names (e.g., ["activeUsers", "sessions", "screenPageViews"])',
+          items: { type: 'string' },
+        },
+        start_date: { type: 'string', description: 'Start date (YYYY-MM-DD or relative: "today", "yesterday", "7daysAgo", "30daysAgo")' },
+        end_date: { type: 'string', description: 'End date (YYYY-MM-DD or relative: "today", "yesterday")' },
+        limit: { type: 'number', description: 'Maximum number of rows to return (default 100, max 10000)' },
+        dimension_filter: {
+          type: 'object',
+          description: 'Optional dimension filter object (GA4 FilterExpression format)',
+        },
+        order_bys: {
+          type: 'array',
+          description: 'Optional ordering. Each item: { dimension: { dimensionName, orderType? } } or { metric: { metricName }, desc? }',
+          items: { type: 'object' },
+        },
+      },
+      required: ['property_id', 'metrics', 'start_date', 'end_date'],
+    },
+  },
+  {
+    name: 'ga_list_properties',
+    description: 'List all Google Analytics 4 properties accessible by the authenticated user. Uses the Admin API to fetch account summaries with property details.',
+    inputSchema: {
+      type: 'object' as const,
+      properties: {
+        page_size: { type: 'number', description: 'Maximum number of account summaries to return (default 50)' },
+        page_token: { type: 'string', description: 'Token for fetching the next page of results' },
+      },
+      required: [],
+    },
+  },
+  {
+    name: 'ga_get_realtime',
+    description: 'Get a realtime report for a Google Analytics 4 property. Shows currently active users and realtime metrics.',
+    inputSchema: {
+      type: 'object' as const,
+      properties: {
+        property_id: { type: 'string', description: 'GA4 property ID (numeric)' },
+        dimensions: {
+          type: 'array',
+          description: 'Realtime dimensions (e.g., ["city", "unifiedScreenName", "platform"])',
+          items: { type: 'string' },
+        },
+        metrics: {
+          type: 'array',
+          description: 'Realtime metrics (e.g., ["activeUsers", "screenPageViews"]). Defaults to ["activeUsers"].',
+          items: { type: 'string' },
+        },
+        limit: { type: 'number', description: 'Maximum number of rows (default 100)' },
+      },
+      required: ['property_id'],
+    },
+  },
+  {
+    name: 'ga_get_metadata',
+    description: 'List all available dimensions and metrics for a Google Analytics 4 property. Useful for discovering what fields can be used in reports.',
+    inputSchema: {
+      type: 'object' as const,
+      properties: {
+        property_id: { type: 'string', description: 'GA4 property ID (numeric)' },
+      },
+      required: ['property_id'],
+    },
+  },
+];
+
+async function callTool(name: string, args: Record<string, unknown>): Promise<unknown> {
+  const context = (args._context ?? {}) as AnalyticsContext;
+  delete args._context;
+
+  switch (name) {
+    case 'ga_run_report': {
+      const propertyId = args.property_id as string;
+      const metrics = (args.metrics as string[]).map((m) => ({ name: m }));
+      const dimensions = args.dimensions
+        ? (args.dimensions as string[]).map((d) => ({ name: d }))
+        : undefined;
+      const startDate = args.start_date as string;
+      const endDate = args.end_date as string;
+      const limit = Math.min(10000, Math.max(1, (args.limit as number) ?? 100));
+
+      const body: Record<string, unknown> = {
+        metrics,
+        dateRanges: [{ startDate, endDate }],
+        limit,
+      };
+      if (dimensions) body.dimensions = dimensions;
+      if (args.dimension_filter) body.dimensionFilter = args.dimension_filter;
+      if (args.order_bys) body.orderBys = args.order_bys;
+
+      return gFetch(context, `${DATA_API}/properties/${propertyId}:runReport`, {
+        method: 'POST',
+        body: JSON.stringify(body),
+      });
+    }
+    case 'ga_list_properties': {
+      const pageSize = Math.min(200, Math.max(1, (args.page_size as number) ?? 50));
+      const params = new URLSearchParams({ pageSize: String(pageSize) });
+      if (args.page_token) params.set('pageToken', args.page_token as string);
+      return gFetch(context, `${ADMIN_API}/accountSummaries?${params}`);
+    }
+    case 'ga_get_realtime': {
+      const propertyId = args.property_id as string;
+      const metrics = args.metrics
+        ? (args.metrics as string[]).map((m) => ({ name: m }))
+        : [{ name: 'activeUsers' }];
+      const dimensions = args.dimensions
+        ? (args.dimensions as string[]).map((d) => ({ name: d }))
+        : undefined;
+      const limit = Math.min(10000, Math.max(1, (args.limit as number) ?? 100));
+
+      const body: Record<string, unknown> = { metrics, limit };
+      if (dimensions) body.dimensions = dimensions;
+
+      return gFetch(context, `${DATA_API}/properties/${propertyId}:runRealtimeReport`, {
+        method: 'POST',
+        body: JSON.stringify(body),
+      });
+    }
+    case 'ga_get_metadata': {
+      const propertyId = args.property_id as string;
+      return gFetch(context, `${DATA_API}/properties/${propertyId}/metadata`);
+    }
+    default:
+      throw new Error(`Unknown tool: ${name}`);
+  }
+}
+
+export default { tools, callTool, meter: { credits: 15 }, provider: 'google_analytics' } satisfies McpToolExport;

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "outDir": "dist",
+    "rootDir": "src",
+    "declaration": true
+  },
+  "include": ["src"]
+}