portainer_secrets_list

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

The description discloses that the tool only returns names and metadata and never values, which is a behavioral trait. However, it does not explicitly state that the operation is read-only or safe, nor does it mention any permissions or side effects. Since there are no annotations, the description carries the full burden but falls short of comprehensive disclosure.

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 concise and well-structured, with two sentences: one for the main action and one for the parameter. There is no redundant information, and the phrasing is direct and efficient.

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 operation, the description covers the essential aspects: what it lists, the parameter meaning, and the output limitation. It does not mention the output schema or prerequisites, but these are not critical for a tool of this complexity. The description is sufficiently complete for an agent to use it correctly.

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?

The description explains the endpoint_id parameter as 'Target endpoint ID' and notes that it defaults if omitted. This adds meaning beyond the raw schema (which only lists type and default), clarifying the parameter's purpose and 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 action ('List Swarm secrets') and specifies the scope ('names and metadata only — never the values'), which makes its purpose unambiguous and distinguishes it from other list tools like portainer_containers_list or portainer_networks_list.

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?

There is no explicit guidance on when to use this tool versus alternatives. While the purpose is clear, the description does not mention conditions for use or contrast with other list tools, leaving the agent to infer usage contexts.

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