iyke_secret_set

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

With no annotations, the description carries the full burden. It discloses that the tool triggers a re-dump of the env-vault file, values land in encrypted Stronghold snapshot, and that it is a write operation. Lacks details on auth or rate limits, but covers key behavioral traits.

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, each adding value: purpose, side-effect, and caution. No redundancy, well front-loaded with the main action.

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?

Considering the tool's complexity (secret write with side-effects), the description covers purpose, side-effect, security context, and scoping. It doesn't specify overwrite behavior or return value, but for a write tool with no output schema, it is sufficiently complete.

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 0%, meaning no individual parameter descriptions. The description only mentions 'scope' with a reference to sibling semantics, but key and value are not explained beyond their names. This under-documents the parameters given the lack of 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 writes a secret to the vault, provides scope semantics by referencing the sibling iyke_secret_get, and distinguishes from other secret-related tools (get, delete, list). The verb 'Write' and resource 'secret to the vault' are specific.

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 includes a usage advisory ('Use this sparingly') and explains that it triggers a re-dump, providing context for when to use. It does not explicitly list alternatives or when-not scenarios, but the sensitivity and side-effect info guide usage.

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