Docflow Update Review Rule

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

No annotations are provided, so the description carries full behavioral disclosure burden. It says the tool updates a rule's prompt or configuration, but it does not explain whether fields are merged or replaced, whether omitted optional fields are reset, what happens if the rule does not exist, or what side effects occur. For a mutation tool, this is a significant gap.

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 short sentences with no filler. It front-loads the core action and endpoint, then gives usage guidance and a key parameter mapping. Every sentence contributes value.

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 7-parameter mutation tool with no annotations, the description is incomplete. It covers risk_level and general prompt/config updates, but key parameters such as category_ids and referenced_fields are left unexplained, and it does not clarify update semantics for optional fields. The output schema covers return values, but the input behavior is underspecified.

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%, so the description must compensate. It adds meaning for risk_level with enum values (10=high, 20=medium, 30=low), but it does not explain name, category_ids, referenced_fields, workspace_id, or rule_id semantics beyond their 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 states a specific action, 'Update an existing review rule's prompt or configuration,' and includes the endpoint. It is clearly differentiated from create/setup tools by the word 'existing,' though it does not explicitly name sibling tools.

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 concrete use cases: 'refine rule prompts based on review results, or adjust risk levels.' This gives clear context for when to invoke the tool, though it does not mention when not to use it or how it compares to alternatives.

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