hubspot_workflows_update

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

With no annotations provided, the description carries the full burden. It discloses that this is a PUT operation that replaces the entire workflow, resets omitted fields to defaults, and requires the 'automation' OAuth scope. This sufficiently communicates the tool's mutation behavior.

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 three sentences long, front-loading the core purpose ('Fully replace'), then providing behavioral and prerequisite guidance. Every sentence adds value without redundancy.

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?

The description covers the essential operation, prerequisites, and behavioral traits. However, it does not describe the return value or response format, which is notable given the lack of an output schema. Still, the description is adequate for a mutation tool with clear documentation.

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 coverage is 100%, but the description adds critical meaning: 'Fields not included in the request body will be reset to their defaults.' This clarifies parameter behavior beyond the schema, explaining the effect of omission. The suggestion to use get first also adds value.

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 'Fully replace an existing automation workflow' via a PUT operation, clearly specifying the verb and resource. It differentiates from sibling tools like hubspot_workflows_get by advising to fetch current state before updating.

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 explicitly says to use hubspot_workflows_get first to fetch current state, providing clear context. It explains the full replacement behavior but does not explicitly state when not to use this tool.

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