insert_code_block

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

Despite no annotations, the description discloses formatting behavior (Courier New 10pt, light-gray background) and that language is stored only in return value. However, it does not mention potential side effects or prerequisites.

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 concise with a clear first sentence stating purpose, followed by formatting details and parameter documentation. Minor improvement could be more structured bullet formatting, but overall efficient.

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 key aspects: action, formatting, parameters, and language usage. Mentions return value storage for language. An output schema exists, so missing return structure is acceptable. Slightly incomplete on what the output contains.

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 description includes an 'Args' section explaining each parameter (para_id as reference, text as code content, language as optional hint) when the input schema provides no descriptions. This adds significant meaning beyond the bare 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 action (insert) and the resource (code-block paragraph), with specific formatting details (Courier New 10pt, light-gray background), distinguishing it from sibling tools like insert_paragraph or 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?

The description does not provide guidance on when to use this tool versus alternatives such as insert_paragraph or insert_blockquote. It lacks explicit context for selection among similar insertion tools.

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