appcrane_set_secret

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

No annotations are provided, so the description carries full burden. It discloses encryption at rest, that only the running app can read plaintext, defaults to sandbox, and admin requirements. However, it does not mention whether setting a secret triggers any deployment or restart, nor does it discuss overwriting behavior or potential side effects.

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 four sentences, concise, and front-loaded with the purpose. Every sentence adds value without 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?

The description covers encryption, permissions, stage default, and scope. It lacks details on value size limits or key validation, but for a simple write tool, it is fairly complete. No output schema exists, but the tool's return is not complex.

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 75% (3 of 4 parameters have descriptions; slug lacks description). The description adds context about encryption and stage defaults, but does not elaborate on each parameter beyond what the schema provides. Baseline 3 is appropriate given the 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?

The description clearly states 'Set or update a secret (an encrypted environment variable injected into the app).' It uses a specific verb (set or update) and resource (secret), and explains what a secret is, distinguishing it from sibling tools like appcrane_get_secret.

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?

The description provides guidance: 'Defaults to sandbox; require explicit stage="production" only when the user asks.' And 'App-admin or AppCrane admin only.' It also mentions scope respect. It does not explicitly state when not to use, but the context is clear.

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