Create REST API Key
create_api_keyCreate a new REST API key (cb_…). The raw key is returned once and cannot be retrieved later.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Human-readable label for the key (max 100 chars). |
create_api_keyCreate a new REST API key (cb_…). The raw key is returned once and cannot be retrieved later.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Human-readable label for the key (max 100 chars). |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the safety profile (readOnlyHint=false, destructiveHint=false, idempotentHint=false), and the description adds a genuinely important behavioral fact not in the schema: the raw key is returned once and is unrecoverable. It does not cover permissions/scopes or duplicate-name behavior, so not a 5.
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 short sentences with zero filler; the one-time-secret warning is front-loaded where the agent will read it before calling.
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?
For a one-parameter creation tool with no output schema, the description covers the essential return behavior (raw key shown once). It omits edge cases like duplicate names or key scoping, but nothing critical for correct invocation is missing.
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 100% for the single 'name' parameter, so the schema already documents it fully; the description adds no syntax or constraint detail beyond that. Baseline 3 is appropriate.
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 ('Create a new REST API key') and even gives the key prefix format (cb_…), which cleanly distinguishes it from create_mcp_key and set_byok_key in the sibling list.
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 says what the tool does but never states when to choose it over create_mcp_key or set_byok_key, nor any precondition (plan tier, existing-key limits). The agent must infer from the name alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.