bookmind.sync_to_qbo

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

No annotations provided, so description must cover behavioral traits. It discloses the creation of journal entries (mutation) and the approval filter, but does not mention idempotency, error handling, permissions, or reversibility.

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?

Two concise, front-loaded sentences that immediately convey the tool's purpose and key constraint. No unnecessary words.

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?

Adequate for a one-parameter tool with no output schema. Covers main action and parameter usage, but omits details on return values, error scenarios, and idempotency.

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 covers the only parameter with a description, but the description adds value by explaining the special value ['all'] for all approved uncategorized transactions, going beyond the schema's generic description.

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?

Clearly states the verb 'push', the resource (approved categorizations from local SQLite to QuickBooks Online), and the specific action (creates journal entries). Differentiates from siblings like approve_categorizations and reject_categorizations by focusing on the sync step.

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?

Implies usage after approvals by stating 'Only syncs approved transactions', but lacks explicit when-not-to-use or alternative tools. Does not mention prerequisites like selecting a company or finalizing categorizations.

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