List Deployed Runtime Artifacts

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

No annotations provided; description carries burden. States it lists artifacts and statuses, which is adequate for a simple read operation. However, does not disclose that results are limited by the 'top' parameter or any access constraints.

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?

Single sentence, minimalistic. But contains misleading 'all' that contradicts schema. Conciseness is acceptable but accuracy is compromised.

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 list with 1 optional parameter, description covers resource and status but omits explanation of 'top' parameter and return structure. No output schema, so description should provide more detail than it does.

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 has one parameter 'top' (integer, default 100) with 0% schema description coverage. Description says 'List all' which contradicts the limit imposed by 'top'. Fails to add meaning and introduces inconsistency.

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 uses specific verb 'List' and resource 'deployed runtime artifacts', mentions status values like STARTED, ERROR, STARTING. Clearly distinguishes from sibling list tools (e.g., list_integration_flows, list_data_stores) which target different resources.

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 like list_integration_flows or deploy_artifact. Does not specify context or exclusions.

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