Skip to main content
Glama

Redeem a pairing code

rayana_ai_complete_setup
Destructive

For clients that connect with an API key rather than OAuth: exchanges a pairing code from the user's account page for an API key. Destructive: it issues a new key and immediately revokes the account's previous one, so any other client still using the old key stops working. OAuth connections are not affected.

The key is returned once and cannot be retrieved later; only a hash of it is stored. It is sent as the X-API-Key header on MCP and REST requests. Codes are single-use, expire after 15 minutes, and are invalidated after a few wrong attempts.

Input Schema

NameRequiredDescriptionDefault
codeYes

Output Schema

NameRequiredDescriptionDefault
noteYes
tierYes
api_keyYes
mcp_urlYes
header_nameYes
rest_base_urlYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.7/5.0
Behavior5/5

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

Goes well beyond the destructiveHint=true annotation: it explains that a new key immediately revokes the previous one so other clients break, that the key is shown once and only a hash is stored, that it is sent as the X-API-Key header, and that codes are single-use, expire in 15 minutes, and are invalidated after a few wrong attempts. This is exactly the operational context an agent needs before an irreversible action.

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 tight paragraphs, front-loaded with the purpose and the destructive consequence before the mechanics. Nearly every sentence adds decision-relevant information; nothing is filler.

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 one-parameter destructive auth tool with an output schema, the description covers purpose, safety consequence, credential handling, and code lifecycle. An agent has everything required to call it correctly and warn the user beforehand.

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?

Schema coverage is 0%, so the description must carry the parameter. It does: it tells the agent the lone 'code' comes from the user's account page, is single-use, expires after 15 minutes, and is invalidated after wrong attempts. It omits any format/length detail, which is a minor gap.

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: 'exchanges a pairing code from the user's account page for an API key.' It also scopes who this is for ('clients that connect with an API key rather than OAuth'), which cleanly separates it from every read-only analyst sibling.

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?

Explicitly gives the condition for use ('For clients that connect with an API key rather than OAuth') and rules out impact on OAuth connections. It does not name an alternative tool to use instead, but for a setup/auth tool the usage context is unambiguous.

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