Add Issue Watcher

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

Annotations already indicate readOnlyHint=false, so the description's mention of 'Add' is consistent. It adds a note about ValueError if the Jira client is missing, but doesn't disclose other behaviors like duplicate handling or user existence checks. Adequate but not rich.

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 front-loaded with the action and uses a structured docstring (Args, Returns, Raises). It is efficient but includes some redundancy (e.g., repeating parameter names). Still concise and well-organized.

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 the tool's simplicity, the description covers purpose, parameters, return format (JSON), and error condition. The existence of an output schema and annotations further completes the picture. Lacks mention of user validity or side effects, but remains fairly complete.

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%. The description's Args section restates parameter names and the Raises note, but adds no meaning beyond the schema's descriptions (e.g., issue_key pattern, user_identifier clarification). Baseline 3 is appropriate.

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: 'Add a user as a watcher to a Jira issue.' It specifies the verb (add), resource (watcher), and target (Jira issue), and is distinct from sibling tools like jira_remove_watcher and jira_get_issue_watchers.

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 stating the purpose, but provides no explicit guidance on when to use this tool versus alternatives (e.g., jira_get_issue_watchers to check current watchers). There is no mention of prerequisites or when not to use.

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