Skip to main content
Glama

Get Dashboard Summary

get_dashboard_summary
Read-onlyIdempotent

Return a compact lifetime summary or an inclusive local-date cohort. Counts and money totals include records created in the window and use their current states; campaigns are active and affiliates are kept at read time. This does not reconstruct period-end balances or payouts paid during the window. Activation health is current.

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": "get_dashboard_summary"
  }
}

Input Schema

NameRequiredDescriptionDefault
end_dateNoInclusive local date upper bound for created_at.
timezoneNoIANA time zone used to interpret the date bounds; defaults to UTC because accounts do not store a reporting time zone.
start_dateNoInclusive local date lower bound for created_at. Omit both dates for lifetime results.

Output Schema

NameRequiredDescriptionDefault
okYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties
      Added value: +{
      +  "end_date": {
      +    "description": "Inclusive local date upper bound for created_at.",
      +    "format": "date",
      +    "type": "string"
      +  },
      +  "start_date": {
      +    "description": "Inclusive local date lower bound for created_at. Omit both dates for lifetime results.",
      +    "format": "date",
      +    "type": "string"
      +  },
      +  "timezone": {
      +    "description": "IANA time zone used to interpret the date bounds; defaults to UTC because accounts do not store a reporting time zone.",
      +    "type": "string"
      +  }
      +}
  2. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world, so the safety profile is covered. The description adds real semantic context beyond that: records are counted by created_at but valued at their current states, campaigns are live, and activation health is as-of-now rather than period-end. That materially changes how an agent should read the numbers, though nothing is said about auth, rate limits, or result size.

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?

The mode selection (lifetime vs cohort) is front-loaded in the first clause, and subsequent sentences each carry a distinct caveat with little padding. The sentences are dense and semicolon-chained, which slightly hurts scanability but nothing is redundant.

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

Completeness4/5

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

An output schema exists, so return values needn't be explained, and annotations cover the safety profile. The description fills the remaining gap that matters most for a summary tool — which time semantics the aggregates use — leaving only minor omissions such as the specific metric set or data freshness.

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% with detailed per-parameter descriptions, so the baseline is 3. The description goes modestly beyond it by framing the date bounds as a 'cohort' filtered on created_at whose aggregates still use current state, clarifying the semantics of the window rather than just its type.

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

Purpose4/5

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

The opening sentence gives a specific verb and resource — return a compact lifetime summary or an inclusive local-date cohort — which is a clear statement of what the tool produces and its two modes. It does not name any sibling or say which metrics/components the summary aggregates, so the agent still has to infer scope from 'counts and money totals'. Clear but not fully differentiated.

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

Usage Guidelines3/5

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

Usage is implied rather than stated: omit both dates for lifetime, supply them for a cohort (though the schema already says this). The one genuinely useful exclusion — 'does not reconstruct period-end balances or payouts paid during the window' — steers the agent away from using it for payout-period reporting, but no sibling such as list_payouts or list_commissions is named as the alternative.

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