export_markdown

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

No annotations are provided, and the description only restates the core operation. It does not disclose important behavioral details such as whether it writes to the filesystem, overwrites existing files, requires network access, or what happens when output_path is not provided.

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 a single, front-loaded sentence with no redundant words. It succinctly communicates the tool's primary purpose and output.

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?

With full schema coverage and an output schema present, the basic mechanics are adequately covered. However, the description is thin on usage context, especially relative to sibling tools, and leaves behavioral details such as file-handling behavior unspecified.

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?

All three parameters are fully described in the schema (100% coverage), so the description adds little beyond reinforcing that repo_path refers to a repository and output_path refers to a Markdown file. This meets the baseline but does not exceed it.

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 (generate documentation) and the output format (Markdown file), which distinguishes it from HTML/PDF export siblings. However, it does not explicitly differentiate it from generate_project_documentation, which may have overlapping functionality.

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 for when a user wants repository documentation as a Markdown file, but it offers no explicit guidance on when to choose this tool over closely related siblings like generate_project_documentation or export_html/export_pdf.

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