Patch an existing Convocore agent variable by variableId: send only fields to change, and omit masked env values to keep stored defaults.
Patch an existing Convocore agent variable by variableId. Pass only fields to change. Never send back a masked env value as defaultValue — omit it to keep the stored value.
| Name | Required | Description | Default |
|---|---|---|---|
| variable | Yes | ||
| variableId | Yes |
Changes observed during successful MCP inspections.
v2.6.17Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare idempotentHint=true, destructiveHint=false, readOnlyHint=false, so the safety profile is covered. The description adds genuinely non-obvious context: masked env values must not be echoed back as defaultValue, and omitting the field preserves the stored value — a real behavioral caveat beyond the annotations.
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 sentences, front-loaded with the core action (patch by variableId) and immediately followed by the two operational constraints. No filler; every sentence earns its place.
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 patch tool with a nested object whose schema has 0% description coverage, the agent still doesn't know the valid field set to include in 'variable'. Annotations cover the mutation safety profile, but the description should enumerate or reference the patchable fields to be 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% and the 'variable' parameter is an undocumented nested object, so the schema gives the agent almost nothing about which fields can be patched. The description mentions defaultValue semantics for masked env values but never enumerates the patchable fields, leaving most of the parameter shape unexplained.
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?
States the specific verb (Patch), resource (existing Convocore agent variable), and the key identifier (variableId). This cleanly distinguishes it from sibling get/create/delete/list_agent_variable and update_agent, so an agent can select it without opening a schema.
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?
'Pass only fields to change' clearly frames this as a partial update, telling the agent to send a sparse payload rather than the full object. It doesn't explicitly name alternatives (e.g., create_agent_variable or update_agent), so it stops short of a full when/when-not comparison.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.