get_xray_entity_query_metadata

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

No annotations provided. The description implies a read-only operation ('Get') but does not disclose behavior such as required permissions, return format, or side effects. Minimal transparency beyond the basic action.

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 a single sentence of 13 words, very concise. It is front-loaded with the key verb and object. However, it could be expanded with brief parameter context without losing conciseness.

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?

No output schema and no annotations. The description is too brief to provide complete context for a tool with a nested parameter structure. It does not explain what 'query metadata' entails or what the return values are, leaving the agent without enough information to understand the tool's full behavior.

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% per context signals, and the tool description adds no information about parameters. The description lacks any parameter details, failing to compensate for low schema coverage. The schema itself has descriptions, but the tool description does not reinforce or clarify them.

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 action ('Get') and the resource ('query metadata for an x-ray automagic dashboard entity'). It distinguishes from sibling tools like get_xray_entity by specifying 'query metadata', though 'automagic' is informal and could be clarified.

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?

No guidance on when to use this tool versus alternatives. The description does not mention prerequisites, context, or situations where this tool is appropriate compared to other x-ray or metadata tools.

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