Render a credit note as Markdown or printable HTML

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

No annotations are provided, so the description carries the full burden, and it does real work: "Writes nothing" discloses the read-only safety profile, drafts render with a DRAFT banner (state-dependent output), and the free tier stamps a footer (quota-based output modification). It does not cover auth requirements, error behavior for an unknown id, or whether finalized notes render differently.

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?

Three sentences, front-loaded with the core action and the two output forms, then the draft-banner safeguard, then the side-effect and cost notes. Every sentence adds a distinct fact; the short "Writes nothing." fragment earns its place as an explicit safety signal.

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?

With no output schema, the description must convey what comes back, and it does at the artifact level (a Markdown document or a standalone HTML page). Draft state and free-tier footer behavior are covered; minor gaps remain around failure modes for invalid ids and whether the returned HTML includes the DRAFT banner.

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 coverage is 100%, so the baseline is 3, but the description adds meaning beyond the schema: it explains that html output is "self-contained" with "every style inline," which clarifies the enum choice itself rather than just restating it. It adds nothing further about the id format, which the schema already documents.

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?

States a specific verb (render/turn into a document) and resource (credit note), and names both output artifacts: Markdown for pasting and a self-contained printable HTML page. This clearly separates it from the sibling mutation tools (create/update/finalize/delete) and from credit_note_get, which retrieves data rather than formatting it.

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?

Gives clear context for choosing between the two modes ("Markdown to paste into an email or ticket, or a self-contained printable HTML page"), and notes the draft-banner safeguard. It never names a sibling or states when-not to use this tool (e.g., use credit_note_get for raw data), so it stops short of a 5.

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