create_effort_record

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

No annotations are provided, so the description carries the burden. It discloses the controlled-field constraint and the update_work_item limitation, but it does not mention permissions, response behavior, or side effects of creating the record. Some context is added, but not comprehensive behavioral transparency.

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 a single sentence that front-loads the purpose and the key constraint. Every word earns its place, with no redundant filler.

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 create tool with no output schema and no annotations, the description is short but effective. It states the purpose, identifies the required object, and highlights the critical controlled-field constraint. It does not cover return values or permission requirements, but the schema and tool name cover most operational context.

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%, so the baseline is 3. The description adds domain context for actualTime by identifying it as the controlled field, but it does not meaningfully explain the other parameters beyond what the schema already provides.

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 action ('登记实际工时' / register actual work hours) and the object (effort record). It also distinguishes the tool from update_work_item by explaining that actual work hours is a controlled field requiring this dedicated tool.

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 when this tool must be used: actual work hours (fieldId 101587) is a controlled field and cannot be modified via update_work_item's customFieldValues. This provides a clear exclusion of the main alternative.

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