portainer_stack_stop

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

No annotations are provided, so the description must convey behavior. It states 'stop a running stack' but does not disclose effects on the stack state, whether the operation is reversible, or if it waits for graceful shutdown. The description adds minimal value beyond the tool name.

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 extremely concise: one short sentence and an args list. Every word is necessary, no redundancy. It is front-loaded with the core action.

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?

Given the simplicity of the tool (one parameter, no nested objects), the description is minimal. It lacks information about return values, error scenarios, or prerequisites. Even though an output schema exists, the description does not indicate what the response contains or when the operation fails.

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 descriptions in schema). The description explains the single parameter as 'The ID of the stack to stop', which adds meaning beyond the schema title 'Stack Id'. However, it does not specify the format or source of the ID, so it is adequate but not thorough.

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 'Stop a running stack' clearly states the action (stop) and the resource (stack). The tool name also indicates the stack, and it is distinguished from siblings like portainer_stack_start and portainer_stack_deploy.

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 vs alternatives, no prerequisites or conditions (e.g., should only be used on running stacks). The description does not mention when not to use or provide any contextual cues.

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