Skip to main content
Glama

SmartBill MCP by usefulapi

Get invoice payment status

smartbill_get_invoice_payment_status
Read-only

Whether an invoice is paid and how much remains: invoiceTotalAmount, paidAmount, unpaidAmount and the paid flag. GET /invoice/paymentstatus.

Input Schema

NameRequiredDescriptionDefault
numberYesDocument number as text, e.g. "0025" (keep leading zeros).
series_nameYesDocument series name exactly as configured in SmartBill Cloud (smartbill_list_series lists them).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations declare readOnlyHint=true, so the safety profile is covered. The description adds genuine behavioral value by disclosing the shape of the result (three amounts plus a paid flag), which is otherwise undocumented since there is no output schema. It does not contradict the 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?

Two tight sentences with the value proposition front-loaded; the only near-waste is the trailing 'GET /invoice/paymentstatus' endpoint token, which restates the obvious but is cheap.

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?

With no output schema and only two fully documented parameters, the description fairly compensates by naming the returned amounts and paid flag. It stops short of note on error behavior (e.g., unknown series/number), which would make it 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 coverage is 100%: the schema already documents 'number' (with leading-zero guidance) and 'series_name' (pointing at smartbill_list_series). The description adds no parameter-level detail beyond that, which lands at the baseline for fully documented schemas.

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 ('whether an invoice is paid and how much remains') and immediately enumerates the exact fields returned (invoiceTotalAmount, paidAmount, unpaidAmount, paid flag), which cleanly separates it from the write-side sibling smartbill_record_invoice_payment.

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 when-to-use guidance, no mention of the read-vs-write alternative (smartbill_record_invoice_payment), and no prerequisites such as the invoice needing to exist. Usage is only inferable from the tool name.

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.