getDeploymentResources

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

No annotations provided; description merely repeats the name. Does not disclose read-only nature, behavior for invalid IDs, or any potential side effects beyond the implied fetch operation.

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?

Extremely concise (5 words) but lacks essential information. Minimalism is acceptable only to a point; here it sacrifices clarity.

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 or annotations; description does not clarify what 'resources' includes or the response structure. Incomplete for a tool with a single parameter and no additional context.

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 covers 100% of parameter descriptions (deploymentId described as 'The id of the deployment'), so baseline is 3. Description adds no additional value beyond 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?

Description restates the tool name ('Get resources of a deployment') without specifying what 'resources' entails or distinguishing from sibling tools like getDeployments or getActivityInstances. This is a tautology providing no additional clarity.

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 (e.g., getDeployments for deployment list) or any context about prerequisites or limitations.

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