update_secret_route
Updates an existing Convai workspace secret by ID, enabling changes to its name, type, or value.
Instructions
Update Convai Workspace Secret
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| type | Yes | ||
| value | Yes | ||
| secret_id | Yes |
Updates an existing Convai workspace secret by ID, enabling changes to its name, type, or value.
Update Convai Workspace Secret
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| type | Yes | ||
| value | Yes | ||
| secret_id | Yes |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already disclose the safety profile (readOnlyHint=false, destructiveHint=false, idempotentHint=false, openWorldHint=true), so the agent knows this is a non-idempotent write with external effects. The description adds nothing beyond that: no mention of overwrite behavior, required permissions, or what happens to unmentioned fields.
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?
At four words it is not verbose, but it is severely under-specified rather than concise; there is no front-loaded detail beyond the bare operation name.
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 mutation tool with four required parameters, no output schema, and 0% parameter documentation, the description is far too thin. Annotations only cover the safety profile; the description should at minimum clarify what updating a secret does and how the required fields are used.
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% across four required parameters (secret_id, type, name, value), and the description lists none of them. The description does nothing to compensate for the fully undocumented schema, leaving the agent with no meaning for any parameter.
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 states a verb and resource ('Update Convai Workspace Secret'), which is clearer than a bare tautology. However, it essentially rephrases the tool name and does not distinguish it from close siblings such as create_secret_route, delete_secret_route, or update_environment_variable.
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?
No guidance is given on when to use this tool versus alternatives like create_secret_route or update_environment_variable, nor any prerequisites. The agent must infer all usage context from the name alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.