Get the diagram IR JSON Schema

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

No annotations are provided, so the description carries the burden. It discloses that the tool is a read-only reference fetch with no side effects implied, and that the output is a schema (draft 2020-12). It does not describe output size, whether the schema is static or versioned, or how it is returned. Adequate but not rich.

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 tight sentences with no waste, front-loaded with what is returned before the call-to-action. Some minor redundancy in restating what a JSON Schema is ('the structural contract...').

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 zero-param reference tool with no output schema or annotations, the description covers purpose, format, and when to call it. It could note that the schema is authoritative/static, but is largely complete.

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?

Zero parameters, so the baseline of 4 applies. There is nothing for the description to add on parameters.

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?

States a specific verb (Returns) and resource (ArchSmith diagram IR JSON Schema) and pins the draft version (2020-12). It also frames what the schema IS ('the structural contract a diagram IR document must satisfy'), which an agent can distinguish from siblings like validate and render.

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?

Explicitly says when to call it: 'Call this, and get_registry for governed vocabulary, before authoring an IR.' It names the paired sibling (get_registry) and the sequencing (before authoring), which is exactly the routing an agent needs.

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