Skip to main content
Glama

Get key

get_key
Read-only

Get a translation key's metadata (name, namespace, description) by its name. To get the key's translations, use get_translations.

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": {
      "keyName": "<keyName>"
    },
    "name": "get_key"
  }
}

Input Schema

NameRequiredDescriptionDefault
branchNoOptional: branch name
keyNameYesThe translation key name
namespaceNoOptional: namespace of the key
projectIdNoID of the project. Can be left out when the credential is bound to one project: a project API key, or an OAuth token for one project.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / projectId / description
      Previous value: -"ID of the project (required for PAT, auto-resolved for PAK)"New value: +"ID of the project. Can be left out when the credential is bound to one project: a project API key, or an OAuth token for one project."
  2. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered. The description adds useful scope information about which fields are returned versus which are deferred to another tool, but says nothing about not-found behavior or error handling when keyName/namespace/branch do not resolve.

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 short sentences, both informative, with the core purpose front-loaded and the disambiguation placed immediately after. No redundant wording.

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?

For a simple read-only lookup with full schema coverage and no output schema, the description covers purpose, returned data, and the main alternative. Missing only failure-mode context (e.g., unknown key or namespace), which is a minor gap for a tool of this complexity.

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 all four parameters (keyName, namespace, branch, projectId) are already documented in the schema, including the projectId credential-binding caveat. The description adds nothing parameter-specific beyond that, so 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 ("Get a translation key's metadata") and enumerates the returned fields (name, namespace, description). It also explicitly separates itself from get_translations, so an agent can distinguish this single-key metadata lookup from sibling retrieval tools.

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 an explicit routing rule: use this for metadata, use get_translations for translations. It also implies single-key lookup via "by its name", distinguishing it from list_keys/search_keys, though it does not state exclusions such as what to do when the key name is unknown.

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.