admin_list_references

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

No annotations provided, so description carries full burden. It lists parameters and return type but does not disclose behavioral traits like idempotency, caching behavior, or rate limits. The admin-only note adds some safety context.

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?

Concise, front-loaded purpose, followed by clear parameter list and return info. Every sentence adds value without unnecessary detail.

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 output schema exists, the return info is adequate. However, the concept of 'references' is not explained, and pagination details are minimal. Still, for a list tool with optional filters, it covers the core needs.

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?

Schema description coverage is 0%, but the description adds meaning for each parameter: e.g., 'namespace: Filter by namespace (e.g., 'public', 'user:alice')'. This clarifies usage beyond the bare schema.

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 lists cached references with optional filtering. The 'ADMIN ONLY' tag distinguishes it from non-admin list tools, and the verb 'list' and resource 'cached references' are specific.

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 notes 'ADMIN ONLY - Requires elevated permissions', guiding when to use. Does not compare to sibling admin tools, but the permission warning effectively excludes non-admin usage.

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