EasyTopic: transition topic status

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

With no annotations, the description carries full burden. It discloses that the tool runs the same beforeChecks as the human UI (e.g., requiredFieldsFilled), lists possible error types (WorkflowCheckId, notProjectAdmin, etc.), and explains the status lifecycle convention.

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 well-structured, starting with the action, then error vocabulary, then lifecycle rules. It is detailed but not overly verbose; every sentence adds 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?

Comprehensive for a transition tool: explains constraints, error vocabulary, and status conventions. However, it does not describe the return value (e.g., success message or updated topic), which is a minor gap given no output schema.

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 0%, and the description adds meaning for topicId and toStatusKey (the topic and target status) but does not describe the optional 'comment' parameter. This leaves some semantic gap.

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 clearly states the tool moves a Topic to a new status via a Workflow transition, explicitly distinguishing it from sibling tools like easytopic_list_topics or easytopic_add_comment. It specifies the action, resource, and business logic.

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?

Provides explicit when-to-use and when-not-to-use guidance, including when the agent may set planning/planned/in_progress/done statuses, and strict prohibitions on setting approved (without human approval) and closed (never). This helps avoid misuse.

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