tealfabric_update_process

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It only states that an existing process is updated, without explaining whether the update is a partial patch or full replacement, what effects it has on running processes, whether versioning is involved, or what response to expect. This is a significant gap for a mutating operation.

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 a single concise sentence with no filler or redundancy. It front-loads the action and resource immediately, making it easy to scan and understand at a glance.

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?

Given the tool has 13 parameters, a nested configuration object, no output schema, and no annotations, the description is far too minimal to be contextually complete. It fails to mention which fields are updatable, whether any combination is required, or what the operation returns. For a complex mutation tool, this description leaves major gaps.

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 only 8%, and the description adds no parameter-level meaning. None of the 13 parameters are mentioned or explained in the description, so it does nothing to compensate for the overwhelmingly undocumented schema. The agent gets no help understanding fields like configuration, status, or is_template beyond their raw names.

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 uses a specific verb ('Update') and resource ('existing Tealfabric process (process flow)'), clearly distinguishing it from related operations like create, execute, or list. The phrase 'existing' reinforces that this is a mutation of an already-created process, not creation.

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 no guidance about when to use this tool versus alternatives such as tealfabric_create_process or tealfabric_execute_process. There are no stated conditions, prerequisites, or exclusions, so an agent must infer usage entirely from the tool name and general update semantics.

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