get_api_quick_reference

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

With no annotations, the description carries the burden of disclosing behavior. It states the tool 'Returns a reference of available API endpoints...' and recommends calling once, which implies a safe, read-only operation with a one-time load into context. It does not explicitly mention lack of side effects, but that is strongly implied by the reference nature. It adds context about the recommended usage pattern.

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 three short sentences, each serving a purpose: identifying the tool, describing the content, and providing usage guidance. It is front-loaded and contains no unnecessary 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?

For a zero-parameter tool with an output schema, the description is quite complete: it identifies the resource, the content of the reference, and the recommended usage. It does not cover the distinction from the sibling 'get_tools_quick_reference', so a small contextual gap remains.

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 tool takes no parameters, as shown by the empty input schema. According to the rubric, zero parameters gives a baseline score of 4. The description adds no parameter-specific details, but none are needed.

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 identifies the tool as a reference for the SkyPortal API, with a specific verb ('Get') and resource ('API quick reference guide'). It explains what the reference contains (endpoints, required parameters, usage patterns). However, it does not explicitly distinguish itself from the sibling 'get_tools_quick_reference' tool, so it falls short of a 5.

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 instruction 'Call once to load into context as needed' provides clear context for when/how to use the tool, and implies a one-time usage pattern. However, it does not explicitly state when to use this tool versus the related 'get_tools_quick_reference' or any alternative, nor does it provide exclusion criteria.

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