generate_xml

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It explains server-side .NET execution, client-side language independence, validation against an embedded schema, CLI availability, and the absence of an output-filename parameter. This gives the agent a clear picture of what happens and what the tool does not do.

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 front-loaded with the core purpose, then efficiently covers usage guidance, cross-language accessibility, and sibling differentiation. Every sentence adds meaningful information, including the CLI fallback and feature-set comparison, with no filler.

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 tool with one required parameter, no output schema, and no annotations, the description is highly complete. It explains what the tool returns, how it validates, what makes it different from siblings, and how it can be invoked from various environments. Nothing essential for correct invocation is missing.

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%, and the single 'path' parameter is already described as 'Path to an existing .docx/.docm file to convert to XML.' The tool description reinforces that the input is an existing Word document, but adds no new parameter-level semantics beyond what the schema already provides.

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 first sentence states a specific action, resource, and output: reads an existing Word document and returns it as XML. It also distinguishes itself from sibling code-generation tools by explicitly naming generate_fsharp_script and generate_csharp_script as alternatives and clarifying it returns data rather than a runnable script.

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 is explicit about when to use this tool: when the caller wants to inspect, transform (e.g., via XSLT), or archive a document without F#/C# source and without a .NET runtime. It also states what it is not for, noting that unlike the script generators, it returns data and has no output-filename parameter.

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