secret_inspect

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

Annotations already declare readOnlyHint=true and destructiveHint=false. Description adds crucial context: never returns actual secret data (Spec.Data is write-only), explains the limitation, and reinforces that this is a read-only metadata check. No contradiction.

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?

Well-structured: opens with purpose and prerequisite, explains limitation, lists use cases and alternatives, then documents parameter and return. Every sentence adds value, no redundancy.

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 tool's simplicity (1 param, no output schema, annotations present), the description covers all essential aspects: what it does, what it returns, what it doesn't, prerequisites, and alternatives. Fully adequate for an inspect tool.

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 coverage is 0%, but description includes 'args: id_or_name - The secret id or name', providing the meaning of the single parameter. Also describes return value. Could be more detailed but sufficient for one-param tool.

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 secret's metadata by id or name'. Verb+resource+scope are specific. Distinguishes from sibling tools like secret_create (creates), secret_list (lists all), and service_inspect (for references).

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 when to use (check CreatedAt, Labels, driver) and when not (not for reading contents). Provides alternative tool (service_inspect) for related queries. Notes prerequisite: requires a swarm manager.

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