hubspot_workflows_id_mappings

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

No annotations provided, so description must cover behavioral traits. Mentions returns a mapping of legacyWorkflowId → v4 flowId and requires 'automation' OAuth scope. Does not explicitly state non-destructive nature, but mapping implies read-only. Acceptable.

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?

Two sentences with no filler. First sentence states core purpose, second adds usage guidance and mentions return value and scope requirement. Extremely concise.

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 mapping tool with one parameter and no output schema, the description provides return value info and required OAuth scope. Slightly lacking mention of error handling or limits, but sufficient for a mapping utility.

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 100% for the single parameter 'workflowIds', which is fully described. The description adds context about migration but does not enhance parameter semantics beyond the schema. Baseline 3.

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?

Clearly states the tool maps legacy v3 integer IDs to v4 string IDs, with specific verb 'map' and resource 'ID mappings'. Differentiates from sibling tools that perform CRUD or other workflow operations.

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?

Explicitly says 'Use this when migrating from the deprecated v3 Workflows API to the v4 Flows API, or when you have stored references to v3 workflow IDs'. Provides clear context for when to use, though no explicit comparison to alternatives.

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