Skip to main content
Glama

Reports By Location Tool

reports-by-location
Read-only

Compares revenue, activation, retention, and review-request outcomes by physical location. Does not expose customer names, invoice rows, or mutation access. Location writes stay on the in-product assistant, not MCP. Use to compare location metrics in the connected business. Returns period_days, locations, summary, 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-by-location"
  }
}

Input Schema

NameRequiredDescriptionDefault
periodNoNumber of days for location comparison metrics; defaults to 30.

Output Schema

NameRequiredDescriptionDefault
scopeYesAuthorization scope of this result; data remains restricted to the connected business.
summaryYesSummary metadata; empty collections retain their existing JSON array representation.
locationsYesBounded locations records returned by this tool.
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": {
      +    "locations": {
      +      "description": "Bounded locations records returned by this tool.",
      +      "items": {
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "period_days": {
      +      "description": "Period days for the returned result.",
      +      "type": "integer"
      +    },
      +    "scope": {
      +      "description": "Authorization scope of this result; data remains restricted to the connected business.",
      +      "enum": [
      +        "connection_business_location_aggregate_only"
      +      ],
      +      "type": "string"
      +    },
      +    "summary": {
      +      "description": "Summary metadata; empty collections retain their existing JSON array representation.",
      +      "type": [
      +        "object",
      +        "array",
      +        "null"
      +      ]
      +    }
      +  },
      +  "required": [
      +    "period_days",
      +    "locations",
      +    "summary",
      +    "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?

The annotations already declare readOnlyHint=true and destructiveHint=false, so the description's strongest contribution is the data-exposure boundary: no customer names, no invoice rows, no mutation access, and writes routed to the in-product assistant. That tells the agent what the tool will and will not surface, which the annotations do not. It stops short of mentioning latency, limits, or pagination, but for a read-only aggregate 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?

The description is front-loaded with the comparison scope, followed by the exposure limits, and closes with the return fields. Most sentences earn their place. The closing 'Returns period_days, locations, summary, scope' slightly restates the output schema, but it is brief enough not to be wasted.

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 right context is present: what is compared, what data is withheld, where writes live, and the shape of the result. With annotations covering safety and an output schema covering return values, the remaining need is small. The only real gap is sibling differentiation for the other report tools.

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%: the single 'period' parameter is already documented with an enum of 7/30/90/365 and a default of 30. The description adds nothing about the parameter, so the baseline 3 applies and the schema carries the full burden of explaining this argument.

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 and resource: 'Compares revenue, activation, retention, and review-request outcomes by physical location.' That is far more informative than the title, though it does not name the neighboring report tools (reports-overview, reports-customer-revenue-rank) it could be confused with.

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?

The description gives an implied trigger: 'Use to compare location metrics in the connected business.' It also excludes writes ('Location writes stay on the in-product assistant, not MCP'), but it never says when to choose this over reports-overview or reports-customer-revenue-rank, so the agent must infer the boundary from names alone.

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