Skip to main content
Glama

Add glossary entries

add_glossary_entries
Destructive

Add (or update) glossary entries for a project in one call. Pass an array of term rows, each with its own source and target term and their project_language ids — so a single source term can have a different translation per target language. Resolve the language ids first with get_project. Entries are upserted on (project, sourceTerm, source, target); re-adding an existing key updates its target term and its do-not-translate flag. Set doNotTranslate on a row for a term that must be kept verbatim (a brand or product name); its stored target term is then forced to equal the source term. Both terms are trimmed of leading and trailing whitespace before they are checked and stored; a source term empty once trimmed is refused. Marks any matching translation-memory entries stale so future translations pick up the change. When referring to a project or language in your reply to the user, use its name and locale (e.g. "French (fr-FR)") — ids (UUIDs) are for tool calls only, never show them to the user.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
entriesYesThe glossary rows to upsert
projectYesProject id (UUID) or slug

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
entriesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • changedInput schema / properties / entries / items / properties / sourceTerm / description
      Previous value: -"The term as it appears in the source language"New value: +"The term as it appears in the source language (max 500 chars)"
    • addedInput schema / properties / entries / items / properties / sourceTerm / maxLength
      Added value: +500
    • changedInput schema / properties / entries / items / properties / targetTerm / description
      Previous value: -"The term as it should appear in the target language. May be empty only when doNotTranslate is true, in which case it is ignored."New value: +"The term as it should appear in the target language (max 500 chars). May be empty only when doNotTranslate is true, in which case it is ignored."
    • addedInput schema / properties / entries / items / properties / targetTerm / maxLength
      Added value: +500
  2. First observed

TDQS

A4.6/5.0
Behavior5/5

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

With destructiveHint=true already signaled, the description goes well beyond the annotation: upsert key on (project, sourceTerm, source, target), staleness marking of matching TM entries, whitespace trimming, rejection of empty source terms, and the doNotTranslate override that forces targetTerm = sourceTerm. These are exactly the destructive side effects an agent needs to know.

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 action, then the per-row model, prerequisites, and mutation semantics in a logical order. The closing instruction about showing names/locales rather than UUIDs is mildly tangential to invoking the tool but is still useful output guidance.

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?

Output schema exists, so return values needn't be explained, and the description still covers the two-parameter surface plus upsert, error, and side-effect behavior thoroughly. Nothing an agent needs to call this correctly is missing.

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, but the description adds real meaning: why targetTerm differs per target language, that an existing key updates target term and the do-not-translate flag, and the interaction between doNotTranslate and targetTerm. It stops short of 5 only because the schema already carries much of the per-field detail.

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 ('Add (or update) glossary entries for a project in one call') and immediately clarifies the batch/upsert nature, which separates it from list_glossary and delete_glossary_entry. The per-row source/target language model is spelled out concretely.

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 directs the agent to 'Resolve the language ids first with get_project', naming a sibling tool and a prerequisite ordering. It does not state when-not-to-use this tool (e.g., vs. list_glossary or delete_glossary_entry), so it falls just short of a full 5.

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.