authenticate

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

No annotations are provided, so the description carries the full behavioral burden. It discloses that a session token is stored locally, that 2FA requires a second call with a TOTP code, and that environment variables take precedence. This is strong behavioral disclosure, though it does not detail the exact shape of the stored session or any security caveats.

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?

Well-structured with numbered options and brief parameter explanations. The critical 'call this first' guidance is front-loaded, and every sentence adds operational value without redundancy.

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 role as a prerequisite for all siblings, the description fully covers authentication flows, retry behavior for 2FA, and alternative auth via environment variable. The output schema exists, so return-value details are not required in the description.

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 for the bare parameter list. It does so thoroughly: access_token is described as highest priority, email/password are for API login, and totp is explicitly tied to 2FA-only use. This gives the agent everything needed to choose among the options.

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?

States a specific verb and resource: authenticates with YesWeHack and stores the session token locally. It clearly differentiates itself from the sibling tools, which are all API operations that presuppose authentication.

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 instructs to call this first before any other tool, or when a tool reports authentication is required. It also lays out three concrete usage options and mentions the YWH_TOKEN environment variable as an alternative that avoids calling the tool entirely.

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