jira_add_comment

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

No annotations exist, so the description must fully disclose behavior. It only provides routing and authentication context but omits what the tool actually does (e.g., that it modifies a Jira issue by adding a comment).

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 short but includes unnecessary routing details that do not help the agent. It could be more directly about adding a comment to a Jira issue.

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 is a mutation (add comment) with an output schema, the description is severely incomplete. It lacks behavioral context, parameter details, and output information, making it nearly unusable for an AI 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?

The single parameter 'arguments' is described as a JSON string for the connector operation, but with 0% schema description coverage, the description fails to specify expected keys or structure. This leaves the agent without guidance on how to form valid input.

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 restates the tool name 'add_comment' without defining its purpose. It focuses on internal routing details rather than stating that this tool adds a comment to a Jira issue. It does not distinguish from sibling tools like jira_add_attachment.

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?

No guidance is provided on when to use this tool versus alternatives. It does not mention that it is for adding comments to issues, nor does it specify prerequisites or context.

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