Skip to main content
Glama

Get organisation summary

get_organisation_summary
Read-onlyIdempotent

Returns receivables totals for the organisation: amount outstanding, amount overdue, unpaid and overdue invoice counts and the number of active contacts. Totals are in the organisation's base currency. Use it for a quick overview before drilling into invoices or contacts. Read only.

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": {
      "organisationId": "<organisationId>"
    },
    "name": "get_organisation_summary"
  }
}

Input Schema

NameRequiredDescriptionDefault
organisationIdYesId of the organisation to act on, from list_organisations

Output Schema

NameRequiredDescriptionDefault
currencyYes
contactCountYesNumber of active contacts. Archived contacts are not counted.
overdueTotalYes
outstandingTotalYes
unpaidInvoiceCountYes
overdueInvoiceCountYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, and the closing "Read only" merely restates readOnlyHint. The genuinely additive behavioral fact is that all totals are returned in the organisation's base currency, but nothing is said about freshness/staleness of the aggregates or whether archived records are counted.

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?

Three short sentences, front-loaded with the returned fields before the usage hint; nothing is buried. The trailing "Read only." is redundant with the annotations and is the one line that does not earn its place.

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 the description need not explain return shapes, and the one required parameter is fully documented. What it supplies — scope, currency basis, and a usage cue — is sufficient for correct invocation, with only aggregate freshness left implicit.

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% for the single parameter, and its description ("Id of the organisation to act on, from list_organisations") is already complete. The description adds no further meaning about organisationId, so the baseline of 3 applies.

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?

States a specific verb and resource ("Returns receivables totals for the organisation") and enumerates exactly what is included: amount outstanding, overdue amount, unpaid/overdue invoice counts, active contact count. It also fixes the currency semantics ("organisation's base currency"), which lets an agent distinguish this snapshot tool from list/get siblings like list_invoices or get_organisation.

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

Usage Guidelines4/5

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

"Use it for a quick overview before drilling into invoices or contacts" gives clear when-to-use context and implicitly points at the drill-down siblings. It stops short of naming those siblings explicitly or stating exclusions (e.g. don't use for per-invoice detail), so it is strong but not exhaustive.

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