Skip to main content
Glama

get_record

Retrieve a single Gadget record by model and ID, with optional GraphQL field selection. Use it to fetch specific app data for queries.

Instructions

Get a single Gadget record by ID. Specify the model name, record ID, and fields to return.

Input Schema

NameRequiredDescriptionDefault
idYesRecord ID
modelYesModel name in camelCase, e.g. shopifyOrder, label
fieldsNoGraphQL field selection. Omit or use "*" for every scalar field; mix with relations like "* lineItems { edges { node { title } } }".

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.4.0
    • changedInput schema / properties / fields / description
      Previous value: -"GraphQL field selection, e.g. \"id name email createdAt\""New value: +"GraphQL field selection. Omit or use \"*\" for every scalar field; mix with relations like \"* lineItems { edges { node { title } } }\"."
    • changedInput schema / required
      Previous value: -[
      -  "model",
      -  "id",
      -  "fields"
      -]New value: +[
      +  "model",
      +  "id"
      +]
  2. First observedv1.0.6

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations provided, the description carries the full behavioral burden. 'Get' implies a read, but nothing is said about permissions/auth requirements, error behavior for a missing or invalid ID, or whether the returned shape depends on the fields selection. This is thin for an unannotated 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?

Two short sentences with the purpose front-loaded and no filler. The second sentence is largely redundant with the schema, which keeps it just short of a 5.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple 3-parameter read tool with full schema coverage and no output schema, the description is minimally adequate. It omits error/not-found behavior and any hint that the fields selection governs the response shape, which would matter for an agent calling it cold.

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%, so the baseline is 3; the schema already documents 'model' (camelCase example) and 'fields' (GraphQL selection syntax) thoroughly. The description only restates that these three inputs exist and adds no syntax or format detail beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource with scope ('Get a single Gadget record by ID'), which clearly separates it from list-style siblings. However, it never names or contrasts with the obvious alternatives (query_records, run_graphql), so the agent must infer the boundary itself.

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

Usage Guidelines2/5

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

The second sentence ('Specify the model name, record ID, and fields to return') is a restatement of the input parameters, not usage guidance. There is no statement of when to prefer this over query_records or run_graphql, nor any prerequisite or exclusion.

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