Skip to main content
Glama

insync_get_balance

Read-only

Retrieve a patient's account balance, including the net amount owed and any credit balance, to review financial status and payment obligations.

Instructions

Get the patient account balance: the amount owed (net due) and any credit balance.

Input Schema

NameRequiredDescriptionDefault
viewNoResponse shape: "compact" (default) drops fields the response already carries elsewhere; "full" returns every field this server understands; "raw" returns the upstream payload unprojected. compact projects each record to the fields a caller acts on; "full" keeps every field this server understands; "raw" returns the portal payload untouched.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description usefully names the two components returned (net due and credit balance), but omits whose balance (authenticated patient vs. a supplied id) and any error or empty-account behavior.

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

Conciseness5/5

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

One front-loaded sentence with no filler; the key distinction (owed vs. credit) is stated immediately after the verb.

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?

For a trivial one-optional-param read with no output schema, stating the returned components is genuinely helpful, but the description leaves the account scoping implicit and says nothing about what happens when there is no balance. Adequate, not complete.

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 100% and the single `view` enum is thoroughly documented in the schema itself, so the baseline of 3 applies. The description adds no guidance on which view to pick for balance data.

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?

Names a specific verb and resource (get the patient account balance) and clarifies the payload as net due plus any credit balance. It does not need to differentiate against siblings since none of them return balances, though it also never says so explicitly.

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?

Usage is only implied by the resource name; there is no statement of when to call this versus siblings like insync_get_counts or insync_get_profile, and no preconditions. An agent can infer it, but nothing routes it.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.