create_api_key

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

Discloses that the key is automatically stored in /root/.yourware/credentials.json, but lacks details on behavior when key already exists, overwrite policy, or required permissions. No annotations to compensate.

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 concise sentences with no fluff: first states action and storage, second gives usage guidance. Well-structured and 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?

Provides core purpose and storage location, but lacks information on output, error handling, and parameter behavior. For a simple tool with no output schema, more detail would be beneficial.

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 sole parameter (api_key, optional) is not explained; description does not clarify what happens when a key is provided vs when it is null (e.g., generation vs setting). Schema coverage is 0%, so description should cover this.

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 it creates a new yourware API key, with a specific verb and resource. It distinguishes from sibling tools (check_credentials, upload_project) which have different purposes.

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?

Provides a clear condition for use ('if current credentials are invalid'), but does not explicitly mention when not to use or suggest an alternative tool like check_credentials for verification.

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