Get Scaleway IAM Policy

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint. The description adds empirical confirmation that the API never populates the rules array, which is a behavioral trait beyond what annotations provide. This saves the agent from discovering this limitation through trial and error.

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 sentences, all front-loaded with essential information. No wasted words: purpose, list of returned fields, caveat about rules, and cross-reference to the sibling tool. Every sentence earns its place.

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 simple read-only tool with one parameter and no output schema, the description covers the main points: what it returns, what it does not return, and an alternative. It could slightly improve by mentioning the output format (e.g., 'returns a single policy object'), but it is already 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?

Schema description coverage is 0% (no description for policy_id). The description only says 'by id', which redundantly restates the parameter name. It does not explain what a policy_id is, how to obtain it, or any constraints beyond the schema's UUID format. With zero coverage, the description should compensate but fails to add value.

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?

Description clearly states the action ('Get one IAM Policy's metadata') and specifies the resource and returned fields. It explicitly distinguishes itself from siblings by noting that it does not return the rules array and directs to scaleway_iam_list_policy_rules for that, making the purpose unambiguous.

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 description provides explicit guidance: 'Does NOT return the actual rules array... Call scaleway_iam_list_policy_rules for the real rules.' This tells the agent exactly when to use this tool (when only metadata is needed) and when to use an alternative (to get rules). No additional context is needed for this simple tool.

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