Skip to main content
Glama

desk_create_api_key

Issues an API key that acts as the named person, with the given scopes (never more than the caller holds). The secret is in this reply only. Keys have no expiry; revoke one to end it. Confirm with the user first.

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": {
      "user_id": "<user_id>",
      "scopes": "<scopes>"
    },
    "name": "desk_create_api_key"
  }
}

Input Schema

NameRequiredDescriptionDefault
labelNowhat the key is for
scopesYesscopes to grant, e.g. desk.read, desk.write; never more than the caller holds
purposeNoRequired on tools that read data or reports; recommended on every tool. One sentence: what you are doing and why (for example "finding this caller's open ticket to answer them"). Building a report, dashboard, analytics or an export is a SautiDesk Pro feature done by the report tools, not by pulling records.
user_idYesUUID of the person the key acts as (see desk_list_api_key_people)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Annotations only declare destructiveHint=false and openWorldHint=false; the description carries the important behavior itself: the secret is returned once and never again, keys never expire, and ending access requires explicit revocation. It also adds a human-confirmation requirement, which is exactly the kind of operational context annotations cannot express.

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?

Four short sentences with the most consequential facts (impersonation, one-time secret, no expiry) front-loaded and nothing wasted. The confirmation instruction lands last, which is a slightly weaker position than placing the gating requirement first, but the text is otherwise tight.

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 credential-issuing mutation with no output schema, the definition covers everything an agent needs: what it creates, how privileged it is, that the secret appears only in this response, that there is no expiry, and how to undo it. The one-time-secret warning in particular closes the gap left by the absent output schema.

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?

Schema description coverage is 100%, so every parameter including label, purpose, scopes, and user_id is already documented in the schema, and the description only echoes the scopes ceiling that the schema also states. It adds no new meaning about parameter formats or defaults, so the baseline 3 applies.

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?

States a specific verb and resource ("Issues an API key") plus the crucial semantic that the key acts as the named person and its scopes are bounded by the caller's own privileges. The closing clause "revoke one to end it" implicitly routes to desk_revoke_api_key, so an agent can place it among the desk_*api_key siblings without opening a schema.

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?

Gives a real precondition ("Confirm with the user first") and a hard constraint (scopes never exceed the caller's), which shapes when and how to call it. It does not explicitly name alternatives (desk_list_api_keys to audit, desk_revoke_api_key to undo, desk_list_api_key_people for user_id), so usage routing is clear but not fully spelled out.

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.

Resources