add_work_item

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

Annotations already communicate that this is a mutating, non-idempotent operation. The description adds the behavioral context of logging time, implying a time entry is created. However, it doesn't disclose potential side effects, such as whether calling it twice creates duplicate entries or whether existing time entries are affected. Since the annotations cover the basic safety profile, a 3 is appropriate.

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 succinct and front-loaded with the core purpose. The Args block is a clean, efficient way to document six parameters, and each line is short and useful. There is minimal waste, though the parameter lines are somewhat redundant with the input schema titles.

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?

The description covers all input parameters and the basic operation, but it does not explain the return value or side effects. An output schema exists per context signals, so the return type is presumably structured, but an agent would still benefit from knowing what the tool returns (e.g., created work item ID). For a write operation, this is a notable gap, but the core calling information is present.

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 does list all six parameters with concise explanations, such as 'issue_id: Issue ID or URL' and 'duration_minutes: Time spent in minutes,' which adds meaning beyond the schema titles. However, it doesn't explain constraints like duration_minutes range or date format details beyond the YYYY-MM-DD example. The parameter descriptions are adequate but not thorough.

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 starts with a clear verb and resource: 'Log time on a YouTrack issue.' This distinguishes it from many sibling tools like add_comment or create_issue, though it doesn't explicitly contrast with update_work_item or delete_work_item. Overall the purpose is specific and understandable.

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 implies usage by listing required arguments, but there is no explicit when-to-use or when-not-to-use guidance. It doesn't mention alternatives like update_work_item or get_work_items, so an agent must infer when this tool is appropriate. The context of logging time is fairly clear, but the guidance is minimal.

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