Skip to main content
Glama

Dashboard summary

get_dashboard_summary
Read-onlyIdempotent

Use this when the user asks how the business is doing: invoiced and collected this month, outstanding and overdue amounts, recent invoices or approvals waiting. The business dashboard's figures: per currency this month's invoiced total; paid (all-time total of fully paid invoices); collected_this_month (money received this calendar month in Dubai time, by payment date: part payments included, bank charges left out, refunds subtracted, so it can be negative); outstanding, overdue count and amount; total invoice count; the most overdue invoices; the newest invoices; and documents waiting for approval. Do not use it for profit (get_profit_and_loss) or for what to pay or file next (get_whats_due).

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
business_idNoFrom list_businesses. May be left out when the connection shares exactly one business.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already establish that this is a safe, read-only, idempotent summary. Beyond that, the description adds substantial behavioral meaning: collected_this_month is calendar-month, Dubai-time, payment-date based, includes part payments, excludes bank charges, subtracts refunds, and can be negative; paid is all-time fully paid; figures are per currency. These are material disclosure details not present in annotations.

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 usage trigger, then follows with a dense but purposeful enumeration of dashboard fields, and ends with exclusions. The long metric sentence is justified because there is no output schema, though it could be made more scannable with bullets.

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?

There is no output schema, so the description must carry the return-value burden, and it does: it lists the key metrics, defines collected_this_month carefully, notes per-currency behavior, and covers overdue/new invoices and approval documents. It also gives adjacent-tool routing, making the definition complete for calling this summary tool correctly.

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?

The schema has 100% description coverage for the single optional business_id parameter, so the schema already explains where to obtain it and when it may be omitted. The description adds no parameter-level guidance, but with complete schema coverage and only one optional parameter, the baseline score of 3 is appropriate.

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 description states a specific user intent ("how the business is doing") and enumerates the dashboard figures returned, making the resource and scope concrete. It explicitly distinguishes itself from get_profit_and_loss and get_whats_due, so an agent can select it 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 an explicit when-to-use trigger ("when the user asks how the business is doing") with examples such as invoiced/collected amounts, overdue amounts, recent invoices, and approvals waiting. It also names two clear exclusions with the sibling tools to use instead: profit via get_profit_and_loss and pay/file obligations via get_whats_due.

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