Skip to main content
Glama

Reports Overview Tool

reports-overview
Read-only

Reads aggregate revenue, receivables, job, lead, and estimate performance for the authenticated workspace without exposing customer names, addresses, invoice rows, or mutation access. Use to inspect business performance totals in the connected business. Returns period_days, revenue, outstanding, jobs, leads, quotes, scope.

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": "reports-overview"
  }
}

Input Schema

NameRequiredDescriptionDefault
periodNoNumber of days for the bounded trend metrics; defaults to 30.

Output Schema

NameRequiredDescriptionDefault
jobsYesJobs data returned by the authorized safe projection.
leadsYesLeads data returned by the authorized safe projection.
scopeYesAuthorization scope of this result; data remains restricted to the connected business.
quotesYesQuotes data returned by the authorized safe projection.
revenueYesRevenue metadata; empty collections retain their existing JSON array representation.
outstandingYesOutstanding metadata; empty collections retain their existing JSON array representation.
period_daysYesPeriod days for the returned result.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "jobs": {
      +      "description": "Jobs data returned by the authorized safe projection.",
      +      "type": [
      +        "object",
      +        "array"
      +      ]
      +    },
      +    "leads": {
      +      "description": "Leads data returned by the authorized safe projection.",
      +      "type": [
      +        "object",
      +        "array"
      +      ]
      +    },
      +    "outstanding": {
      +      "description": "Outstanding metadata; empty collections retain their existing JSON array representation.",
      +      "type": [
      +        "object",
      +        "array",
      +        "null"
      +      ]
      +    },
      +    "period_days": {
      +      "description": "Period days for the returned result.",
      +      "type": "integer"
      +    },
      +    "quotes": {
      +      "description": "Quotes data returned by the authorized safe projection.",
      +      "type": [
      +        "object",
      +        "array"
      +      ]
      +    },
      +    "revenue": {
      +      "description": "Revenue metadata; empty collections retain their existing JSON array representation.",
      +      "type": [
      +        "object",
      +        "array",
      +        "null"
      +      ]
      +    },
      +    "scope": {
      +      "description": "Authorization scope of this result; data remains restricted to the connected business.",
      +      "enum": [
      +        "connection_business_aggregate_only"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "period_days",
      +    "revenue",
      +    "outstanding",
      +    "jobs",
      +    "leads",
      +    "quotes",
      +    "scope"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds genuinely new behavioral context beyond that: the aggregate-only scope, the explicit exclusion of customer names, addresses, and invoice rows, and the absence of mutation access. It does not cover pagination or limits, but for an aggregate report that is a minor omission.

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?

Two sentences with the privacy constraint and scope front-loaded, followed by a return-field list. The trailing field enumeration ('Returns period_days, revenue, outstanding...') is somewhat redundant given an output schema exists, but it is short and not disruptive.

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?

The tool is simple (one optional parameter, output schema present), and the description covers scope, exclusions, and safety context. An agent has enough to call it correctly; only the choice between this and sibling report tools remains underspecified.

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

Parameters3/5

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

Schema coverage is 100% and the single 'period' parameter has an enum, default, and description in the schema, so the schema does the heavy lifting. The description only echoes 'period_days' in the return list and adds no new semantics such as how the window bounds the trend metrics.

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 description states a specific verb (reads) and resource (aggregate revenue, receivables, job, lead, and estimate performance) scoped to the authenticated workspace. The privacy framing ('without exposing customer names, addresses, invoice rows') implicitly distinguishes it from customer-level siblings such as reports-customer-revenue-rank, but no sibling is named explicitly.

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?

'Use to inspect business performance totals in the connected business' gives an implied usage context but no explicit when-not conditions or routing to alternatives. With sibling tools like reports-by-location and reports-customer-revenue-rank present, the agent must infer which report to pick without help from this description.

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