Compose Template

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

No annotations are provided, so the description carries full burden. It discloses auto-connect/disconnect, overwriting behavior, and lossy conversion between compose and update modes. Missing explicit mention of idempotency or auth requirements, but the core behaviors are well covered.

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 bold headers and bullet points, front-loading the purpose. It is relatively long but every sentence adds useful information; no redundancy. Slight opportunity to shorten, but overall effective.

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 4 parameters, a nested object, and no output schema, the description is thorough. It covers purpose, workflow, prerequisites, behavioral nuances, and parameter guidance. An agent can fully understand how and when to invoke this tool.

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%, baseline 3. The description adds value: 'id' accepts URLs, 'content' includes workflow guidance ('call get-tiptap-json-content first'), and 'subject' and 'name' are clearly described. It enhances schema meaning, especially for complex parameters.

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 explicitly states the purpose: setting TipTap JSON content of a template to enable visual editing. It distinguishes this tool from siblings like create-template and update-template by mentioning the workflow and the auto-connect/disconnect behavior.

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 description provides explicit 'When to use' bullet points, a recommended workflow (get-tiptap-json-content first), and warnings about overwriting content and lossy mode switching. It clearly states when not to use without asking (e.g., when template already has HTML content).

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