config_inspect

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

Annotations already provide readOnlyHint and destructiveHint. Description adds that payload is readable (Spec.Data base64) and that it needs a swarm manager, offering useful behavioral context beyond annotations.

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?

Very concise with a clear first sentence defining purpose, followed by a caveat and usage distinction. Uses bullet-point style for args and returns, no wasted words.

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 one parameter, no output schema, but annotations present, the description fully specifies the return dict structure (ID, CreatedAt, UpdatedAt, Spec). Everything an agent needs to know is covered.

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?

Schematically the parameter is just a required string with no description. The description fills that gap by stating 'id_or_name - The config id or name', adding meaning despite 0% schema coverage.

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?

Clearly states 'Get a swarm config's full inspect payload by id or name' with specific verb and resource. Distinguishes from sibling tools like config_list and config_remove by explaining that config_list enumerates configs while this reads one config's contents and metadata.

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?

Explicitly says 'Requires a swarm manager' and compares to secrets noting config payload is readable. Directs to use config_list for enumeration and this for reading one config, providing clear when-to-use guidance.

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