Skip to main content
Glama

Get record by id

get_record
Read-only

Fetch the full detail of any record by id. type is an OPTIONAL hint — if it's omitted or doesn't match the id, the record is resolved by id anyway and returned with its true type (so you never need to guess the type right). A built-in object (account, contact, opportunity, subscription, lead, task, touch, signal, note, playbook, report, meeting_recording, meeting, target, forecast_call) or a custom object key (records-backed). Governance records — audit_log, pending_approval, report_run, policy — resolve by id too (admin-only; list them with search_records). A stale/unknown/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

TableJSON 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

TableJSON Schema
NameRequiredDescriptionDefault
noteNo
typeNo
foundNo
recordNo
web_urlNo
custom_field_definitionsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the readOnly/destructive/openWorld annotations, the description discloses that `type` is a forgiving hint resolved against the true type, that admin-only governance records resolve by id, and critically that stale/unknown/malformed ids return {found:false} plus a fresh search rather than an error. These are substantial behavioral traits not present in structured fields.

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 core purpose, then edge-case behavior, then usage guidance. The long parenthetical type enumeration is dense but earns its place by defining the valid `type` space; overall efficient with minimal waste.

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, so return-value documentation is not required, yet the description still conveys the important {found:false} failure shape and the resolve-by-id guarantee. Nothing needed to call this tool correctly is missing.

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% (baseline 3), but the description adds real semantics beyond the schema: `type` is an optional hint that need not match, and the valid type space is enumerated. `include_archived` is left unexplained, so it does not fully cover all params.

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+resource and scope ('Fetch the full detail of any record by id'), and differentiates itself from siblings by noting it retrieves without searching and is 'less common than search_* tools'. An agent can distinguish it from search_records and update_record without opening a 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?

Explicit 'When to use: When you have an id and want the full record without searching' gives a clear triggering condition, and it routes governance-record listing to search_records. It stops short of naming a full alternative/negative case for each object type, so it is clear but not exhaustive.

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