Skip to main content
Glama

Report on one store

get_report
Read-onlyIdempotent

Reports on one store the person owns, one area at a time, with the dashboard's own figures. results: per-day figures and totals for the period (conversations, cart adds, orders and revenue from chat, ratings, popups, unanswered questions), the products the chat showed and added to the cart most, the pages it answered from, and handoffs to the team. inbox: shoppers waiting for the team now, requests awaiting follow-up, missed requests, open unanswered questions, low-rated chats to review and customer email counts. catalog: product and page counts, catalogue health, promoted products, sync status and sync problems (dates and counts), and the plugin version. settings: the chat's look and texts per language, popups, team hours and away messages, rules and their status, alert channel kinds, allowed sites, the country filter and switches. billing: spend and usage this period, credit left, the monthly cap and how much of it is used. Counts, catalogue data and settings only: no conversation or email text, nothing a shopper wrote, no contact details and no secrets. dashboard_url opens the matching dashboard page for this store.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "store_id": "<store_id>",
      "area": "<area>"
    },
    "name": "get_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
areaYes
periodNoThe days results and inbox cover, in UTC: the last 7, 30 or 90 days, or mtd (this month so far). The other areas are as they stand now.30d
store_idYesThe store's store_id (not its name).

Output Schema

NameRequiredDescriptionDefault
toNo
areaYes
fromNo
nameNo
inboxNo
billingNo
catalogNo
resultsNo
settingsNo
store_idYes
dashboard_urlYes
dashboard_pagesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. Beyond that, the description adds a genuinely useful disclosure: it is counts, catalogue data and settings only, with no conversation or email text, no shopper-written content, no contact details and no secrets, plus a dashboard_url for the matching page.

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

Conciseness3/5

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

The purpose and privacy boundary come first, which is good front-loading, but the middle is one long dense sentence packing five area lists into a single paragraph. Much of that enumeration restates what the output schema already carries.

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?

Given three simple parameters, existing annotations and an output schema, the definition covers purpose, area semantics and the privacy boundary well. The main remaining gap is that it never says how this relates to sibling tools that return adjacent data such as conversations, unanswered questions or store settings.

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 67%, with store_id and period already documented in the schema. The description materially explains each area enum value by listing what it returns, which the schema does not, but it adds nothing about store_id formatting or how period is ignored for catalog, settings and billing.

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 ("Reports on one store the person owns") and scopes it to one area at a time with the dashboard's own figures, which separates it from a plain store lookup. It never names a sibling such as get_store to route against, so the differentiation is inferred rather than stated.

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?

"One area at a time" implies the caller must pick the right area value, and the per-area enumeration helps that choice. However, there is no explicit when-to-use note, no mention of when to prefer get_store, list_conversations or list_customer_emails instead, and no statement of prerequisites or cost.

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