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. A project's glossary may be shared by other projects and Workflows in the organisation: a change to it applies to every one of them, and only the terms of the languages of the addressed project are listed or changed. The result's glossary.sharedWith names the others — tell the user which ones a change affects. While glossary.repositoryManaged is set, the glossary is synced from that project's asset repository and every write is refused. 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
glossaryYesThe project's attached glossary and what else uses it

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedOutput schema / properties / glossary
      Added value: +{
      +  "additionalProperties": {},
      +  "description": "The project's attached glossary and what else uses it",
      +  "properties": {
      +    "id": {
      +      "type": "string"
      +    },
      +    "name": {
      +      "type": "string"
      +    },
      +    "repositoryManaged": {
      +      "anyOf": [
      +        {
      +          "additionalProperties": {},
      +          "properties": {
      +            "branch": {
      +              "type": "string"
      +            },
      +            "gitUrl": {
      +              "type": "string"
      +            },
      +            "projectId": {
      +              "type": "string"
      +            },
      +            "repositoryId": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "projectId",
      +            "repositoryId",
      +            "gitUrl",
      +            "branch"
      +          ],
      +          "type": "object"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "The project whose asset repository the glossary is synced from (writes are refused), or null"
      +    },
      +    "sharedWith": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "projects": {
      +          "description": "Other projects attached to the glossary",
      +          "items": {
      +            "additionalProperties": {},
      +            "properties": {
      +              "id": {
      +                "type": "string"
      +              },
      +              "name": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "id",
      +              "name"
      +            ],
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "workflows": {
      +          "description": "Active Workflows using the glossary",
      +          "items": {
      +            "additionalProperties": {},
      +            "properties": {
      +              "id": {
      +                "type": "string"
      +              },
      +              "name": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "id",
      +              "name"
      +            ],
      +            "type": "object"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "required": [
      +        "projects",
      +        "workflows"
      +      ],
      +      "type": "object"
      +    }
      +  },
      +  "required": [
      +    "id",
      +    "name",
      +    "sharedWith",
      +    "repositoryManaged"
      +  ],
      +  "type": "object"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "entries"
      -]New value: +[
      +  "entries",
      +  "glossary"
      +]
  2. 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
  3. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Far beyond the annotations: it discloses upsert-key semantics, that doNotTranslate forces targetTerm to equal sourceTerm, whitespace trimming, refusal of empty source terms, stale translation-memory side effects, that writes are refused while repositoryManaged, and that the shared glossary propagates to other projects and Workflows. This is unusually complete disclosure for a mutation tool.

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?

The purpose is front-loaded and nearly every sentence carries substantive behavior, but the block is long and the closing sentence about not exposing UUIDs to the user is a general style rule that sits slightly outside this tool's scope.

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 destructive batch upsert with shared-glossary propagation risk, the description covers prerequisites, side effects, refusal conditions, and the salient output field (glossary.sharedWith). With an output schema present, nothing an agent needs to call it 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; the description adds the upsert identity key (project, sourceTerm, source, target) and the trimming/doNotTranslate interaction that the schema only partially conveys. It meaningfully extends the schema rather than restating it.

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 opening sentence states a specific verb pair (add/update), the resource (glossary entries), the scope (a project), and the batching mode (one call). An agent can distinguish it from siblings like list_glossary and delete_glossary_entry without opening either 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?

It gives clear prerequisite sequencing — 'Resolve the language ids first with get_project' — and the upsert semantics imply when re-adding is appropriate. It stops short of naming explicit alternatives or when-not-to-use conditions, so it earns a solid 4 rather than 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.