Skip to main content
Glama

Lexpad – Vocabulary Notebook & Flashcards

Retire a word

set_retired
Idempotent

Pauses a word (the app calls it Paused): it stops coming up in practice and keeps its progress. Or brings a paused word back into practice.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "word_id": "<word_id>",
      "retired": "<retired>"
    },
    "name": "set_retired"
  }
}

Input Schema

NameRequiredDescriptionDefault
retiredYestrue to retire the word, false to bring it back into practice.
word_idYesThe id of a word from another tool's result.

Output Schema

NameRequiredDescriptionDefault
idYes
posNo
levelNo
topicNo
addedOnYes
headwordYes
meaningsYes
progressYes
usageNoteNo
correctionNo
notebookIdYes
expressionsNo
collocationsNo
hardSpellingNo
relatedWordsNo
spellingNoteNo
pronunciationNo
originalMeaningNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, and destructiveHint=false, covering the safety profile. The description adds genuinely useful behavior beyond that: state and progress are preserved, and the action is reversible. It does not mention permission needs, failure modes (e.g. invalid word_id), or side effects on scheduling, so it remains a moderate contribution.

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?

Two short sentences with the primary definition front-loaded; the parenthetical clarifying the Paused naming is well placed. The second sentence reads as a sentence fragment ('Or brings a paused word back into practice'), a minor structural blemish that does not impede comprehension.

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?

With only two fully documented parameters and an output schema present, the description needs only to convey the semantic intent of the operation, which it does, including the terminology mapping. Minor gaps (no explicit contrast with delete_word, no failure-mode notes) are acceptable at this complexity.

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?

Schema coverage is 100%; both word_id and the retired boolean are already documented in the schema, including the true/false meaning. The description's only added value is reinforcing that 'retired' maps to the app's 'Paused' concept, which is a useful gloss but not new parameter detail. Baseline 3 applies.

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 the specific operation (pause/retire a word) and its inverse in one place, plus resolves the naming mismatch between the tool name 'set_retired' and the UI term 'Paused'. The phrase 'keeps its progress' implicitly separates it from delete_word, so an agent can tell the reversible operation apart from the destructive sibling.

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?

Both directions of use are spelled out (retire to stop practice appearances, un-retire to resume), and 'keeps its progress' signals the intended alternative to deletion. It stops short of explicitly naming delete_word as the when-not-to-use alternative, leaving that inference to the agent.

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