Create API Key

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

No annotations provided, so the description carries the full burden. It discloses that the returned key is only shown once (must display to user), requires admin permission, and uses POST /v1/keys. This is strong coverage, though could mention whether the key is immediately active or any side effects.

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 well-structured with markdown headings and bullet points, front-loading the purpose and exclusions. Every sentence serves a distinct purpose, with no unnecessary words, making it efficient and clear.

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 has only 2 parameters, no output schema, and no annotations, the description covers all essential aspects: purpose, when to use/not use, return value behavior, authentication requirements, and parameter guidance. It is complete for an agent to correctly invoke this tool.

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 100%, so baseline is 3. The description adds value by explaining how to choose permission levels (prefer read_only for query-only, write_only for ingest-only) and that name is human-readable, going beyond the schema's minimal descriptions.

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 specifies the tool creates a RawTree API key for the configured project, distinguishing it from sibling tools like delete-api-key and list-api-keys. The verb 'create' and resource 'API key' are precise and unambiguous.

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 states what the tool is NOT for (user login, creating projects) and provides alternative workflows. Lists concrete use cases (CI, agents, connectors, scripts, credential rotation) and gives permission-level recommendations, making it clear when to choose this tool.

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