Skip to main content
Glama
takleb3rry

Zitadel MCP

by takleb3rry

zitadel_get_hosted_login_translation

Read-onlyIdempotent

Retrieve hosted login text overrides for a locale to customize Login V2. Get merged or only stored overrides at organization or instance level.

Instructions

Read the Login V2 (new "hosted login" / TypeScript login) text overrides for a locale, via the Settings v2 API. This is the ONLY text-customization that affects the new login — the legacy Management "Custom Login Texts" do not. By default returns the merged, effective file (your overrides on top of the shipped defaults); pass onlyOverrides=true to see just what is stored at this level. Defaults to the configured org; pass level:"instance" for the whole instance. Override keys mirror apps/login/locales/.json in zitadel/zitadel (e.g. "password.errors.couldNotCreateSessionForUser").

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
levelNoScope to read: "organization" (default, the configured ORG_ID) or "instance".
localeNoBCP-47 language tag, e.g. "de", "en", "fr-CH" (default "en").
onlyOverridesNotrue → return only the overrides stored at this level (ignoreInheritance). false (default) → the merged effective file.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.0.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so safety is covered. The description adds genuinely useful behavior beyond that: default returns the merged effective file (overrides on top of shipped defaults), onlyOverrides surfaces just the stored level, and level defaults to the configured org with instance as the alternative.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core purpose, then scope, then the merged-vs-overrides distinction, then the key format. Three dense sentences with no filler; slightly long but each clause carries information.

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?

No output schema exists, so the description carries some return-format burden, and it does describe the shape of the returned file (merged effective vs stored overrides). For a read-only, well-documented tool this is close to complete, though exact response structure is only implied.

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 100%, so the baseline is 3. The description goes further by giving the override-key convention and a concrete example ('password.errors.couldNotCreateSessionForUser') mirroring apps/login/locales/<locale>.json, and by restating the inheritance semantics of onlyOverrides meaningfully.

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 (Read) and resource (Login V2 hosted login text overrides for a locale) and explicitly distinguishes the target from the legacy Management 'Custom Login Texts'. An agent can identify this as the read counterpart to set_hosted_login_translation without opening a schema.

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?

Explains when this is the correct resource ('the ONLY text-customization that affects the new login') and rules out the legacy alternative. It gives context for the parameter branches (onlyOverrides, level) but never names the sibling write tool as the complement, leaving a small routing gap.

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