Skip to main content
Glama

Regulatory Document

get_regulatory_document
Read-only

One regulatory document by id. Take the id from a search or change result, never guess one. include body for the extracted text (cheaper than the file), diff for what changed between the two most recent captures, versions for every capture. Check fileAvailability before asking for the file. 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"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesDocument id from a search or change result.
includeNoExtra parts to return. Omit for metadata only.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed12 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"
      -  ]
      -}
    • 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"
    • addedInput schema / properties / include / anyOf
      Added value: +[
      +  {
      +    "items": {
      +      "enum": [
      +        "body",
      +        "versions",
      +        "diff"
      +      ],
      +      "type": "string"
      +    },
      +    "type": "array"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • addedInput schema / properties / include / default
      Added value: +null
    • changedInput schema / properties / include / description
      Previous value: -"`body` for the extracted text, `versions` for every capture we hold, `diff` for the change between the two most recent captures. Repeat the key to combine: `?include=body&include=versions`. `diff` works on its own."New value: +"Extra parts to return. Omit for metadata only."
    • removedInput schema / properties / include / items
      Removed value: -{
      -  "enum": [
      -    "body",
      -    "versions",
      -    "diff"
      -  ],
      -  "type": "string"
      -}
    • removedInput schema / properties / include / type
      Removed value: -"array"
  2. 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."
  3. Added

TDQS

A4.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, destructiveHint=false, and openWorldHint=false, so safety is covered structurally. The description adds non-obvious behavior the annotations cannot: a cost of 1 credit, the body-vs-file cost tradeoff, and the rule that ids must come from a prior result. Return-shape detail is omitted, but an output schema exists to carry 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?

Telegraphic and front-loaded: resource first, then id provenance, then include semantics, then cost. Every clause carries operational information; nothing is repeated from the schema or annotations.

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 two-parameter read tool with full schema coverage, complete annotations, and an output schema, the description covers the remaining gaps an agent needs: where ids come from, what each include option returns, the pre-check for file retrieval, and the credit cost.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline would be 3, but the description meaningfully enriches the include enum: "body" is the extracted text and cheaper than the file, "diff" is the change between the two most recent captures, "versions" is every capture. That explains semantics the bare enum values do not convey.

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?

"One regulatory document by id" states a specific verb, resource, and scope, and the include-options sentence immediately distinguishes it from the file sibling ("cheaper than the file"). An agent can tell what it retrieves and how it differs from search/list/file tools 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 Guidelines5/5

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

Gives explicit provenance guidance ("Take the id from a search or change result, never guess one"), a precondition for the file path ("Check fileAvailability before asking for the file"), and a selection rule for the expensive option (body is cheaper than the file). When-to-use, when-not-to-guess, and the alternative route are all present.

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.