hamravesh_create_apikey

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

With no annotations, the description carries full burden. It reveals that the key value is returned only once and that the tool is disabled by default, which are important behavioral details. However, it omits authorization needs, side effects, and error conditions.

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 two sentences, front-loading the core action. It is concise, though the disabled warning could be formatted as a note.

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 creates an API key with 2 parameters, no output schema, and sibling list/delete tools, the description fails to explain parameter semantics or return value beyond the 'once only' mention. It provides minimal support for correct invocation.

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 coverage is 0%, and the description adds no meaning to parameters 'name' and 'org'. The names are generic and unexplained, leaving the agent guessing about their purpose (e.g., key label vs. organization ID).

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 states 'ساخت یک کلید API جدید برای سازمان' (Create a new API key for the organization), which clearly identifies the verb and resource. It is distinct from sibling tools like list_apikeys or delete_apikey.

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 explicit when-to-use or when-not-to-use guidance. The warning about being disabled unless HAMRAVESH_ALLOW_WRITE is set implies a prerequisite, but no alternatives or exclusions are mentioned.

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