create_api_key
Create a new API key for your Xyle account. The full key is only shown once upon creation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | A descriptive name for the API key (e.g. 'Claude Desktop', 'CI/CD') |
Create a new API key for your Xyle account. The full key is only shown once upon creation.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | A descriptive name for the API key (e.g. 'Claude Desktop', 'CI/CD') |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, idempotentHint=false, and openWorldHint=true, so the safety profile is covered. The description adds a genuinely important non-schema behavior: the full key is only shown once upon creation, which tells the agent how to handle and relay the result.
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, front-loaded with the action and resource, then the critical one-time-display caveat. Nothing is wasted.
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 single-parameter creation tool with annotations covering safety traits and no output schema, the description is nearly complete: it identifies the account scope and the one-time key disclosure. Minor gaps (scopes/permissions on the new key, whether names must be unique) keep it short of a 5.
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?
There is a single parameter with 100% schema description coverage that already includes examples ('Claude Desktop', 'CI/CD'). The description adds no meaning beyond the schema, so the baseline 3 applies.
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 ('Create') and resource ('API key') scoped to the Xyle account, which cleanly separates it from siblings like list_api_keys and revoke_api_key. It doesn't explicitly name an alternative, but the operation is 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?
No when-to-use guidance, no prerequisites, and no mention of sibling alternatives such as revoke_api_key or list_api_keys. The agent must infer the trigger context entirely.
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.