Skip to main content
Glama

Create ingest key

create_ingest_key

Create an API key that can only send data to the given datasets. The result holds the key, shown only this once, and the endpoint and headers to send with it.

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": {
      "name": "<name>",
      "datasets": "<datasets>"
    },
    "name": "create_ingest_key"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesWhat the key is for, e.g. the app name.
datasetsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / datasets / items / description
      Previous value: -"Dataset name, from list_datasets."New value: +"A dataset name."
  2. First observed

TDQS

A4.2/5.0
Behavior5/5

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

Goes well beyond the annotations (which only say it is a non-destructive, non-idempotent write) by disclosing the single most important behavioral fact: the key is shown only once and cannot be retrieved later. It also states what the result contains (key, endpoint, headers) and that the key's permissions are capped to the supplied datasets, which is exactly the kind of consequence the agent needs to surface.

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 sentences, both front-loaded with the highest-value information: first what is created and its scope limit, then the one-time-secret warning and return shape. No filler or repetition of the title.

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?

With no output schema, the description takes responsibility for the return value by naming the key, endpoint, and headers, which covers the main gap. Only minor omissions remain, such as any limit on how many ingest keys can exist or permission prerequisites for creating one.

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 coverage is 50%: 'name' is documented and the dataset item type is documented, but the datasets array itself carries no description. The phrase 'the given datasets' confirms the parameter's role but adds no constraints or meaning beyond the schema's minItems/maxItems bounds.

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 ('Create an API key') and immediately narrows the scope ('can only send data to the given datasets'), which separates it from the generic get_api_keys and edit_api_keys siblings. An agent can tell what this produces without opening the schema.

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

Usage Guidelines3/5

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

Usage is only implied by the scope phrase 'can only send data to the given datasets' — the agent must infer that this is the tool for wiring up telemetry ingestion. There is no explicit when-to-use, when-not, or named alternative versus edit_api_keys or get_api_keys.

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