Skip to main content
Glama

Invoice Tool

invoice-tool
Read-only

Query invoices. Actions: "list" — query invoices with filtering, sorting, pagination. "show" — get a single invoice by ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for "list". Default 1.
sortNoSort fields for "list". Append :asc or :desc for direction (default :asc). Example: ["created_at:desc"]. Available fields: id, number, number_prefix, user_id, deal_id, status, date_due, date_paid, billing_at, credit, subtotal_converted, total_converted, subtotal, total, tax, tax_name, tax_percent, currency, reason, note, user_data, ip_address, user_agent, sender_address, recurring, recurring_generated, coupon_id, transaction_id, stripe_invoice_id, billing_reason, payment_intent_id, loc_confirm, paysys, stripe_payment_mode, allowed_payment_integrations, partial_payment, employee_id, created_at, updated_at, pretty_number, invoices.id, invoices.number, invoices.number_prefix, invoices.user_id, invoices.deal_id, invoices.status, invoices.date_due, invoices.date_paid, invoices.billing_at, invoices.credit, invoices.subtotal_converted, invoices.total_converted, invoices.subtotal, invoices.total, invoices.tax, invoices.tax_name, invoices.tax_percent, invoices.currency, invoices.reason, invoices.note, invoices.user_data, invoices.ip_address, invoices.user_agent, invoices.sender_address, invoices.recurring, invoices.recurring_generated, invoices.coupon_id, invoices.transaction_id, invoices.stripe_invoice_id, invoices.billing_reason, invoices.payment_intent_id, invoices.loc_confirm, invoices.paysys, invoices.stripe_payment_mode, invoices.allowed_payment_integrations, invoices.partial_payment, invoices.employee_id, invoices.created_at, invoices.updated_at, invoices.pretty_number, audits, subscription, subscription_payment, user, deal, invoice_items, orders, invoice_sender_address, billing_address, coupon, employee, clientTags, logs.
limitNoResults per page for "list". Default 20, max 100.
actionYesAction to perform.
filtersNoPurity filter object for "list". Keys are field names, values are operator objects. Example: {"status":{"$eq":1}}. Available fields: id, number, number_prefix, user_id, deal_id, status, date_due, date_paid, billing_at, credit, subtotal_converted, total_converted, subtotal, total, tax, tax_name, tax_percent, currency, reason, note, user_data, ip_address, user_agent, sender_address, recurring, recurring_generated, coupon_id, transaction_id, stripe_invoice_id, billing_reason, payment_intent_id, loc_confirm, paysys, stripe_payment_mode, allowed_payment_integrations, partial_payment, employee_id, created_at, updated_at, pretty_number, invoices.id, invoices.number, invoices.number_prefix, invoices.user_id, invoices.deal_id, invoices.status, invoices.date_due, invoices.date_paid, invoices.billing_at, invoices.credit, invoices.subtotal_converted, invoices.total_converted, invoices.subtotal, invoices.total, invoices.tax, invoices.tax_name, invoices.tax_percent, invoices.currency, invoices.reason, invoices.note, invoices.user_data, invoices.ip_address, invoices.user_agent, invoices.sender_address, invoices.recurring, invoices.recurring_generated, invoices.coupon_id, invoices.transaction_id, invoices.stripe_invoice_id, invoices.billing_reason, invoices.payment_intent_id, invoices.loc_confirm, invoices.paysys, invoices.stripe_payment_mode, invoices.allowed_payment_integrations, invoices.partial_payment, invoices.employee_id, invoices.created_at, invoices.updated_at, invoices.pretty_number, audits, subscription, subscription_payment, user, deal, invoice_items, orders, invoice_sender_address, billing_address, coupon, employee, clientTags, logs. Status filter key is "status" (numeric IDs, not string names): 0=abandoned, 1=paid, 6=partially_paid, 5=payment_pending, 8=refund, 4=refunded, 3=unpaid, 7=void.
invoice_idNoInvoice id. Required for "show" actions.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / filters / description
      Previous value: -"Purity filter object for \"list\". Keys are field names, values are operator objects. Example: {\"status\":{\"$eq\":1}}. Available fields: id, number, number_prefix, user_id, deal_id, status, date_due, date_paid, billing_at, credit, subtotal_converted, total_converted, subtotal, total, tax, tax_name, tax_percent, currency, reason, note, user_data, ip_address, user_agent, sender_address, recurring, recurring_generated, coupon_id, transaction_id, stripe_invoice_id, billing_reason, payment_intent_id, loc_confirm, paysys, stripe_payment_mode, allowed_payment_integrations, partial_payment, employee_id, created_at, updated_at, pretty_number, invoices.id, invoices.number, invoices.number_prefix, invoices.user_id, invoices.deal_id, invoices.status, invoices.date_due, invoices.date_paid, invoices.billing_at, invoices.credit, invoices.subtotal_converted, invoices.total_converted, invoices.subtotal, invoices.total, invoices.tax, invoices.tax_name, invoices.tax_percent, invoices.currency, invoices.reason, invoices.note, invoices.user_data, invoices.ip_address, invoices.user_agent, invoices.sender_address, invoices.recurring, invoices.recurring_generated, invoices.coupon_id, invoices.transaction_id, invoices.stripe_invoice_id, invoices.billing_reason, invoices.payment_intent_id, invoices.loc_confirm, invoices.paysys, invoices.stripe_payment_mode, invoices.allowed_payment_integrations, invoices.partial_payment, invoices.employee_id, invoices.created_at, invoices.updated_at, invoices.pretty_number, audits, subscription, subscription_payment, user, invoice_items, orders, invoice_sender_address, billing_address, coupon, employee, clientTags, logs. Status filter key is \"status\" (numeric IDs, not string names): 0=abandoned, 1=paid, 6=partially_paid, 5=payment_pending, 8=refund, 4=refunded, 3=unpaid, 7=void."New value: +"Purity filter object for \"list\". Keys are field names, values are operator objects. Example: {\"status\":{\"$eq\":1}}. Available fields: id, number, number_prefix, user_id, deal_id, status, date_due, date_paid, billing_at, credit, subtotal_converted, total_converted, subtotal, total, tax, tax_name, tax_percent, currency, reason, note, user_data, ip_address, user_agent, sender_address, recurring, recurring_generated, coupon_id, transaction_id, stripe_invoice_id, billing_reason, payment_intent_id, loc_confirm, paysys, stripe_payment_mode, allowed_payment_integrations, partial_payment, employee_id, created_at, updated_at, pretty_number, invoices.id, invoices.number, invoices.number_prefix, invoices.user_id, invoices.deal_id, invoices.status, invoices.date_due, invoices.date_paid, invoices.billing_at, invoices.credit, invoices.subtotal_converted, invoices.total_converted, invoices.subtotal, invoices.total, invoices.tax, invoices.tax_name, invoices.tax_percent, invoices.currency, invoices.reason, invoices.note, invoices.user_data, invoices.ip_address, invoices.user_agent, invoices.sender_address, invoices.recurring, invoices.recurring_generated, invoices.coupon_id, invoices.transaction_id, invoices.stripe_invoice_id, invoices.billing_reason, invoices.payment_intent_id, invoices.loc_confirm, invoices.paysys, invoices.stripe_payment_mode, invoices.allowed_payment_integrations, invoices.partial_payment, invoices.employee_id, invoices.created_at, invoices.updated_at, invoices.pretty_number, audits, subscription, subscription_payment, user, deal, invoice_items, orders, invoice_sender_address, billing_address, coupon, employee, clientTags, logs. Status filter key is \"status\" (numeric IDs, not string names): 0=abandoned, 1=paid, 6=partially_paid, 5=payment_pending, 8=refund, 4=refunded, 3=unpaid, 7=void."
    • changedInput schema / properties / sort / description
      Previous value: -"Sort fields for \"list\". Append :asc or :desc for direction (default :asc). Example: [\"created_at:desc\"]. Available fields: id, number, number_prefix, user_id, deal_id, status, date_due, date_paid, billing_at, credit, subtotal_converted, total_converted, subtotal, total, tax, tax_name, tax_percent, currency, reason, note, user_data, ip_address, user_agent, sender_address, recurring, recurring_generated, coupon_id, transaction_id, stripe_invoice_id, billing_reason, payment_intent_id, loc_confirm, paysys, stripe_payment_mode, allowed_payment_integrations, partial_payment, employee_id, created_at, updated_at, pretty_number, invoices.id, invoices.number, invoices.number_prefix, invoices.user_id, invoices.deal_id, invoices.status, invoices.date_due, invoices.date_paid, invoices.billing_at, invoices.credit, invoices.subtotal_converted, invoices.total_converted, invoices.subtotal, invoices.total, invoices.tax, invoices.tax_name, invoices.tax_percent, invoices.currency, invoices.reason, invoices.note, invoices.user_data, invoices.ip_address, invoices.user_agent, invoices.sender_address, invoices.recurring, invoices.recurring_generated, invoices.coupon_id, invoices.transaction_id, invoices.stripe_invoice_id, invoices.billing_reason, invoices.payment_intent_id, invoices.loc_confirm, invoices.paysys, invoices.stripe_payment_mode, invoices.allowed_payment_integrations, invoices.partial_payment, invoices.employee_id, invoices.created_at, invoices.updated_at, invoices.pretty_number, audits, subscription, subscription_payment, user, invoice_items, orders, invoice_sender_address, billing_address, coupon, employee, clientTags, logs."New value: +"Sort fields for \"list\". Append :asc or :desc for direction (default :asc). Example: [\"created_at:desc\"]. Available fields: id, number, number_prefix, user_id, deal_id, status, date_due, date_paid, billing_at, credit, subtotal_converted, total_converted, subtotal, total, tax, tax_name, tax_percent, currency, reason, note, user_data, ip_address, user_agent, sender_address, recurring, recurring_generated, coupon_id, transaction_id, stripe_invoice_id, billing_reason, payment_intent_id, loc_confirm, paysys, stripe_payment_mode, allowed_payment_integrations, partial_payment, employee_id, created_at, updated_at, pretty_number, invoices.id, invoices.number, invoices.number_prefix, invoices.user_id, invoices.deal_id, invoices.status, invoices.date_due, invoices.date_paid, invoices.billing_at, invoices.credit, invoices.subtotal_converted, invoices.total_converted, invoices.subtotal, invoices.total, invoices.tax, invoices.tax_name, invoices.tax_percent, invoices.currency, invoices.reason, invoices.note, invoices.user_data, invoices.ip_address, invoices.user_agent, invoices.sender_address, invoices.recurring, invoices.recurring_generated, invoices.coupon_id, invoices.transaction_id, invoices.stripe_invoice_id, invoices.billing_reason, invoices.payment_intent_id, invoices.loc_confirm, invoices.paysys, invoices.stripe_payment_mode, invoices.allowed_payment_integrations, invoices.partial_payment, invoices.employee_id, invoices.created_at, invoices.updated_at, invoices.pretty_number, audits, subscription, subscription_payment, user, deal, invoice_items, orders, invoice_sender_address, billing_address, coupon, employee, clientTags, logs."
  2. Changed2 schema fields changed
    • changedInput schema / properties / filters / description
      Previous value: -"Purity filter object for \"list\". Keys are field names, values are operator objects. Example: {\"status\":{\"$eq\":1}}. Available fields: id, number, number_prefix, user_id, status, date_due, date_paid, billing_at, credit, subtotal_converted, total_converted, subtotal, total, tax, tax_name, tax_percent, currency, reason, note, user_data, ip_address, user_agent, sender_address, recurring, recurring_generated, coupon_id, transaction_id, stripe_invoice_id, billing_reason, payment_intent_id, loc_confirm, paysys, stripe_payment_mode, allowed_payment_integrations, partial_payment, employee_id, created_at, updated_at, pretty_number, invoices.id, invoices.number, invoices.number_prefix, invoices.user_id, invoices.status, invoices.date_due, invoices.date_paid, invoices.billing_at, invoices.credit, invoices.subtotal_converted, invoices.total_converted, invoices.subtotal, invoices.total, invoices.tax, invoices.tax_name, invoices.tax_percent, invoices.currency, invoices.reason, invoices.note, invoices.user_data, invoices.ip_address, invoices.user_agent, invoices.sender_address, invoices.recurring, invoices.recurring_generated, invoices.coupon_id, invoices.transaction_id, invoices.stripe_invoice_id, invoices.billing_reason, invoices.payment_intent_id, invoices.loc_confirm, invoices.paysys, invoices.stripe_payment_mode, invoices.allowed_payment_integrations, invoices.partial_payment, invoices.employee_id, invoices.created_at, invoices.updated_at, invoices.pretty_number, audits, subscription, subscription_payment, user, invoice_items, orders, invoice_sender_address, billing_address, coupon, employee, clientTags, logs. Status filter key is \"status\" (numeric IDs, not string names): 0=abandoned, 1=paid, 6=partially_paid, 5=payment_pending, 8=refund, 4=refunded, 3=unpaid, 7=void."New value: +"Purity filter object for \"list\". Keys are field names, values are operator objects. Example: {\"status\":{\"$eq\":1}}. Available fields: id, number, number_prefix, user_id, deal_id, status, date_due, date_paid, billing_at, credit, subtotal_converted, total_converted, subtotal, total, tax, tax_name, tax_percent, currency, reason, note, user_data, ip_address, user_agent, sender_address, recurring, recurring_generated, coupon_id, transaction_id, stripe_invoice_id, billing_reason, payment_intent_id, loc_confirm, paysys, stripe_payment_mode, allowed_payment_integrations, partial_payment, employee_id, created_at, updated_at, pretty_number, invoices.id, invoices.number, invoices.number_prefix, invoices.user_id, invoices.deal_id, invoices.status, invoices.date_due, invoices.date_paid, invoices.billing_at, invoices.credit, invoices.subtotal_converted, invoices.total_converted, invoices.subtotal, invoices.total, invoices.tax, invoices.tax_name, invoices.tax_percent, invoices.currency, invoices.reason, invoices.note, invoices.user_data, invoices.ip_address, invoices.user_agent, invoices.sender_address, invoices.recurring, invoices.recurring_generated, invoices.coupon_id, invoices.transaction_id, invoices.stripe_invoice_id, invoices.billing_reason, invoices.payment_intent_id, invoices.loc_confirm, invoices.paysys, invoices.stripe_payment_mode, invoices.allowed_payment_integrations, invoices.partial_payment, invoices.employee_id, invoices.created_at, invoices.updated_at, invoices.pretty_number, audits, subscription, subscription_payment, user, invoice_items, orders, invoice_sender_address, billing_address, coupon, employee, clientTags, logs. Status filter key is \"status\" (numeric IDs, not string names): 0=abandoned, 1=paid, 6=partially_paid, 5=payment_pending, 8=refund, 4=refunded, 3=unpaid, 7=void."
    • changedInput schema / properties / sort / description
      Previous value: -"Sort fields for \"list\". Append :asc or :desc for direction (default :asc). Example: [\"created_at:desc\"]. Available fields: id, number, number_prefix, user_id, status, date_due, date_paid, billing_at, credit, subtotal_converted, total_converted, subtotal, total, tax, tax_name, tax_percent, currency, reason, note, user_data, ip_address, user_agent, sender_address, recurring, recurring_generated, coupon_id, transaction_id, stripe_invoice_id, billing_reason, payment_intent_id, loc_confirm, paysys, stripe_payment_mode, allowed_payment_integrations, partial_payment, employee_id, created_at, updated_at, pretty_number, invoices.id, invoices.number, invoices.number_prefix, invoices.user_id, invoices.status, invoices.date_due, invoices.date_paid, invoices.billing_at, invoices.credit, invoices.subtotal_converted, invoices.total_converted, invoices.subtotal, invoices.total, invoices.tax, invoices.tax_name, invoices.tax_percent, invoices.currency, invoices.reason, invoices.note, invoices.user_data, invoices.ip_address, invoices.user_agent, invoices.sender_address, invoices.recurring, invoices.recurring_generated, invoices.coupon_id, invoices.transaction_id, invoices.stripe_invoice_id, invoices.billing_reason, invoices.payment_intent_id, invoices.loc_confirm, invoices.paysys, invoices.stripe_payment_mode, invoices.allowed_payment_integrations, invoices.partial_payment, invoices.employee_id, invoices.created_at, invoices.updated_at, invoices.pretty_number, audits, subscription, subscription_payment, user, invoice_items, orders, invoice_sender_address, billing_address, coupon, employee, clientTags, logs."New value: +"Sort fields for \"list\". Append :asc or :desc for direction (default :asc). Example: [\"created_at:desc\"]. Available fields: id, number, number_prefix, user_id, deal_id, status, date_due, date_paid, billing_at, credit, subtotal_converted, total_converted, subtotal, total, tax, tax_name, tax_percent, currency, reason, note, user_data, ip_address, user_agent, sender_address, recurring, recurring_generated, coupon_id, transaction_id, stripe_invoice_id, billing_reason, payment_intent_id, loc_confirm, paysys, stripe_payment_mode, allowed_payment_integrations, partial_payment, employee_id, created_at, updated_at, pretty_number, invoices.id, invoices.number, invoices.number_prefix, invoices.user_id, invoices.deal_id, invoices.status, invoices.date_due, invoices.date_paid, invoices.billing_at, invoices.credit, invoices.subtotal_converted, invoices.total_converted, invoices.subtotal, invoices.total, invoices.tax, invoices.tax_name, invoices.tax_percent, invoices.currency, invoices.reason, invoices.note, invoices.user_data, invoices.ip_address, invoices.user_agent, invoices.sender_address, invoices.recurring, invoices.recurring_generated, invoices.coupon_id, invoices.transaction_id, invoices.stripe_invoice_id, invoices.billing_reason, invoices.payment_intent_id, invoices.loc_confirm, invoices.paysys, invoices.stripe_payment_mode, invoices.allowed_payment_integrations, invoices.partial_payment, invoices.employee_id, invoices.created_at, invoices.updated_at, invoices.pretty_number, audits, subscription, subscription_payment, user, invoice_items, orders, invoice_sender_address, billing_address, coupon, employee, clientTags, logs."
  3. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the description does not need to restate the read-only nature. The description adds the behavioral context of supporting filtering, sorting, and pagination, which is helpful, but it does not disclose additional details like response format, error behavior, or any edge cases. With annotations covering the safety profile, a 3 is appropriate.

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?

