Skip to main content
Glama
@cmssy/mcp-server

@cmssy/mcp-server

Official

Get record

get_record
Read-only

Retrieve a data model record by ID with all field values, status, and its server-built live storefront URL; use that URL for links instead of building one manually.

Instructions

Get one record (entry) of a data model by its id, including all its field values and status. A company record (a model with the Company capability) also carries vatId, vatCountry, vatVerifiedAt, vatVerifiedBy and taxExemptReason, null when unset (set_company_vat_id, set_company_vat_verified, set_company_tax_exemption). A product record also carries currencyPrices and variantCurrencyPrices - its prices in additional currencies, minor units, enabled false while that currency is not an additional currency (set_product_currency_prices, set_product_variants); its data holds the default-currency price. Each record carries url: its live storefront link, built by the server from the model's urlPattern and the site's public site URL. Use it whenever you link to a record and never build a storefront URL yourself (not from a slug, not from the site address). When url is null or missing, say why instead of guessing: the model has no urlPattern (set it with update_model), the model is not delivered (deliveryAccess none, or it is the login model), the site has no public site URL, or the record - or one it links to - is unpublished.

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": {
      "recordId": "<recordId>"
    },
    "name": "get_record"
  }
}

Input Schema

NameRequiredDescriptionDefault
recordIdYesThe record's id (from list_records)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.73.2
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / required
      Added value: +[
      +  "recordId"
      +]
  2. First observedv0.73.1

TDQS

A4/5.0
Behavior5/5

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

Annotations only declare readOnlyHint/destructiveHint=false; the description goes well beyond that by disclosing conditional payload shape: company records carry vatId/vatVerifiedAt/taxExemptReason (null when unset), product records carry currencyPrices in minor units with enabled=false marking non-additional currencies, and every record carries a server-built `url`. It also enumerates the four distinct reasons `url` can be null, which is exactly the kind of non-obvious behavior an agent cannot infer from structure.

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 core purpose is correctly front-loaded in the first clause, and nearly every sentence carries substantive information. But it is delivered as one dense paragraph mixing payload shape, field semantics, URL policy and sibling-tool routing, which makes it harder to scan than it needs to be; the setter names parentheticals could be trimmed without losing much.

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?

For a one-parameter read tool with no output schema, the description covers return content, conditional field presence, and the URL edge cases thoroughly. The remaining gap is failure behavior for an invalid or missing recordId, which an agent would need before calling correctly on bad input.

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 description coverage is 100% and the single parameter already documents itself as "The record's id (from list_records)". The description adds only the phrase "by its id", which is redundant with the schema, so 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 a specific verb and resource ("Get one record (entry) of a data model by its id") and immediately enumerates what comes back (field values, status). It also implicitly distinguishes itself from list-oriented siblings by naming list_records as the source of the id, so an agent can tell it apart from the get_*/list_* family without opening the schema.

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

Usage Guidelines3/5

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

Guidance is strong on how to use the returned data ("Use it whenever you link to a record and never build a storefront URL yourself") and on which setter to reach for when VAT or currency fields are unset. However, it never says when to prefer this tool over alternatives such as list_records, bulk_update_records or get_model, nor any preconditions for the call beyond needing an id.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools