Fetch a vendor credit by its unique ID to view or reconcile supplier credit details in QuickBooks Online.
Get a specific VendorCredit record by its ID.
| Name | Required | Description | Default |
|---|---|---|---|
| vendorCreditId | Yes | The unique VendorCredit ID |
Changes observed during successful MCP inspections.
v1.4.4Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description declares it is a read operation ('Get'), matching the tool's behavior. No annotations are provided, so the description carries the full burden; it is sufficient.
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?
Single sentence, 8 words, precise and to the point. No unnecessary information.
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-by-ID operation, the description is complete. No output schema is needed for clarity.
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% with a clear parameter description. The description adds no additional meaning beyond what the schema provides, meeting the baseline.
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' and the resource 'specific VendorCredit record by its ID'. It is distinct from sibling tools like create, list, and update.
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 usage is implied: use when you have a vendorCreditId and need the full record. No explicit alternatives or when-not-to-use mentioned, but the purpose is straightforward.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.