finance_client_balance
Get the complete financial balance for a client: total sales, charges, payments, pending debt, and credits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| apiKey | No | ||
| orgSlug | Yes | ||
| clientId | Yes |
Get the complete financial balance for a client: total sales, charges, payments, pending debt, and credits.
| Name | Required | Description | Default |
|---|---|---|---|
| apiKey | No | ||
| orgSlug | Yes | ||
| clientId | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the burden. It discloses the components of the balance but does not state that the operation is read-only, require permissions, or describe return format or edge cases. It adds some context beyond the name but lacks depth for full behavioral transparency.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single sentence that front-loads the core action and lists key outputs. No redundant information or filler. Every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema and no annotations, the description is somewhat under-specified. It defines the purpose and balance components but does not mention parameter details, return structure, or any usage caveats. For a simple getter, it is minimally viable but not complete enough for an agent to fully predict behavior.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate. It only mentions 'client', which maps to clientId, but does not explain orgSlug or apiKey. The parameter names are self-explanatory to a degree, but the description adds minimal value beyond the schema, failing to fully compensate for the lack of parameter descriptions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose with a specific verb ('Get') and resource ('complete financial balance for a client'), and enumerates the components (sales, charges, payments, pending debt, credits). It is specific enough to distinguish from sibling finance tools like finance_aging or finance_list_payments.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage when a client's overall financial balance is needed, but it does not explicitly state when to use this tool over alternatives (e.g., finance_list_payments for just payments) or mention any exclusions. This is clear context without explicit guidance, so it falls at 'implied usage'.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.