assign_issue

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

No annotations are provided, so the description carries full burden. It states the tool 'assigns an issue to a user' which implies a mutation/write operation, but doesn't disclose behavioral traits like required permissions, whether assignment is reversible, error conditions, or rate limits. The description adds minimal context beyond the basic action.

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 appropriately sized and front-loaded with the core purpose first. The Args/Returns sections are structured but could be more concise (e.g., the user identifier explanation is slightly repetitive). Every sentence adds value, though minor trimming is possible.

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?

Given no annotations, 0% schema coverage, and no output schema, the description does well on parameters but lacks completeness. It doesn't cover behavioral aspects (permissions, side effects) or return value details ('assignment result message' is vague). For a mutation tool with 5 parameters, this leaves gaps in guiding the agent.

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 provides clear semantics for all 5 parameters: explains 'issue_id' as the issue ID, describes the three user identifier options (user_id, user_name, user_login) as mutually exclusive alternatives, and notes that 'notes' is optional. This adds significant value beyond the bare schema.

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 verb ('assign') and resource ('issue'), making the purpose specific and understandable. It distinguishes from siblings like 'update_issue_status' or 'close_issue' by focusing on user assignment. However, it doesn't explicitly differentiate from all siblings (e.g., 'add_issue_note' also involves issues but for notes).

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 no guidance on when to use this tool versus alternatives like 'update_issue_status' or 'add_issue_note'. It mentions parameter options (user_id, user_name, user_login as alternatives) but doesn't explain context or prerequisites for assignment, leaving the agent to infer usage from sibling names alone.

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