Skip to main content
Glama

Get settlement plan

get_settlement_plan
Read-only

Minimal list of transfers that settles the group. include_pending also counts payments awaiting confirmation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
group_idYes
include_pendingNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
inboxNo
currencyYes
transfersYes
suggested_nextYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds the definition of include_pending (counts payments awaiting confirmation), but says nothing about whether the plan is advisory versus executable, ordering of transfers, or what happens when the group is already settled.

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 tight sentences with no waste; the purpose is front-loaded ahead of the parameter note. Nothing is padded, though the second sentence could be clearer that it is describing the include_pending flag.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values need no explanation, and annotations cover read-only safety. For a compute-style read tool with a required group_id, the description is minimally viable but leaves usage context and the effect of a settled group unstated.

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 description coverage is 0%, so the description must carry the load. It explains include_pending clearly, but group_id — the sole required parameter — is left entirely unexplained (its name and uuid format make it self-evident, which limits the harm).

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 resource — the minimal set of transfers that settles a group — using a clear noun phrase that distinguishes it from siblings like get_balances (which shows balances, not transfers) and list_payments (which lists raw payments). It is clear but stops short of explicitly naming those siblings to reinforce the distinction.

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

Usage Guidelines2/5

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

There is no explicit when-to-use or when-not-to-use guidance and no named alternatives. The agent must infer that this is the tool for computing settlement transfers rather than reading balances or payments; nothing routes it against get_balances or list_payments.

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.