Skip to main content
Glama

sp_open_document

Read-only

Opens original FCS PDFs, Rosstandard/Gostinfo cards, or MegaNorm sources and saves immutable source bytes, returning snapshot metadata, revision links, table counts, and SHA-256 for verification.

Instructions

Open an original FCS PDF, a Rosstandard/Gostinfo card or a MegaNorm source. Saves immutable source bytes. Returns snapshot_id, edition metadata, revision links, table counts and SHA-256. latest_revision follows newest linked edition; it does not certify its effective date. Official catalogue cards are metadata_only. PDF pages link to the original. PDF extraction requires a text layer.

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": {
      "url": "<url>"
    },
    "name": "sp_open_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlYes
refreshNo
latest_revisionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/openWorldHint/destructiveHint=false, yet the description adds real behavior: immutable source bytes are persisted, the call returns snapshot_id, edition metadata, revision links, table counts and SHA-256, and it warns that latest_revision does not certify the effective date. Minor tension with readOnlyHint exists ('Saves immutable source bytes'), but this reads as caching rather than external mutation, and the gaps are mostly around the undocumented refresh parameter and auth/rate-limit behavior.

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 action and source types, followed by side effect, return fields, then caveats; every sentence carries information. The style is terse to the point of fragmentary ('PDF pages link to the original. PDF extraction requires a text layer.'), which slightly costs readability but wastes no words.

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 no output schema, the description compensates by enumerating returned fields (snapshot_id, edition metadata, revision links, table counts, SHA-256) and flags data-quality caveats for catalogue cards and PDFs. The remaining hole is the refresh parameter and any authentication/access expectations for an open-world fetch, which an agent would still have to guess.

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 description coverage is 0%, so the description carries the load: it usefully explains latest_revision's semantics (follows newest linked edition, does not certify effective date) and implicitly what url accepts (FCS PDF / Rosstandard card / MegaNorm source). However, it never mentions the refresh parameter or what re-opening the same URL does, leaving roughly a third of the parameters undocumented in both places.

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?

States a specific verb and resource set: 'Open an original FCS PDF, a Rosstandard/Gostinfo card or a MegaNorm source', plus the side effect 'Saves immutable source bytes', which distinguishes it from reader siblings such as sp_read_document or sp_document_contents by implying ingestion/snapshot creation. It stops short of naming any sibling or explicitly saying 'use this before reading', so it is clear but not fully differentiated.

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

Usage Guidelines3/5

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

Usage is only implied: the source enumeration and constraints ('PDF extraction requires a text layer', 'Official catalogue cards are metadata_only', 'latest_revision ... does not certify its effective date') tell the agent when the tool will or won't yield usable data. There is no explicit when-to-use statement, no prerequisites, and no routing to alternatives for already-opened or already-parsed sources.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.