hwp_insert_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 the conversion and insertion at cursor, but does not mention side effects (e.g., cursor movement, overwriting), error handling for invalid markdown, or limitations on supported syntax. Adequate but not comprehensive.

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 two sentences: the first states the core action, the second provides examples. No redundant or 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?

For a simple tool with one parameter and no output schema, the description adequately explains the functionality and gives syntax examples. It lacks details on return values or error scenarios, but these are less critical for an insert operation.

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% with a description for the 'text' parameter. The description adds examples of supported markdown syntax, which adds some value beyond the schema, but the baseline is 3 due to high 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 clearly states the verb 'insert' and the resource 'markdown text converted to HWP format', with specific examples of supported syntax (#, **, -). This distinguishes it from siblings like hwp_insert_text (plain text) and hwp_insert_heading (heading).

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 implies usage when markdown text needs to be inserted, but lacks explicit guidance on when to use this tool versus alternatives (e.g., hwp_insert_text for plain text, hwp_insert_heading for headings). No when-not conditions are provided.

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