getInvoicePreviewHtml

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

No annotations are provided, so the description must disclose all behavioral traits. It states the tool returns a rendered HTML preview, implying read-only behavior, but does not clarify if it requires specific permissions, whether the invoice must be finalized, or if the preview is generated on-the-fly. This lack of detail impairs an agent's ability to assess side effects or preconditions.

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 sentences without any fluff. The first sentence clearly states the purpose, and the second provides a usage guideline. Every word earns its place, and the structure is front-loaded.

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 the tools complexity (3 params, no output schema, no annotations), the description is minimally adequate. It covers purpose and usage but lacks behavioral context (e.g., idempotency, return format). An agent could use it, but may need to discover behavior empirically.

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 description coverage is 100%, and the description adds no additional meaning beyond the schema (e.g., 'auto-populated' is already in the schema for orgId). With full schema coverage, a score of 3 is appropriate as the description does not enhance parameter understanding.

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 'Get' and resource 'rendered HTML preview of an invoice', distinguishing it from siblings like getInvoiceById (JSON) or downloadInvoice (PDF). The description leaves no ambiguity about what the tool does.

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?

Provides a clear use case: 'Use this to show the customer-facing invoice layout.' However, it does not mention when not to use it or explicitly list alternatives (e.g., getInvoiceById for raw data, downloadInvoice for PDF). The guidance is minimal but not misleading.

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