Skip to main content
Glama

Get record by id

get_record
Read-only

Fetch any record's full detail by id. type is an optional hint — if omitted or wrong, the record is resolved by id and returned with its true type, so you never need to guess the type right. Covers the built-in objects (account, contact, opportunity, subscription, lead, task, touch, signal, note, playbook, report, meeting_recording, meeting, target, forecast_call), custom object keys, and the admin-only governance records (audit_log, pending_approval, report_run, policy; list them with search_records). A stale, unknown or malformed id returns {found:false} plus the search that finds the record fresh — never an error.

When to use: When you have an id and want the full record without searching. Works for built-in objects and custom-object records. Less common than search_* tools.

Example: Fetch opportunity .

Input Schema

NameRequiredDescriptionDefault
idYesThe record's id — a uuid from a previous read/search.
typeNoOptional type hint: account | contact | opportunity | subscription | lead | task | touch | signal | note | playbook | report | meeting_recording | meeting | target | forecast_call, a custom object key, or a governance record (audit_log | pending_approval | report_run | policy; admin-only).
include_archivedNoBoolean (true/false).

Output Schema

NameRequiredDescriptionDefault
noteNo
typeNo
foundNo
recordNo
web_urlNo
provenanceNo
merged_fromNo
custom_field_definitionsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedOutput schema / properties / merged_from
      Added value: +{
      +  "type": "string"
      +}
    • addedOutput schema / properties / provenance
      Added value: +{
      +  "type": "object"
      +}
  2. Changed2 schema fields changed
    • removedInput schema / properties / include_archived / anyOf
      Removed value: -[
      -  {
      -    "type": "boolean"
      -  },
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "number"
      -  }
      -]
    • addedInput schema / properties / include_archived / type
      Added value: +[
      +  "boolean",
      +  "string",
      +  "number"
      +]
  3. Changed1 schema field changed
    • removedInput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
  4. Changed6 schema fields changed
    • removedOutput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
    • removedOutput schema / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / custom_field_definitions / items / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / custom_field_definitions / items / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / properties / record / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / record / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
  5. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, but the description adds genuinely non-obvious behavior: a wrong or omitted `type` self-corrects, and a stale/unknown/malformed id returns {found:false} with a recovery search rather than an error. It also flags that governance records are admin-only, which is auth context the annotations do not carry.

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?

The critical behavior (id is authoritative, type is optional) is front-loaded in the first two sentences, and the when-to-use/example tail is short. The long enumeration of built-in object types is the one part that could be trimmed without loss.

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?

With an output schema present the description need not document return shape, and it instead covers the one return case that matters (not-found). For a simple 3-param read tool, an agent has everything needed to invoke it correctly and interpret failures.

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 baseline is 3; the description goes beyond the schema by explaining that `type` is a mere hint whose inaccuracy is harmless, which changes how an agent should populate it. `include_archived` is left to the schema's bare 'Boolean (true/false)' note, which keeps it from a 5.

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 ('Fetch any record's full detail by id') and enumerates exactly which object families are covered, including custom keys and admin-only governance records. It also positions itself relative to siblings ('less common than search_* tools', 'list them with search_records'), so an agent can distinguish it without opening any schema.

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?

A dedicated 'When to use' section plus the example 'Fetch opportunity <id>' gives clear context, and it names the competing approach (searching) explicitly. It stops short of stating when not to use it (e.g. bulk retrieval, or when only a summary is needed), so it lands at 4 rather than 5.

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