Skip to main content
Glama

issue_api_key

Issue a fresh ta_data_* API key for your current tenant and rotate: any previous key keeps working for one hour, then stops — the response reports how many and exactly when (previous_keys_retiring, previous_keys_retire_at). Use it to rotate, or when an integration needs a key and can't reach the console. The new key is tied to your existing plan tier. Rate-limited to 5 issuances per tenant per day.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteNo
planNo
userNo
errorNo
usageNo
key_idNoNon-secret fingerprint of the issued key. Safe to log and surface in UI.
statusYes
api_keyNoOne-time API key secret. Returned only on successful creation, in both structuredContent.api_key and content[0].text — save it immediately. The server stores only sha-256 of the secret; once this response is lost, the key is unrecoverable and must be rotated. Matches AWS IAM / Stripe / GitHub PAT one-time-reveal semantics.
tenantIdNo
retry_after_sNo
previous_keys_retiringNoHow many previously-live keys this mint scheduled to retire. issue_api_key rotates: after the grace window the returned key is the only live key on the tenant. 0 means there was nothing else.
previous_keys_retire_atNoISO 8601 instant when the previous keys stop working (one hour after this mint). Present only when previous_keys_retiring > 0. Update anything still using them before this time.
credential_returned_onceNo

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed3 schema fields changed
    • addedOutput schema / properties / previous_keys_retire_at
      Added value: +{
      +  "description": "ISO 8601 instant when the previous keys stop working (one hour after this mint). Present only when previous_keys_retiring > 0. Update anything still using them before this time.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / previous_keys_retiring
      Added value: +{
      +  "description": "How many previously-live keys this mint scheduled to retire. issue_api_key rotates: after the grace window the returned key is the only live key on the tenant. 0 means there was nothing else.",
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • removedOutput schema / properties / revoked_previous
      Removed value: -{
      -  "description": "How many previously-live keys this mint revoked. issue_api_key rotates: the returned key is the only live key on the tenant. 0 means there was nothing else to revoke.",
      -  "minimum": 0,
      -  "type": "integer"
      -}
  2. Changed1 schema field changed
    • addedOutput schema / properties / revoked_previous
      Added value: +{
      +  "description": "How many previously-live keys this mint revoked. issue_api_key rotates: the returned key is the only live key on the tenant. 0 means there was nothing else to revoke.",
      +  "minimum": 0,
      +  "type": "integer"
      +}
  3. Changed1 schema field changed
    • changedOutput schema / properties / api_key / description
      Previous value: -"One-time API key secret. Returned only on successful creation. Treat as a credential — never log, echo, or render in text channels."New value: +"One-time API key secret. Returned only on successful creation, in both structuredContent.api_key and content[0].text — save it immediately. The server stores only sha-256 of the secret; once this response is lost, the key is unrecoverable and must be rotated. Matches AWS IAM / Stripe / GitHub PAT one-time-reveal semantics."
  4. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": true,
      +  "properties": {
      +    "api_key": {
      +      "description": "One-time API key secret. Returned only on successful creation. Treat as a credential — never log, echo, or render in text channels.",
      +      "type": "string"
      +    },
      +    "credential_returned_once": {
      +      "type": "boolean"
      +    },
      +    "error": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "code": {
      +          "type": "string"
      +        },
      +        "message": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "code",
      +        "message"
      +      ],
      +      "type": "object"
      +    },
      +    "key_id": {
      +      "description": "Non-secret fingerprint of the issued key. Safe to log and surface in UI.",
      +      "type": "string"
      +    },
      +    "note": {
      +      "type": "string"
      +    },
      +    "plan": {
      +      "type": "string"
      +    },
      +    "retry_after_s": {
      +      "type": "number"
      +    },
      +    "status": {
      +      "enum": [
      +        "success",
      +        "error"
      +      ],
      +      "type": "string"
      +    },
      +    "tenantId": {
      +      "type": "string"
      +    },
      +    "usage": {
      +      "type": "string"
      +    },
      +    "user": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "status"
      +  ],
      +  "type": "object"
      +}
  5. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the annotations, the description explains the key rotation effect: previous keys keep working for one hour then stop, the response reports retiring keys and retirement time, the new key is tied to the existing plan tier, and issuance is rate-limited to 5 per tenant per day. This fully discloses the behavioral consequences without contradicting the 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?

Three sentences carry the full behavioral contract: what happens, when to use it, and the rate limit. The most important detail is front-loaded and there is no filler or repetition.

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

Completeness5/5

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

For a zero-parameter tool with an output schema, the description covers everything an agent needs: the action, rotation impact, response fields, tenant scope, plan-tier linkage, and rate limiting. Nothing important is missing.

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

Parameters4/5

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

The tool has zero parameters and schema coverage is vacuously 100%, so the baseline for parameter semantics is 4. The description adds no parameter documentation because none is needed. It instead focuses on relevant operational context, which is appropriate here.

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 opens with a specific verb and resource: 'Issue a fresh ta_data_* API key'. It clearly states the operation is for the current tenant and includes rotation semantics, so an agent knows exactly what the tool does and how it differs from ordinary key creation.

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 explicit use cases: 'Use it to rotate, or when an integration needs a key and can't reach the console.' This makes the intended context clear. It does not explicitly state when not to use it, but the rate limit and rotation behavior provide enough boundary for decision-making.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A3.9/5.0
Disambiguation4/5

Each tool targets a distinct resource/action, though some overlap exists between analyze_table and data_profile (both profile tables) and between pii_scan and configure_allowlist (both deal with PII). Clear descriptions and separation of quick vs. full analysis mitigate confusion.

Naming Consistency3/5

Most tools follow verb_noun (add_connection, describe_schema, generate_migration), but a notable minority use noun phrases (data_profile, pii_scan, query_firewall, saved_queries, quota, impact_analysis). This mixed convention creates inconsistency, though the naming is still readable.

Tool Count3/5

26 tools is slightly over the 16-25 heavy threshold, but each tool addresses a distinct need across connection management, querying, analysis, security, and performance. While the count feels high, the breadth justifies it; however, it's approaching the 'too many' range.

Completeness5/5

The tool set covers the full lifecycle: connections (add/remove/list/test), querying (query_sql, saved_queries, cross_db_query), schema exploration/migration (describe_schema, generate_migration, impact_analysis), data quality/compliance (analyze_table, data_profile, pii_scan), performance (explain_query, optimize_query, show_locks), and monitoring (watch_table, detect_anomalies). Any gaps are minor, such as no update_connection, but that's not a core need.

Resources