insert_code_block

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

No annotations provided. Description reveals formatting details and that language is stored in return value only, but lacks disclosure of side effects or requirements beyond insertion.

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?

Description is concise with two sentences and an Args list, front-loading the main purpose. No unnecessary information.

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?

Covers main function and parameters adequately; output schema exists so return value details are not needed. Could mention if formatting overrides document defaults, but overall sufficient.

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?

Description explains each parameter in Args, adding meaning beyond schema: para_id as reference, text as code content, language as optional hint stored in return value. Schema coverage is 0% but description compensates.

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?

Description clearly states the tool inserts a code-block paragraph, specifying font and shading, distinguishing it from siblings like insert_paragraph and insert_blockquote.

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?

No explicit guidance on when to use this tool over alternatives like insert_paragraph or insert_blockquote; usage is only implied by the name and formatting description.

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