Skip to main content
Glama
rawtreedb

RawTree MCP Server

Official
by rawtreedb

Create API Key

create-api-key

Generate a RawTree API key for CI, agents, connectors, or scripts with read-only, write-only, read-write, or admin permissions. The key is shown once, so display it to the user.

Instructions

Purpose: Create a new RawTree API key for a cluster.

NOT for: User login. Use RawTree auth/CLI or the dashboard for that workflow.

Returns: The new API key value. The API key is only shown once, so you MUST display it to the user.

Auth: Uses POST /v1/keys and requires admin permission for database API key auth.

When to use:

  • User needs a key for CI, an agent, a connector, or a script

  • User wants a read-only, write-only, read-write, or admin credential

  • User asks to rotate credentials by creating a replacement before revoking the old key

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesHuman-readable API key name.
clusterNoRawTree cluster to use for this operation.
databaseNoOptional default database for the new key. RawTree uses the default database when omitted.
permissionNoPermission level. Prefer read_only for query-only agents and write_only for ingest-only connectors.read_write
organizationNoRawTree organization containing the target cluster.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.3.2
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • addedInput schema / properties / cluster
      Added value: +{
      +  "description": "RawTree cluster to use for this operation.",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / database
      Added value: +{
      +  "description": "Optional default database for the new key. RawTree uses the default database when omitted.",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / organization
      Added value: +{
      +  "description": "RawTree organization containing the target cluster.",
      +  "minLength": 1,
      +  "type": "string"
      +}
  2. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does so well: it discloses the endpoint (POST /v1/keys), the admin-permission requirement, and critically that the returned key is shown only once and MUST be surfaced to the user. It omits secondary traits like rate limits or whether creating a key affects existing keys, keeping it just short of a 5.

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?

Bold-labeled sections (Purpose, NOT for, Returns, Auth, When to use) front-load the identity and the critical warning, and every line earns its place. No filler or restated title.

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?

No output schema and no annotations, so the description must cover the return value and safety context - and it does, explaining that the key value is returned once and must be displayed, plus the auth prerequisite. Complete for a create-key operation.

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 100%, so all five parameters (including the permission enum with a default) are already documented in the schema. The description reinforces permission intent ('read-only, write-only, read-write, or admin credential') but adds no syntax or format detail beyond the schema. 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 - 'Create a new RawTree API key for a cluster' - and explicitly contrasts with a sibling workflow ('NOT for: User login'). An agent can distinguish this from list-api-keys and delete-api-key without opening any schema.

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

Usage Guidelines5/5

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

Provides an explicit 'NOT for' exclusion naming the alternative (RawTree auth/CLI or dashboard) plus a three-bullet 'When to use' list covering CI/agents/connectors, permission scoping, and rotation. Nothing about when to select this tool is left to inference.

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