Skip to main content
Glama

Get a mechanism

get_mechanism
Read-onlyIdempotent

Read one published entry in full: definition, scope, boundary, distinguishing test, related identifiers, phase roles and status fields, with its versioned GitHub address and a citation line. Does not filter by review state; the requested identifier always returns. An unknown or retired identifier is an error that names the replacement or the closest identifiers. Entries describe processes in general, not the present state of any country, market or asset.

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": {
      "id": "<id>"
    },
    "name": "get_mechanism"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesEntry identifier, for example "energy_supply_shock".
versionNoRegistry version, for example "1.4.1" (a leading "v" is accepted). Default: the latest published version (1.4.1). Available: 1.0.0, 1.1.0, 1.2.0, 1.3.0, 1.3.1, 1.4.0, 1.4.1.

Output Schema

NameRequiredDescriptionDefault
urlYes
noteNo
entryYes
scopeNoScope of the registry: what the entries are and are not.
versionYes
citationYes
attributionNoCC BY 4.0 attribution: how an answer that uses the entries names the source.
review_noteNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / version / description
      Previous value: -"Registry version, for example \"1.4.0\" (a leading \"v\" is accepted). Default: the latest published version (1.4.0). Available: 1.0.0, 1.1.0, 1.2.0, 1.3.0, 1.3.1, 1.4.0."New value: +"Registry version, for example \"1.4.1\" (a leading \"v\" is accepted). Default: the latest published version (1.4.1). Available: 1.0.0, 1.1.0, 1.2.0, 1.3.0, 1.3.1, 1.4.0, 1.4.1."
  2. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already cover safety (readOnly, idempotent, non-destructive, closed-world), and the description adds substantial behavior beyond them: the complete field set returned, inclusion of a versioned address and citation line, the absence of review-state filtering, and precise failure semantics with remediation hints. It also warns that entries are generic process descriptions, not current-state analysis of a country or market, which prevents a plausible misuse.

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 return payload, then behavior, then a scope caveat in three sentences with no filler. The first sentence is a long comma-separated field list that borders on schema duplication, but each clause conveys what the caller actually receives.

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?

An output schema exists, yet the description still orients the reader on content, and it covers the error path and semantic scope that the schema cannot express. For a two-parameter, read-only lookup tool, nothing an agent needs in order to call it or interpret a failure is missing.

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%, with both id and version fully documented including the default and the enumerated available versions. The description only reinforces that an identifier is requested and that entries are versioned, adding no syntax or format detail the schema does not already supply, so the baseline 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 a specific verb and resource ('Read one published entry in full') and then enumerates the payload (definition, scope, boundary, distinguishing test, related identifiers, phase roles, status fields, GitHub address, citation line). 'One published entry' implicitly contrasts with the listing/searching siblings, so the agent can tell this is a single-entry fetch rather than a discovery call.

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?

Gives clear operating context: no review-state filtering, the requested identifier always returns, and unknown or retired identifiers produce an error naming the replacement or closest identifiers, which effectively routes the agent toward resolve_name/search when lookups fail. It stops short of explicitly naming a sibling alternative or stating the exclusion up front.

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.