qobrix_get_offer

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

With no annotations provided, the description must carry the transparency burden. It does so by disclosing the return format ('Returns { data: { id, ... } }') and the available include options (OpportunityOpportunities, PropertyProperties, etc.). It does not cover error handling or auth, but for a simple get operation this is adequate.

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?

The description is concise—two sentences total. It front-loads the core purpose, then adds include semantics and a use case. No wasted words, and every sentence adds value.

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?

For a simple get-by-UUID tool with 2 parameters and no output schema, the description is complete: it states the purpose, return shape, include options, and the transactional context (deal chain). No critical information is missing.

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 schema has 100% coverage, so baseline is 3. The description adds meaningful semantics to the 'include' parameter by explaining what each option represents (e.g., 'OpportunityOpportunities (the lead/buyer intent), PropertyProperties (the listing)'), going beyond the schema's list of options.

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 starts with 'Get a single offer by UUID' which is a specific verb+resource combination. It also clarifies it as the 'offer detail view in the Transaction Lifecycle', distinguishing it from list/search siblings like qobrix_list_offers and qobrix_search_offers.

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 clear context: 'Use to trace the deal chain: Offer → Opportunity → Contact + Property → Contract.' This explains a primary use case without explicitly stating when not to use or naming alternatives, but it strongly implies a detail-view role compared to broader list/search tools.

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