Create code blocks

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

There are no annotations, so the description must disclose side effects or limitations. It only states 'Add' and 'syntax-highlighted' – it does not mention that items are added near viewport by default, that up to 100 items are allowed, or how invalid languages are handled (though some of this is in the schema). This is a narrow behavioral disclosure.

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 a single tight sentence that front-loads the action and adds a use case. No fluff or redundancy.

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 annotations and no output schema, the description leaves important invocation context (item limits, default placement, language fallback) unexplained. Although the schema provides these details, the description does not help the agent decide when to use this vs alternatives beyond a generic use case.

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 0%. The tool description gives no direct parameter information – it doesn't mention the 'items' array, 'code', 'language', 'x/y' positioning, or 'parentId'. It only implies 'code' and 'syntax' via the phrase 'syntax-highlighted code blocks'. The schema itself is rich, but the description fails to compensate for the low coverage.

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 opens with 'Add syntax-highlighted code blocks' – a specific verb and resource. It differentiates from sibling create_texts by specifying syntax highlighting and use case (snippet/schema/config).

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 sentence 'Useful for putting a snippet, schema or config next to the diagram that explains it' provides a clear context for when to use the tool. It does not explicitly mention alternatives or exclusions, but the use case is a sufficient guideline for an agent.

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