Skip to main content
Glama

List invoices

halaxy_list_invoices
Read-only

List or search invoices of the practice group. Filters combine with AND. Paged: pass next_page as page. GET /main/Invoice.

Input Schema

NameRequiredDescriptionDefault
idNoOne id or several separated by commas, for example 1,2,3.
pageNoPage number, 1-based (default 1). Use next_page from the previous reply.
countNoResults per page, 1-100 (default 30).
statusNoInvoice status.
createdNoCreated (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le).
includeNoAlso return related resources in "included": any of Invoice:recipient, Invoice:practitioner.
recipientNoThe invoice recipient (a Patient or Organization id).
total_paidNoTotal paid amount, optionally with a prefix such as gt0.
last_updatedNoOnly records last updated at this time (ISO date or date-time, optional prefix eq/ne/gt/lt/ge/le).
organizationNoThe clinic the invoice was created at.
practitionerNoPractitioner id.
total_balanceNoBalance owing, optionally with a prefix such as gt0 (finds unpaid invoices).
include_iterateNoAlso return resources related to an included one (needs the matching include): any of PractitionerRole:practitioner, PractitionerRole:organization.
practitioner_roleNoPractitionerRole id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

With readOnlyHint=true the safety profile is already covered. The description adds real behavioral value by stating filters combine with AND and that pagination uses next_page passed as page, but it never says the reply actually contains next_page or what the payload looks like, leaving the pagination loop half-described.

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 purpose before the filtering and paging mechanics. The trailing 'GET /main/Invoice' endpoint is slightly gratuitous for an agent but costs little.

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 14-parameter, zero-required list tool with no output schema, the description covers filtering and paging but omits the response shape (items vs. 'included' array, presence of next_page). The 'include'/'include_iterate' expansion behavior is only explained in the schema, not in prose.

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%, so all 14 parameters are already documented in the schema; baseline is 3. The description adds only the next_page-to-page mapping, which is a convenience pointer rather than new parameter semantics.

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?

States a specific verb and resource ('List or search invoices') plus scope ('of the practice group'), which distinguishes it from the singular halaxy_get_invoice. It does not explicitly separate itself from halaxy_list_invoice_lines, but the resource noun makes the boundary inferable.

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 implied by the filter list and the 'Paged' note, so an agent can infer search vs. paginate flows. However, there is no explicit guidance on when to prefer this over halaxy_get_invoice or halaxy_list_invoice_lines, and no prerequisite information.

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.