list_components

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

No annotations are provided, so the description carries the transparency burden. It discloses the return format ('A markdown-formatted list of components') and mentions error handling via ctx, but it does not explicitly state that the operation is read-only or describe any side effects. For a simple list tool, the read-only behavior is implied, but the description could add more explicit 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?

The first sentence is clear and front-loaded, but the second sentence ('This tool lists all components in the system architecture.') is redundant. The Args and Returns sections also mostly duplicate schema information. It is somewhat verbose for a simple tool, but still concise overall.

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?

The description is complete for a simple list tool: it specifies the action, optional filter, and return format. The output schema exists and the single parameter is fully described in the schema. It could mention what happens when no components exist or how the type filter behaves, but these are minor gaps given the tool's simplicity.

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 100%, and the description's Args section simply repeats the schema's 'Optional type to filter components' without adding new meaning. Since the schema fully documents the parameter, the description provides no additional semantic value beyond confirming the optionality.

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's purpose: 'List all components in the architecture.' This uses a specific verb (list) and resource (components), and the optional type filter further clarifies scope. It distinguishes itself from sibling list tools like list_data_stores or list_connections by the resource type.

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 clear context for when to use the tool: listing all components in the system architecture, with an optional type filter. It does not explicitly mention alternatives or exclusions, but the resource-specific name and description make the intended usage unambiguous.

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