Get ISM version metadata

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

Without annotations, description fully carries the burden. It discloses the return type and fields, implying a read-only operation. Could be more explicit about side effects (none) and potential authentication needs, but overall adequate.

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 succinct sentences with no wasted words. Front-loaded with the action ('Returns OSCAL metadata') and immediately provides usage guidance.

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 no output schema, the description explains what fields are returned, which is sufficient for an agent. Missing details like error handling or prerequisites, but overall adequate for the tool's simplicity.

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 single parameter 'version' has schema description coverage of 100%, and the tool description repeats essentially the same information. No additional semantic context is added beyond what the schema provides, so baseline score of 3 is appropriate.

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?

Description clearly states the tool returns OSCAL metadata for a given ISM release, with specific fields enumerated. This distinguishes it from sibling tools like get_control or list_versions.

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?

Provides explicit guidance on using the 'version' parameter, including the 'latest' option and default behavior. Does not mention when not to use the tool or alternative tools, but context is clear for a simple retrieval tool.

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