Skip to main content
Glama

quickbooks_controller_snapshot

Read-onlyIdempotent

Generate a QuickBooks controller snapshot with company details, preferences, and selected financial reports for a specified period.

Instructions

Build a QuickBooks controller snapshot with company info, preferences, and core financial reports.

Args: reports: Reports to include; defaults to core controller reports. start_date: Report start date (YYYY-MM-DD). end_date: Report end date (YYYY-MM-DD). as_of_date: Report as-of date (YYYY-MM-DD). project_id: Authenticated Project UUID. project_ref: Exact project correlation reference. connector_account_ref: Project-bound connector account alias. idempotency_key: Stable business-action identity. effect: Required and must be read; Spring verifies it. approval_ref: Approved platform task UUID when resuming a write.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
effectYes
reportsNo
end_dateNo
as_of_dateNo
project_idNo
start_dateNo
project_refNo
approval_refNo
idempotency_keyNo
connector_account_refNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv0.1.1
    • addedInput schema / properties / approval_ref
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Approval Ref"
      +}
    • addedInput schema / properties / connector_account_ref
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Connector Account Ref"
      +}
    • addedInput schema / properties / effect
      Added value: +{
      +  "const": "read",
      +  "title": "Effect",
      +  "type": "string"
      +}
    • addedInput schema / properties / idempotency_key
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Idempotency Key"
      +}
    • addedInput schema / properties / project_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Project Id"
      +}
    • addedInput schema / properties / project_ref
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Project Ref"
      +}
    • addedInput schema / required
      Added value: +[
      +  "effect"
      +]
  2. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

The description focuses on the output (snapshot) but does not describe side effects or operational behavior. Annotations indicate readOnlyHint and idempotentHint, which the description does not reinforce or elaborate on. It does not contradict the annotations, but also does not add meaningful behavioral context beyond what the schema already signals.

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 concise with a single summary sentence followed by a clean list of parameters. It avoids unnecessary verbosity and presents information in a clear, scannable format. The structure is efficient and free of fluff.

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?

The description gives a high-level purpose but lacks important contextual details: which financial reports are considered 'core', how date fields affect the snapshot, and whether the snapshot includes any derived or aggregated data. Given the rich sibling tool set, more specificity would help an agent understand the tool's role and appropriate use. The readOnlyHint and idempotentHint are not explicitly reflected in the description, but the annotation fields already cover that.

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

Parameters4/5

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

The Args section provides one-line descriptions for all ten parameters, including 'reports: Reports to include; defaults to core controller reports' and date formats. This exceeds the schema's bare titles and types, giving useful guidance on parameter meaning. However, descriptions are brief and do not explain interactions (e.g., how start_date and as_of_date relate) or the exact default set of reports.

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 description clearly states the tool 'Build a QuickBooks controller snapshot with company info, preferences, and core financial reports.' This conveys a specific purpose (aggregating snapshot data) and distinguishes it from individual QuickBooks report or info tools visible in the sibling list. However, 'controller snapshot' is slightly vague and could be more explicit about the exact composition.

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

Usage Guidelines3/5

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

The description implies this is a combined read-only snapshot but does not explicitly state when to choose it over calling quickbooks_company_info, quickbooks_preferences, or individual report tools. It lacks guidance on selecting this tool versus alternatives, and does not mention that it is idempotent or read-only (though annotations provide this).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools