Skip to main content
Glama

Caribooks (QuickBooks Online)

update vendor credit

update_vendor_credit
Destructive

Update an existing vendor credit in QuickBooks Online (requires Id and SyncToken).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entityYesFields to update. Must include Id and the current SyncToken (fetch the VendorCredit first). Do not send government identifiers (SSN or tax IDs), birth dates or card-processing details. Manage those fields directly in QuickBooks. Updates are sparse by default: only the fields sent change, and a Line array sent replaces all lines. Send sparse: false for a full update, which clears every writable field left out. A sparse update must also repeat VendorRef, unchanged, or QuickBooks rejects it as missing.
companyNoWhich connected QuickBooks company to use (name, realm id, or connection id). Optional when only one company is connected.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations indicate destructiveHint=true, and the description implicitly confirms this by describing update semantics. The description adds key behavioral context like sparse vs full updates, which is not in annotations. However, it doesn't discuss authorization requirements or potential side effects beyond the update itself. Since annotations already cover destructiveness, the burden is lower, and the description adds some value but not comprehensive.

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?

The description is reasonably concise, one sentence, and gets the essential requirement (Id and SyncToken) early. It doesn't over-explain but also doesn't waste words. It's well-structured.

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?

Given the complexity of the update logic (sparse vs full, repeating VendorRef), the description and schema together cover most needed details. No output schema exists, so return format is not explained, but that's not described in the tool description. It might be helpful to note common failure scenarios, but overall it's reasonably 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?

The schema has 100% coverage, so it already explains the entity and company parameters in detail. The description adds little beyond what the schema provides, leaning mostly on the schema's extensive property descriptions. Baseline 3 is appropriate since schema covers everything.

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?

The tool description explicitly states it updates an existing vendor credit in QuickBooks Online and requires Id and SyncToken. Since there are many other update tools for different resources, the specific resource (vendor credit) is clear. However, it doesn't explicitly differentiate itself from other update tools, but given the resource name is part of the tool name, that is mostly self-evident.

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 gives clear guidance on the required Id and SyncToken, mentions fetching the VendorCredit first, and warns about sensitive fields to avoid. It also explains the sparse update behavior and the need to repeat VendorRef for sparse updates. It doesn't explicitly say when to not use this tool or what alternative to use, but the guidance is specific and helpful for correct usage.

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