set_secret_value

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

Discloses that it elicits a prompt for secure entry and requires prior provisioning. With no annotations, it doesn't explicitly state whether it is a write operation or describe side effects like overwriting, but the verb 'set' implies modification. Adds useful context beyond the bare action.

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 short paragraphs with no redundancy. The main purpose is stated first, followed by the interactive note and prerequisites. Every sentence adds unique information, making it appropriately sized and front-loaded.

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 mutation tool with an output schema and two required parameters, the description covers the action, interactive prompt, and prerequisites. It lacks error-handling or permission details, but the provided information is sufficient for an agent to invoke it correctly in most scenarios.

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%, and the description fails to explicitly explain the two parameters (neptune_json_path and secret_name). It mentions 'neptune.json configuration' but does not map that to the path parameter, leaving the agent to infer roles. Insufficient compensation for 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 'Set the value of a secret resource for the current project' with a specific verb, resource, and scope. It distinguishes from siblings by focusing exclusively on updating an existing secret's value, not creating or provisioning resources.

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?

Provides explicit prerequisites: the secret must exist in neptune.json and be provisioned via provision_resources. It also explains the interactive prompt behavior. It does not name alternative tools or state when not to use it, but the context is clear for the intended use case.

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