Skip to main content
Glama

Caribooks (QuickBooks Online)

update department

update_department
Destructive

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entityYesFields to update. Must include Id and the current SyncToken (fetch the Department 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. QuickBooks cannot delete a department; to retire one, update it with Active: false.
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

A4.9/5.0
Behavior5/5

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

Annotations indicate destructiveHint=true and readOnlyHint=false, and the description adds substantial behavioral detail: sparse updates, full updates clearing omitted fields, inability to delete departments, retirement via Active:false, and prohibited sensitive-field updates. No contradiction with annotations.

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 top-level description is a single precise sentence, and the entity parameter description is dense but focused. Each sentence earns its place by conveying a critical operational rule without fluff.

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?

The description thoroughly covers the main call requirements, update semantics, and the deletion workaround. It does not explicitly describe what the response returns, which would be useful given no output schema, but the input-side guidance is strong enough for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, and the description enriches the entity parameter with operational meaning: it must include Id and SyncToken, sparse behavior, line replacement, full-update semantics, sensitive-data restrictions, and the retirement workaround. The company parameter is also clearly explained.

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?

Description states a specific verb and resource: 'Update an existing department in QuickBooks Online.' Requiring Id and SyncToken clarifies that this tool targets existing records, distinguishing it from create_department, get_department, and search_departments.

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

Usage Guidelines5/5

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

Provides explicit usage conditions: requires Id and current SyncToken, instructs to fetch the Department first, explains the sparse-update default versus full update with sparse:false, and gives an alternative to deletion by using Active:false. This clearly guides when and how to use the tool.

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