Retrieve a specific bill payment record by its unique ID to view payment details, verify transactions, and support reconciliation in QuickBooks Online.
Get a specific BillPayment record by its ID.
| Name | Required | Description | Default |
|---|---|---|---|
| billPaymentId | Yes | The unique BillPayment ID |
Changes observed during successful MCP inspections.
v1.4.4Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden. It indicates a read operation, but does not disclose potential behaviors such as error handling, authentication requirements, or rate limits. The simplicity of the operation partly justifies the minimal disclosure.
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?
The description is a single, front-loaded sentence that efficiently conveys the purpose. Every word earns its place with no redundancy.
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?
For a simple get operation, the description is minimally viable. However, without an output schema or additional behavioral notes, it leaves the agent uncertain about return format or error cases. It could be more informative.
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 coverage is 100%, so the baseline is 3. The description adds 'by its ID', which is already implied by the schema. It does not enrich the parameter meaning beyond what the schema provides.
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 verb (Get), the resource (BillPayment record), and the method (by its ID). It effectively distinguishes from sibling tools like qbo_bill_payments_list and qbo_bill_payments_create.
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 you have a specific ID and need the full record, but it does not explicitly state when not to use it or mention alternatives like qbo_bill_payments_list for retrieving multiple records.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.