Skip to main content
Glama

Regulatory Document File

get_regulatory_document_file
Read-only

The archived original of one document, returned as a file, not text; for text use get_regulatory_document with include body. Check fileAvailability first. content_not_archived means we never held the bytes: do not retry. archive_unavailable means our archive failed: retry later. Neither means the regulator did not publish it. Cost: 1 credit.

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": {
      "id": "<id>"
    },
    "name": "get_regulatory_document_file"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesDocument id from a search or change result.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changed
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / Idempotency-Key
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "maxLength": 255,
      -      "minLength": 16,
      -      "pattern": "^[\\x21-\\x7e]+$",
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "description": "Optional, 16 to 255 visible ASCII characters (a UUIDv4 is ideal). A retry with the same key and request replays the original 2xx for 24 hours without charging again; the same key with a different request is rejected.",
      -  "examples": [
      -    "3f9c2a1e-7b44-4d0a-9c1e-5a6b7c8d9e0f"
      -  ]
      -}
    • removedInput schema / properties / as
      Removed value: -{
      -  "description": "Preferred filename, without extension. Slugified, and our own extension is appended.",
      -  "maxLength": 200,
      -  "minLength": 1,
      -  "type": "string"
      -}
    • changedInput schema / properties / id / description
      Previous value: -"The `documentId`, as `GET /reg/documents` reports it."New value: +"Document id from a search or change result."
    • removedInput schema / properties / id / examples
      Removed value: -[
      -  "802299"
      -]
    • addedInput schema / properties / id / minimum
      Added value: +1
    • removedInput schema / properties / id / pattern
      Removed value: -"^[0-9]{1,18}$"
    • changedInput schema / properties / id / type
      Previous value: -"string"New value: +"integer"
    • changedOutput schema / (root)
      Previous value: -{
      -  "additionalProperties": true,
      -  "properties": {
      -    "result": {}
      -  },
      -  "type": "object",
      -  "x-fastmcp-wrap-result": true
      -}New value: +null
  2. Changed1 schema field changed
    • addedOutput schema / properties
      Added value: +{
      +  "result": {}
      +}
  3. Changed1 schema field changed
    • changedInput schema / properties / Idempotency-Key / description
      Previous value: -"Optional. 16 to 255 visible ASCII characters (a UUIDv4 works). Repeating the same request with the same key replays the original 2xx response for 24 hours without charging again. The same key on a different request is rejected. With the account's `cacheQueryDerivedData` retention setting off, no body is stored and a retry answers 409 `idempotency_replay_unavailable`, still without a second charge."New value: +"Optional, 16 to 255 visible ASCII characters (a UUIDv4 is ideal). A retry with the same key and request replays the original 2xx for 24 hours without charging again; the same key with a different request is rejected."
  4. Added

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already establish read-only, non-destructive, closed-world behavior, yet the description adds substantial context beyond them: the return medium is a file rather than text, the required pre-check, a per-call cost of 1 credit, and precise retry semantics for two distinct failure states. It also clarifies the negative inference trap (neither error means the regulator never published it).

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?

Extremely dense but front-loaded: identity and file-vs-text distinction come first, then the pre-check, then error handling, then cost. Every clause carries operational information and none is redundant.

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?

For a one-parameter retrieval tool with no output schema, the description covers the thing an agent most needs and cannot infer: that the result is binary file content, plus gating, cost, and failure recovery. Nothing required to invoke or recover correctly is missing.

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?

With 100% schema coverage and a single required id parameter already documented as coming from a search or change result, the description adds little parameter-specific syntax or format detail. Baseline 3 applies since the schema carries the parameter burden.

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 (returns the archived original of one document) and immediately bounds the scope with "not text", naming the sibling get_regulatory_document for the text case. An agent can distinguish this from the text-retrieval sibling without opening either schema.

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

Usage Guidelines5/5

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

Gives an explicit prerequisite ("Check fileAvailability first") and routes the agent to the alternative tool when text is wanted. It also provides conditional guidance for each outcome: do not retry on content_not_archived, retry later on archive_unavailable.

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.