haops_export_doc_markdown

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

No annotations are provided, so the description carries the full burden. It discloses that the operation returns the full Markdown content as a string (not a file download), which is the key behavioral trait. It doesn't mention side effects, auth, or rate limits, but for an export operation, these are not critical and the description is sufficiently 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 only two sentences, front-loaded with the core purpose, and every sentence adds value. No wasted words, highly 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?

Given the tool's simplicity (two required params, no nested objects, no output schema), the description fully explains what it does, what it returns, and a typical use case. It is complete for its complexity level.

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 both parameters described. The description adds context by providing example values for artifactSlug ('architecture', 'developer', 'api') and ties the tool to git syncing, which adds meaning beyond the schema's brief descriptions.

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 'Export a documentation artifact as Markdown text' with specific verb 'Export' and resource 'documentation artifact'. It distinguishes from siblings like create/update by emphasizing it returns content as a string, not a file. The use case 'syncing documentation to a git repository' adds clarity.

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 mentions 'Useful for syncing documentation to a git repository', providing a clear context for when to use this tool. It doesn't explicitly state when not to use or list alternatives, but among siblings, no other export tool exists, so usage is well implied.

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