The description is two sentences long, immediately front-loads the primary purpose ('Query invoices'), and efficiently encapsulates both actions without redundancy. Every word earns its place, and the structure is clean and easily parseable.

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?

Given that there is no output schema, the description is sufficiently complete for an agent to understand how to invoke the tool: it explains both actions and the general capabilities. The schema provides all parameter details, and annotations cover safety. The only minor omission is that it does not explicitly state that 'invoice_id' is required for 'show', but that is present in the schema, so the description does not need to repeat it. Overall, nothing critical is missing.

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%, meaning every parameter is documented in the schema with descriptions and examples. The tool description mentions the actions and general capabilities (filtering, sorting, pagination) but adds no parameter-specific information beyond what the schema already provides. Given high coverage, the baseline of 3 is correct.

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?

The description states a specific verb ('Query') and resource ('invoices'), and explicitly distinguishes the two actions 'list' (with filtering, sorting, pagination) and 'show' (single invoice by ID). This makes the tool's purpose unambiguous and separates it from any potential confusion with sibling tools, even though there is no dedicated invoice-read sibling.

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

Usage Guidelines4/5

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

The description clearly indicates when to use each action ('list' for queries with filtering/sorting/pagination, 'show' for a single invoice by ID), which serves as internal usage guidance. It doesn't explicitly address alternatives across tools, but since invoice-tool is the only invoice-related tool among the siblings, the intended context is clear and no exclusions are needed.

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.

Resources