Skip to main content
Glama

get_document_by_id

Retrieve a specific document from Vysion by its unique ID. Use when you already have a document ID from a previous search.

Responses:

200: Successful Response (Success Response) Content-Type: application/json

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_document_by_id"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesDocument ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the disclosure burden; "Retrieve" implies a non-mutating read, and the Responses block confirms a 200 success with JSON content. It says nothing about behavior for an unknown or deleted ID, authentication requirements, or rate limits, which are the traits an agent most needs for a lookup-by-ID tool.

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?

Two tight sentences put the purpose first and the usage condition second, with no redundant phrasing. The appended "### Responses" section restates the obvious 200/JSON boilerplate and contributes little beyond structure.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter lookup tool this is close to sufficient, but with no output schema the description should hint at what a returned document contains (fields, size, truncation) rather than just "Successful Response". The core selection and invocation information is present, so the gap is moderate rather than severe.

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?

The single parameter is fully documented in the schema as "Document ID", and the description adds real meaning by specifying it is a unique ID and that it normally originates from a prior search result. Format or example values are still absent, so it is not a 5.

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?

The description names a specific verb and resource ("Retrieve a specific document from Vysion") and identifies the keying mechanism ("by its unique ID"), which separates it from ID-less siblings like get_document_by_url and search_documents. It does not explicitly name which sibling to use instead, which keeps it from a 5.

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?

"Use when you already have a document ID from a previous search" gives a clear triggering condition and implicitly routes the agent to a search tool first when no ID is in hand. No explicit exclusion is stated (e.g., use get_document_html_by_id for HTML content), so it stops short of full when/when-not guidance.

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