appcrane_get_secret

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

Discloses that secrets are returned decrypted, defaults to sandbox, requires app-admin/AppCrane admin role, and non-admins get permission error. No annotations provided, but description fully covers behavioral aspects.

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?

Three sentences, front-loaded with main action, no fluff. Efficient and well-structured.

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 no output schema, the description could specify the return format (e.g., list of key-value pairs). Otherwise covers behavior, role, and error cases well.

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 100%, so the schema already documents both parameters adequately. The description adds context about stage default but doesn't significantly expand parameter meaning beyond schema descriptions.

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 tool retrieves all secrets (encrypted environment variables) decrypted for an app. It distinguishes from siblings like appcrane_set_secret (modifies) and appcrane_get_app (different resource).

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: when user asks about config/secrets or verifying env vars. Provides guidance on default stage and explicitly warns against using production unless user specifies. Also mentions required roles and permission errors.

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