Skip to main content
Glama

create_api_key

Create a new API key for your account or a specific server. The key value is displayed only once, so save it immediately.

Instructions

Создать новый API-ключ для аккаунта или конкретного сервера (api_keys/add). Значение ключа будет показано один раз в ответе — сохраните его.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ipNoБелый список IP, например 10.0.0.2, 10.4.6.3/24
nameYesИмя ключа
activeYestrue — ключ активен
confirmYesНужно true, чтобы выполнить операцию.
server_idNoID сервера; если не указан — ключ на весь аккаунт
login_notify_methodYesУведомления о входах по ключу; для per-server ключа используйте none
login_notify_addressNoEmail или webhook URL для уведомлений

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already establish this as a non-read-only operation, and the description adds a valuable behavioral warning: the key value is shown only once in the response and must be saved. This goes beyond the schema and annotations.

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

Conciseness5/5

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

Two short sentences, front-loaded with the core purpose and followed by the single most important operational warning. No redundant filler.

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

Completeness4/5

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

For a create operation with no output schema, the description covers the essential one-time-display behavior, and the schema documents all required and optional fields. A small gap remains: it does not mention when not to use alternatives, but nothing critical is missing for correct invocation.

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

Parameters3/5

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

The input schema provides 100% parameter coverage, including server_id semantics and the login_notify_method constraint. The description adds little beyond the account-or-server distinction, matching the baseline for fully documented schemas.

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

Purpose5/5

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

The description clearly states the action ('Создать новый API-ключ') and the resource with scope ('для аккаунта или конкретного сервера'), making it immediately distinguishable from sibling tools like list_api_keys, get_api_key, update_api_key, and delete_api_key.

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

Usage Guidelines4/5

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

The description gives clear context: create a new API key for an account, or for a server when server_id is relevant. It does not explicitly name alternatives or exclusions, but the creation intent is unambiguous and the sibling CRUD tools are obvious by contrast.

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