Skip to main content
Glama

supermetrics_guide

Read-onlyIdempotent

Explain what Supermetrics can do, what's new, or how to fix a common problem.

Use mode="tour" (the default) for what the user can do; mode="whats_new" for recent changes. Not for looking up data sources, accounts or fields. Call tour/whats_new at most once per conversation.

TROUBLESHOOTING: when the user reports a common problem, fetch the matching guide and walk them through it before offering a support ticket. Connecting / access: connect_data_source (sign-in / "no accounts found"), google_connectors (GA4/Search Console/YouTube/etc. access), meta_instagram (Facebook/Instagram setup), microsoft_connectors (Microsoft Ads/Bing Webmaster), linkedin_connectors (Ads vs Company Pages), tiktok_connectors (Ads vs Organic), x_twitter_connectors (X Ads vs X Organic), amazon_connectors (Ads/DSP/Seller/Vendor), data_warehouse (BigQuery/Snowflake), reconnect (expired connection). Licensing and accounts: license_and_trials (LICENSE_NOT_FOUND / trial expired), cancel_trial (cancel a trial or subscription, "will I be charged?"), data_source_on_plan (LICENSE_DATA_SOURCE_NOT_AVAILABLE), destination_on_plan (AI Chats destination missing), prioritized_accounts ("not a prioritised account"), manage_users_and_accounts (adding users/accounts and making a new account usable), pricing_and_purchasing (buying questions: plans, how accounts are counted, AI credits, billing). Data and queries: no_data (empty results), data_discrepancies (numbers don't match the platform), ga4_data (GA4 sampling/thresholding/partial data), query_errors (date/field/account errors), quotas_and_limits (quota exceeded). Campaigns: write_access. Social posts: social_publishing (publishing, scheduling, comments with manage_social_media). Each returns steps the user can follow without Supermetrics staff.

HOW TO: google_sheets — fetch before putting Supermetrics data into a Google Sheet. It builds the sheet so the Supermetrics add-on refreshes it automatically on a schedule (or on demand). dashboard_bigquery — fetch before building a Studio dashboard on BigQuery data.

CAPABILITIES: before writing to a platform, fetch its capability guide (one per connector, see mode) for the operations, platform_settings keys, targeting fields and platform rules (limits, refusals) that connector applies — kept with the connector code, so it beats guessing from an error.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "supermetrics_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
modeNoUse "tour" (the default) for what the user can do with Supermetrics, or "whats_new" for recent changes. The remaining values are troubleshooting guides for common problems. Connecting/access: connect_data_source, google_connectors, meta_instagram, microsoft_connectors, linkedin_connectors, tiktok_connectors, x_twitter_connectors, amazon_connectors, data_warehouse, reconnect. Licensing and accounts: license_and_trials, cancel_trial, data_source_on_plan, destination_on_plan, prioritized_accounts, manage_users_and_accounts, pricing_and_purchasing. Data and queries: no_data, data_discrepancies, ga4_data, query_errors, quotas_and_limits. Campaigns: write_access, plus one capability guide per connector (google_ads_capabilities, facebook_meta_capabilities, microsoft_advertising_capabilities, tiktok_ads_capabilities, linkedin_ads_capabilities, chatgpt_ads_capabilities, snapchat_marketing_capabilities) listing the operations, keys, targeting fields and rules that connector applies. Social posts: social_publishing. How-to: google_sheets (auto-refreshing Google Sheet), dashboard_bigquery (Studio dashboard on BigQuery).

Output Schema

NameRequiredDescriptionDefault
dataNo
errorNo
notesNo
successYes
business_contextNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds genuinely useful behavior beyond that: each guide returns steps the user can follow without staff, and the once-per-conversation limit. It stops short of describing output shape, but an output schema exists.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It is long but front-loaded and organized under clear headers (TROUBLESHOOTING, HOW TO, CAPABILITIES), so an agent can scan to the relevant section. There is some duplication between the description's mode list and the schema's mode description, which costs a point.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-parameter read-only guide tool with an output schema, the description covers everything needed: what each mode returns, when to call it, how often, and what to do before write operations. Nothing an agent needs in order to invoke it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the mode parameter is already enumerated in the schema. The description still adds value by naming the default and explaining the intent behind each mode family (troubleshooting, capabilities, how-to), which helps an agent pick a value rather than just read a list.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The opening sentence names a specific verb and resource: explain what Supermetrics can do, what's new, or how to fix a common problem. It also draws a boundary against siblings ("Not for looking up data sources, accounts or fields"), so an agent can route correctly without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives explicit mode selection (tour default vs whats_new), a frequency constraint (at most once per conversation), and a full routing table mapping user symptoms to the correct guide. It also states the ordering rule: fetch the capability guide before writing to a platform.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources