Get Spec

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

readOnlyHint=true aligns with the safe read operation described; description adds useful context about requiring project context and the included version information, though it does not mention error or auth edge cases.

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?

Three concise sentences each serve a clear purpose: core functionality, version-id usage hint, and when to use the tool versus list_specs. No wasted words.

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 no output schema, the description supplies enough detail about what is returned (key spec info and versions) and context requirements, though a fuller return-shape summary could be added.

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 sole parameter specId is fully described in the schema as a public GUID, and the description reinforces it is an existing id, but adds little beyond the schema coverage.

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?

Clearly states the tool retrieves detailed information about a specific API specification, including visibility and slug, and explicitly differentiates from list_specs for browsing.

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 instructs to use when the spec id is already known and directs to list_specs for browsing/finding ids, plus notes the requirement for project context.

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