Skip to main content
Glama

get_module_keys

Get available keys in a specific module for translation in a project.

Args: module_id: The ID of the module to get keys from project_key: Project key (tenant ID). Uses global tenant_id if not provided

Returns: JSON string with available keys including key names, IDs, and resources

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
module_idYes
project_keyNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the burden of behavioral disclosure. It discloses that this is a read-only 'Get' operation, explains the fallback to global tenant_id when project_key is omitted, and specifies the return format (JSON string with key names, IDs, resources). This adds meaningful context beyond the tool name, though it omits error handling and authorization details.

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?

The description is tightly structured with a one-line summary, an Args section, and a Returns section. Every sentence provides relevant information without fluff, making it an exemplar of concise technical writing.

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 getter with two parameters and a fixed return type, the description covers the essential aspects: purpose, argument semantics (especially the optional parameter), and output format. The presence of an output schema further clarifies return structure. It lacks error-handling details and prerequisites, but these are not critical for this low-complexity tool.

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?

The schema has 0% description coverage, so the description must compensate. It explains module_id as the module to fetch keys from (mostly restating the schema) and project_key as a tenant ID with a fallback default, which adds useful semantics. However, the explanation for module_id is shallow, providing only partial compensation for the missing schema descriptions.

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?

The description clearly states that this tool gets available keys in a specific module for translation, using a specific verb ('Get') and resource (module keys). It distinguishes itself from sibling tools like get_translation_modules (which lists modules) and save_module_keys_with_translations (which saves keys).

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?

The description provides clear context: it is used for translation in a project and requires a module_id, with an optional project_key. However, it does not explicitly contrast with alternatives or state when not to use it, though the intended use case is evident from the wording.

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