get_transaction

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

With no annotations provided, the description must disclose behaviors. It states 'Fetch the full QBO entity', implying a read-only operation. However, it does not mention side effects, permissions, rate limits, or what 'full entity' entails beyond the hint. Adequate but minimal.

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 sentences with no fluff. The first sentence states purpose, the second adds a specific use case. Could be considered slightly under-specified but not wasteful.

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?

Given no output schema and zero parameter documentation, the description is incomplete. It does not explain return format, errors, or the scope of 'full QBO entity'. For a fetch tool, more context (e.g., what the return includes, pagination if any) is expected.

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?

The input schema has 0% description coverage and the description adds no meaning to parameters 'txn_type' and 'txn_id'. It does not explain valid values, formats, or how to use them. This is a critical gap for parameter usage.

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?

The description clearly states the tool fetches the full QBO entity for a transaction, specifying a distinct resource. Mention of inspecting Line[].Id adds specific use context. However, it does not explicitly differentiate from siblings like find_transactions or query, which could also retrieve transaction data.

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?

The description provides a usage hint ('Use to inspect Line[].Id and current values') but lacks explicit guidance on when to use this tool versus alternative siblings. No exclusions or prerequisites are mentioned, leaving the agent to infer context.

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