Append to Markdown

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

Details the optimistic concurrency pattern (GET->concat->PUT with base_version_no), auto-retry on conflict, and conflict surfacing. Fully discloses internal workflow beyond the action.

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?

Two sentences, front-loaded with core purpose, no wasted words. Efficient and clear.

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 concurrency, retries, and base_version_no. Lacks mention of file existence handling and return value (no output schema). Adequate for a simple tool.

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 100%, so baseline is 3. Description does not add extra meaning beyond schema; no parameter elaboration.

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?

Clearly states 'Append content to the end of an existing .md file', using a specific verb and resource. Distinguishes from siblings like save_markdown (overwrite) and update_markdown (partial update) by the append behavior.

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?

Implies usage for appending with concurrency control but does not explicitly contrast with alternatives like save_markdown or update_markdown. No when-not-to-use or alternative guidance.

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