jira_login

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

No annotations are provided, so description carries full burden. It discloses browser automation (Playwright) and cookie storage, but lacks details on side effects (e.g., requires user interaction for SSO, modifies local files) or whether it is a one-time setup. More behavioral context would be beneficial.

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?

Two sentences with core functionality first, followed by troubleshooting advice. No wasted words, information is front-loaded.

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 zero parameters and no output schema, description covers authentication purpose and failure handling. However, it does not explicitly state the tool's return value or that it should be called before other JIRA tools, which would be helpful for context among sibling tools.

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?

No parameters exist, so baseline score of 4 applies. The description adds no additional parameter-level meaning since there are none to document, but provides context about the tool's behavior.

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?

Description clearly states it performs SSO login via Playwright and saves cookies for REST. It is distinct from sibling tools which are task-specific JIRA operations.

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?

Explicitly provides guidance on when to use (SSO login) and alternatives if automation fails (use JIRA_PAT and delete cookie file). Also mentions configuration options for PREFER_SSO_COOKIES.

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