Refresh Ninova Session

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

With no annotations provided, the description carries full burden. It mentions the use of environment variables but fails to disclose side effects (e.g., invalidation of existing session tokens), prerequisites (environment variables must be set), or rate limits. The behavioral contract is minimal.

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?

A single, succinct sentence that immediately communicates the tool's primary action. No wasted words.

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 parameters and existing output schema (though not detailed here), the description is adequate but could be improved by mentioning that the tool overwrites any existing session and requires the environment variables to be set. Lacks completeness on state changes.

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 input schema is empty (0 parameters, 100% coverage), so baseline is 4. The description adds value by clarifying that the tool relies on implicit environment variables NINOVA_USERNAME and NINOVA_PASSWORD, which are not in the 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 tool forces a new login using environment variables NINOVA_USERNAME and NINOVA_PASSWORD. It distinguishes from the sibling 'auth_status' (which checks session state) by indicating it performs a fresh 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?

The description implies the tool should be used when a session refresh is needed (e.g., after token expiry) but does not explicitly state when to use it versus alternatives like 'auth_status' or when not to use it.

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