insert_doc_markdown

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

With no annotations provided, the description carries the full burden. It discloses key behaviors: conversion to Docs API batch requests, rendering with real Docs styles (not raw markdown), and supported markdown elements. However, it does not mention error handling for invalid markdown or potential size limits, which would make it fully transparent.

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 (3 sentences) and front-loaded with the core purpose. It efficiently compares to siblings, lists supported features, and mentions scope, with no redundant or trivial 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?

Given that an output schema exists (return values not needed) and schema coverage is 100%, the description covers all key aspects: purpose, alternatives, supported syntax, scope, and parameter semantics for the main parameter. It is complete for the tool's complexity.

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 detailing supported markdown syntax for the 'markdown' parameter, going beyond the schema's 'Markdown source to insert.' Other parameters are not enriched beyond schema, but the addition to the most critical parameter justifies a 4.

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 it inserts markdown with native styling into a Google Doc. It specifies the verb-resource pair ('Insert markdown-formatted content into a Google Doc') and explicitly distinguishes from siblings modify_doc_text (plain text) and find_and_replace_doc (find-replace).

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 guidance (for markdown insertion with native styling) and when-not-to (use modify_doc_text for plain text, find_and_replace_doc for patterns). It also lists supported markdown syntax and notes the required OAuth scope.

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