Skip to main content
Glama

Caribooks (QuickBooks Online)

create credit memo

create_credit_memo

Create a credit memo in QuickBooks Online. Returns the saved record with its SyncToken.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entityYesThe CreditMemo to create, as a QuickBooks Online API v3 CreditMemo object. Do not send government identifiers (SSN or tax IDs), birth dates or card-processing details. Manage those fields directly in QuickBooks.
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

B3.3/5.0
Behavior3/5

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

Annotations declare readOnlyHint=false and destructiveHint=false, so the agent knows this is a mutating but non-destructive operation. The description adds that it returns the saved record with its SyncToken, which is useful behavioral context. However, it does not mention required permissions, idempotency, or side effects, and the absence of destructiveHint=true is consistent with creating a new record.

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?

Two short sentences, front-loaded with the action and resource, followed by the return value. No wasted words or redundancy.

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 creating a QuickBooks CreditMemo object (nested entity with many fields), the description is minimal. It lacks details about required fields, data validation, or how the entity object maps to QuickBooks API v3, though the schema covers some of this. No output schema exists, so the description's mention of the return value is helpful but not exhaustive. The definition is adequate but incomplete for a tool of this complexity.

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 the schema already documents both parameters thoroughly. The description adds no parameter-specific details beyond what the schema provides. Baseline 3 is appropriate when schema does the heavy lifting.

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 ('Create a credit memo in QuickBooks Online'), which is clear enough to distinguish from siblings like update_credit_memo, get_credit_memo, or send_credit_memo. However, it does not explicitly name those siblings, so it falls short of a 5.

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

Usage Guidelines2/5

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

Provides no guidance on when to use this tool versus alternatives (e.g., create_invoice, create_refund_receipt, create_vendor_credit), nor any prerequisites or contextual conditions. The agent must infer usage entirely from the name and sibling list.

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