Skip to main content
Glama

api_keys_create

Destructive

Create a new API key with a name, optional IP/CIDR restrictions, and active status to control Aeza API access.

Instructions

Create a new API key POST /api-keys

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "body": "<body>"
    },
    "name": "api_keys_create"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

C2.7/5.0
Behavior2/5

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 nothing beyond creation itself — it never says the secret is returned once and cannot be retrieved later, nor what happens to prior keys. For a destructive, non-idempotent mutation that is a meaningful omission.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short lines with the action front-loaded and no filler; the endpoint line is mildly redundant with the tool name but adds API context cheaply.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive creation tool with an undocumented nested object body and no output schema, the definition is thin. An agent gets no signal about the returned credential, field semantics, or side effects, which are exactly what the description should carry here.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% for a nested body object with name, ips, and isActive. The description supplies no meaning for any of these fields — no format for name, no explanation that ips restricts usage, no default for isActive — so it fails to compensate for the low coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource ('Create a new API key'), which cleanly separates it from api_keys_edit and api_keys_get_list by name. It stops short of any explicit sibling differentiation beyond the verb, but the purpose is unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no guidance on when to create a key versus editing an existing one, no prerequisites, and no mention of permission requirements. Only the raw endpoint ('POST /api-keys') is offered, which assumes the agent already knows the API conventions.

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

Deploy Server

Other Tools