Create a scoped API token by specifying its name, scopes, and lifetime. Omit scopes to grant full access.
Create a new API token (API 3.x: tokens are scoped)
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Token name | |
| scopes | No | Token scopes (see api_tokens_scopes_list); omit for full access | |
| expiresInDays | Yes | Token lifetime in days |
Changes observed during successful MCP inspections.
v2.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the burden. It discloses only that API 3.x tokens are scoped, but omits critical behaviors: whether the token secret is returned only once, whether existing tokens are affected, and any permission requirements.
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 9-word sentence that puts the verb and object first. No redundant or filler content; it is appropriately short.
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?
With no output schema or annotations, the description is too sparse for a create operation. It fails to mention what the response contains (e.g., the token value), how to discover valid scopes, or any post-creation consequences, which are important for an API token creation 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?
The input schema fully describes all three parameters (name, scopes, expiresInDays) with its own descriptions, so the description adds no additional parameter semantics. The 'omit for full access' behavior is documented in the schema, not the description.
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 API token'. Among the api_tokens_* siblings, only this one creates tokens, so no ambiguity; the parenthetical about API 3.x scoping adds useful context.
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 guidance on when to use this vs alternatives like api_tokens_list or api_tokens_delete. The name implies creation, but there is no statement about prerequisites (e.g., needing to list scopes first) or exclusion cases.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.