Skip to main content
Glama

Create term embed

create_term_embed

Put one confirmed term of a project on other sites (PM-1165, PM-1166): a link anybody can open with no account, which shows the term's word, its definition with its formulas and — while the project is public — where it is defined; nothing else of the project. Answers with the ready code: 'script' once per page and 'mark' around the words on the site, which open the term in a cloud, or 'iframe', a card. Name the term by 'id' (list_terms), or by 'project' and 'term' — its word or any spelling. 'sites' limits which sites may show it (https://example.org each; none is any); 'days' gives it a term (none is until removed). Only for somebody who may write in the project and open the term's source; a line in the project's history. For many terms of one article, create_embed_set gives one link for all of them. 'lang' (e.g. 'en') shows the definition in that language: a person's translation (set_registry_translation), else the machine's, translated in the background and marked «Machine-translated from …»; a page may also ask for a language itself with data-kaiku-lang on the script.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "create_term_embed"
  }
}

Input Schema

NameRequiredDescriptionDefault
idNoThe term's id, as list_terms returned it. Or name it by 'project' and 'term'.
daysNoDays the link answers, 1 to 3650. Optional: none is until it is removed.
langNoThe language the link shows the words in, e.g. 'en' (PM-1373): a person's translation where there is one, else the machine's, marked as such. Optional: none shows them as written; a page may still ask for another.
termNoThe term's word or one of its spellings, with 'project'.
sitesNoSites that may show it, comma-separated, as https://example.org. Optional: none is any site.
projectNoThe project key, with 'term'.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / lang
      Added value: +{
      +  "default": null,
      +  "description": "The language the link shows the words in, e.g. 'en' (PM-1373): a person's translation where there is one, else the machine's, marked as such. Optional: none shows them as written; a page may still ask for another.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
  2. Added

TDQS

A4.5/5.0
Behavior4/5

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

Annotations declare non-readonly, non-destructive, closed-world, but the description adds substantial context beyond them: the link is publicly openable without an account, exposes only the word/definition/formulas, records a line in project history, and expires per 'days'. It even describes the response form ('script' per page, 'mark' around words, or 'iframe' card), which is valuable given no output schema. It stops short of covering rate limits or failure modes.

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

Conciseness3/5

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

The purpose is front-loaded, but the body is a single dense run-on paragraph of em-dashes, semicolons and nested parentheticals that is hard to scan. Ticket references (PM-1165, PM-1166, PM-1373) add no value for an agent and dilute the signal.

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 6-parameter mutation tool with no output schema, the description covers what is created, who can see it, what it exposes, how it expires, who may call it, and what the return value looks like. Nothing an agent needs to invoke it correctly appears to be 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 nuance: term can be named by 'id' or by 'project' plus 'term' (word or any spelling), 'sites' with 'none is any', and 'days' as 'none is until removed'. It also introduces the page-level 'data-kaiku-lang' override and the «Machine-translated from …» marker for 'lang', which the schema does not document.

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 ('Put one confirmed term of a project on other sites') plus concrete scope: a no-account link showing only the word, definition with formulas, and definition location. It explicitly distinguishes itself from the sibling create_embed_set ('For many terms of one article, create_embed_set gives one link for all of them').

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Names the alternative (create_embed_set) and the condition that selects it, i.e. many terms of one article. It also states the prerequisite audience ('Only for somebody who may write in the project and open the term's source'), which functions as an explicit when-to-use gate.

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