Get TipTap JSON Content

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

With no annotations, the description carries full burden. It discloses the side effect of connecting to the editor and explains the return values. However, it does not cover error behavior, rate limits, or authentication nuances. This is adequate but not exhaustive.

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-organized with sections (Purpose, When to use, Returns, Note, Tip). Every sentence adds unique value, no redundancy. It uses bold for emphasis and is appropriately sized for the tool's complexity.

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 3 parameters, no output schema, and no annotations, the description covers key context: connection management, ordering relative to compose tools, and that content may be set via dashboard. Could mention error cases, but overall complete enough for an agent to use 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 coverage is 100%, so baseline is 3. The description adds value by explaining the purpose of include_schema ('required for producing valid TipTap JSON') and when to set it false. It also advises to always call this before compose, adding context beyond 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 from a broadcast or template, with optional schema. It explicitly uses the verb 'Retrieve' and specifies the resource. It also differentiates from siblings by noting the connection management and ordering relative to compose tools.

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 clear directives: always call before compose-broadcast/template, even if expecting empty; when editing; to inspect structure. It does not explicitly state when not to use, but the guidance is sufficient for correct invocation.

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