Skip to main content
Glama

Read a federal record

detail
Read-onlyIdempotent

Retrieve a public record using the exact collection and id returned by search, never a page URL, title or slug. Supply the returned generation for a consistent result.

Input Schema

NameRequiredDescriptionDefault
idYesExact stable record ID returned by search, not a page URL or slug.
collectionYesPublic collection name returned by search.
generationNoRetained generation UUID from search for a consistent record snapshot.

Output Schema

NameRequiredDescriptionDefault
idYes
dataYes
textYes
titleYes
coverageNoPresent for exclusions, including explicit source-age warnings.
collectionNoAbsent for curated reference records.
generationYes
text_lengthNoTotal text characters; absent from internal brief notices.
text_has_moreNoWhether another text chunk is available.
award_coverageNoAward snapshot age and latest official release evidence.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedOutput schema / $defs / AwardAvailability / properties / failure_kind
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / $defs / AwardAvailability / properties / failure_retry_seconds
      Added value: +{
      +  "format": "uint64",
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • addedOutput schema / $defs / AwardAvailability / properties / failure_stage
      Added value: +{
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • changedOutput schema / $defs / AwardAvailability / required
      Previous value: -[
      -  "state",
      -  "check_interval_seconds",
      -  "max_check_age_seconds"
      -]New value: +[
      +  "state",
      +  "check_interval_seconds",
      +  "failure_retry_seconds",
      +  "max_check_age_seconds"
      +]
  2. Changed3 schema fields changed
    • addedOutput schema / $defs / SourceFreshness / properties / attention_required
      Added value: +{
      +  "type": "boolean"
      +}
    • addedOutput schema / $defs / SourceFreshness / properties / warn_age_seconds
      Added value: +{
      +  "description": "Early-warning boundary, separate from the stale-source boundary.",
      +  "format": "int64",
      +  "type": "integer"
      +}
    • changedOutput schema / $defs / SourceFreshness / required
      Previous value: -[
      -  "state",
      -  "evaluated_at",
      -  "max_age_seconds"
      -]New value: +[
      +  "state",
      +  "evaluated_at",
      +  "max_age_seconds",
      +  "warn_age_seconds",
      +  "attention_required"
      +]
  3. Changed4 schema fields changed
    • addedOutput schema / $defs / AwardAvailability
      Added value: +{
      +  "properties": {
      +    "artifact_http_status": {
      +      "format": "uint16",
      +      "maximum": 65535,
      +      "minimum": 0,
      +      "type": [
      +        "integer",
      +        "null"
      +      ]
      +    },
      +    "check_interval_seconds": {
      +      "format": "uint64",
      +      "minimum": 0,
      +      "type": "integer"
      +    },
      +    "checked_at": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "inventory_http_status": {
      +      "format": "uint16",
      +      "maximum": 65535,
      +      "minimum": 0,
      +      "type": [
      +        "integer",
      +        "null"
      +      ]
      +    },
      +    "latest_release_date": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "latest_release_url": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "max_check_age_seconds": {
      +      "format": "int64",
      +      "type": "integer"
      +    },
      +    "state": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "state",
      +    "check_interval_seconds",
      +    "max_check_age_seconds"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / $defs / AwardCoverage
      Added value: +{
      +  "properties": {
      +    "dataset": {
      +      "type": "string"
      +    },
      +    "freshness": {
      +      "$ref": "#/$defs/AwardFreshness"
      +    },
      +    "source_date": {
      +      "type": "string"
      +    },
      +    "source_url": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "dataset",
      +    "source_date",
      +    "source_url",
      +    "freshness"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / $defs / AwardFreshness
      Added value: +{
      +  "properties": {
      +    "age_state": {
      +      "type": "string"
      +    },
      +    "age_warning_after_days": {
      +      "format": "int64",
      +      "type": "integer"
      +    },
      +    "effective_source_date": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "source_age_days": {
      +      "format": "int64",
      +      "type": [
      +        "integer",
      +        "null"
      +      ]
      +    },
      +    "upstream": {
      +      "$ref": "#/$defs/AwardAvailability"
      +    },
      +    "warning": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    }
      +  },
      +  "required": [
      +    "age_state",
      +    "age_warning_after_days",
      +    "upstream"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / award_coverage
      Added value: +{
      +  "description": "Award snapshot age and latest official release evidence.",
      +  "items": {
      +    "$ref": "#/$defs/AwardCoverage"
      +  },
      +  "type": [
      +    "array",
      +    "null"
      +  ]
      +}
  4. Changed4 schema fields changed
    • addedOutput schema / $defs / ExclusionCoverage
      Added value: +{
      +  "properties": {
      +    "freshness": {
      +      "$ref": "#/$defs/SourceFreshness",
      +      "description": "Fresh, stale, unknown or unavailable, with age and the 24-hour warning policy."
      +    },
      +    "observed_at": {
      +      "description": "Observation time does not replace the official source timestamp.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "scope": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "sha256": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "source_date": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "source_url": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "status": {
      +      "description": "Present as unavailable when no SAM coverage exists in this generation.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    }
      +  },
      +  "required": [
      +    "freshness"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / $defs / FreshnessState
      Added value: +{
      +  "enum": [
      +    "fresh",
      +    "stale",
      +    "unknown",
      +    "unavailable"
      +  ],
      +  "type": "string"
      +}
    • addedOutput schema / $defs / SourceFreshness
      Added value: +{
      +  "properties": {
      +    "evaluated_at": {
      +      "description": "UTC time when age was evaluated; source and observation dates are unchanged.",
      +      "type": "string"
      +    },
      +    "max_age_seconds": {
      +      "description": "Explicit warning threshold for this daily snapshot. Not a scheduler promise.",
      +      "format": "int64",
      +      "type": "integer"
      +    },
      +    "source_age_seconds": {
      +      "description": "Age of the official source timestamp, never the import or enrichment timestamp.",
      +      "format": "int64",
      +      "type": [
      +        "integer",
      +        "null"
      +      ]
      +    },
      +    "state": {
      +      "$ref": "#/$defs/FreshnessState"
      +    },
      +    "warning": {
      +      "description": "User-facing warning, or null when within the warning threshold.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    }
      +  },
      +  "required": [
      +    "state",
      +    "evaluated_at",
      +    "max_age_seconds"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / coverage
      Added value: +{
      +  "anyOf": [
      +    {
      +      "$ref": "#/$defs/ExclusionCoverage"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Present for exclusions, including explicit source-age warnings."
      +}
  5. Changed1 schema field changed
    • changedInput schema / properties / id / description
      Previous value: -"Stable record ID returned by search."New value: +"Exact stable record ID returned by search, not a page URL or slug."
  6. Changed4 schema fields changed
    • addedInput schema / properties / collection / description
      Added value: +"Public collection name returned by search."
    • addedInput schema / properties / generation / description
      Added value: +"Retained generation UUID from search for a consistent record snapshot."
    • addedInput schema / properties / id / description
      Added value: +"Stable record ID returned by search."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$defs": {
      +    "JsonObject": {
      +      "description": "Source-specific JSON map. The envelope is stable; map keys vary by official source.",
      +      "type": "object"
      +    }
      +  },
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "properties": {
      +    "collection": {
      +      "description": "Absent for curated reference records.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "data": {
      +      "$ref": "#/$defs/JsonObject"
      +    },
      +    "generation": {
      +      "type": "string"
      +    },
      +    "id": {
      +      "type": "string"
      +    },
      +    "text": {
      +      "type": "string"
      +    },
      +    "text_has_more": {
      +      "description": "Whether another text chunk is available.",
      +      "type": [
      +        "boolean",
      +        "null"
      +      ]
      +    },
      +    "text_length": {
      +      "description": "Total text characters; absent from internal brief notices.",
      +      "format": "uint",
      +      "minimum": 0,
      +      "type": [
      +        "integer",
      +        "null"
      +      ]
      +    },
      +    "title": {
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "generation",
      +    "id",
      +    "title",
      +    "text",
      +    "data"
      +  ],
      +  "type": "object"
      +}
  7. Added

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, and openWorld, so safety behavior is covered. The description adds real value by warning that synthesized identifiers (URLs/slugs/titles) will fail and that generation pins a consistent snapshot, but it says nothing about what happens on a stale generation or missing record.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight sentences with zero filler; the identity constraint is front-loaded and the optional consistency parameter follows. Every clause carries actionable information.

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?

With an output schema present and rich annotations, the description needs only to cover the call contract, which it does: where identifiers come from and why to pass generation. Minor omission is failure-mode guidance for stale generations or unknown IDs.

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%, so all three parameters are already documented, including the constraint against URLs/slugs and the snapshot purpose of generation. The description restates those same semantics rather than adding new detail, so it lands at the baseline.

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?

Uses a specific verb+resource combination ("Retrieve a public record") reinforced by the title "Read a federal record." It is distinguishable from the search-based siblings because it describes a single-record fetch, though the generic tool name "detail" needs the description to carry that distinction.

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?

Explicitly states the precondition that collection and id must come from a prior search call, and explicitly forbids page URLs, titles, or slugs. It does not name a specific alternative sibling, but the search→detail workflow is made unambiguous.

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.