Get TipTap JSON Content

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

The description goes beyond the readOnlyHint annotation by disclosing that the tool automatically connects the agent to the editor and that subsequent compose calls disconnect. This side-effect is significant and not observable from annotations alone.

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, bullets, and a tip. Every sentence contributes to understanding the tool's purpose, usage, and side-effects, with no unnecessary repetition.

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 tool has no output schema, the description adequately explains the return value and how to use it as a base for modifications. It also covers the editor connection side-effect and parameter defaults, making it complete for an agent to invoke 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?

The input schema provides 100% coverage of all parameters, so the baseline is 3. The description adds minimal extra value, such as the tip about include_schema, but largely repeats parameter behavior already documented in the schema.

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 retrieves TipTap JSON content of a broadcast or template, optionally including the schema reference. It also differentiates from siblings by instructing 'Always call this before compose-broadcast or compose-template', making its specific role unambiguous.

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 'When to use' section provides explicit contexts: always before compose-broadcast/compose-template, for edits/modifications, and for inspection. It lacks explicit when-not-to-use or alternative tool names, but the guidance is clear and actionable.

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