Create Workflow Bulk Replace Request

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

Beyond annotations, the description reveals that company_id defaults to procore_set_config when omitted, that the request returns HTTP 201 with a new id, and details common error responses (401/403/404). These behaviors are not present in the annotations and aid the agent in anticipating results.

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 dense but every sentence serves a purpose: purpose, defaulting, return/non-idempotency, errors, required params, and API endpoint. It is front-loaded with the main action and avoids fluff.

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 an 11-parameter create tool with no output schema, the description covers the action, return value, error semantics, defaults, and required parameters. It does not exhaustively document each optional param, but the schema already does so, making this adequate for selection and invocation.

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%, and the description adds the meaningful default for company_id, which is not in the schema. It also restates required parameters, reinforcing what the agent must supply. No other param details are needed since schema descriptions are comprehensive.

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 opens with a specific verb and resource: 'Creates a new workflows bulk replace request to replace assignees across workflow instances.' It clearly identifies the action and distinguishes this from sibling tools like list/update/stop by focusing on 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 clear context for use (creating a bulk replace request) and warns that 'calling it again creates another record,' indicating non-idempotent behavior. It does not explicitly name alternatives but the creation focus against sibling tools is implied. Required parameters are listed to ensure correct invocation.

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