get_secret

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

No annotations provided, so description carries full burden. Discloses that secret value is not returned, output is automatically stored with object ID, and mentions error messages. Could be more explicit about error scenarios or authentication, but sufficiently covers read behavior.

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?

Description is moderately lengthy with repeated output instructions ('The output is automatically stored...' and later about object store). Could be more concise while retaining key points. Structure is adequate with line breaks.

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 one-parameter getter with no output schema, the description explains the return format (object ID), how to use it with object store tools, and that it can be passed to other functions. Covers the usage scenario well, though lacks full return structure details.

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?

Input schema has zero description coverage, so description must compensate. Includes a docstring ':param secret_id: The unique identifier of the secret to retrieve' which adds meaning beyond the schema. Not fully specific about format, but adequate.

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 verb 'retrieves' and the resource 'detailed information about a specific secret by its ID'. It distinguishes from sibling 'list_secrets' by focusing on a single secret retrieval.

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 states 'Use this tool to get information about a specific secret when you know its ID.' Provides security context about secret value not returned. Does not explicitly mention alternatives or when not to use, but the specific usage context is clear.

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