Parse cXML

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

With no annotations provided, the description carries the full burden. It provides a key behavioral detail: 'SharedSecret values are detected but never echoed,' disclosing a security-sensitive trait. However, it doesn't mention error handling, rate limits, or authentication requirements.

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 two sentences: the first lists the main output components, the second adds a critical transparency note about SharedSecret. Every sentence earns its place; no fluff.

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 a single parameter, no output schema, and no annotations, the description covers purpose, input, output structure, and a security behavior. It is fairly complete for a simple parsing tool, though it lacks details on optional fields or error handling.

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?

The schema covers 100% of parameters with a single 'message' parameter described as 'cXML document (XML text)'. The description adds significant meaning by listing specific document types and the structured output fields (e.g., From/To/Sender credentials, order header), which goes beyond the schema's minimal description.

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 tool parses cXML e-procurement documents into structured JSON. It lists specific document types (PunchOutSetupRequest, PunchOutSetupResponse, OrderRequest) and the output fields (credentials, session data, order header, line items), distinguishing it from siblings like parse_edifact and parse_x12 which handle different formats.

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 implicitly tells when to use this tool: when you have a cXML document. It doesn't explicitly say when not to use or mention alternatives, but the tool name and context from sibling tools (e.g., parse_edifact, parse_x12) make the usage domain clear.

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