Compose Broadcast

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

With no annotations provided, the description carries the full burden. It discloses automatic editor connection/disconnection, warns about overwriting content if get-tiptap-json-content is skipped, and notes lossy mode switching. However, it does not explicitly mention if the tool is destructive or requires specific permissions, which would improve transparency further.

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 well-structured with clear headings, bullet points, and a note section. Every sentence adds value, with no redundancy. It is front-loaded with purpose and workflow.

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 5 parameters, the description covers purpose, workflow, usage guidelines, important caveats, and edge cases (lossy mode switching). It provides sufficient context for an AI agent to use the tool correctly.

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%, so baseline is 3. The description adds value by explaining the content parameter workflow ('call get-tiptap-json-content first') and clarifies that broadcastId accepts a URL. This goes beyond the schema's own descriptions.

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's purpose: 'Set the TipTap JSON content of a broadcast... Can also update metadata (subject, preview text, name) in the same call.' It uses specific verb ('set') and resource ('broadcast TipTap content'), and distinguishes from siblings like compose-template and update-broadcast.

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?

Explicitly states that this is the 'recommended way to set email content' and provides a workflow: 'get-tiptap-json-content → compose-broadcast.' It lists when to use (after create-broadcast, for visual editing, collaboration) and warns against skipping get-tiptap-json-content. Also distinguishes from update mode and notes lossy switching.

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