Skip to main content
Glama

Read version status

get_version
Read-onlyIdempotent

Read a version’s status, page count, validation or review issues, and the files this version contains (artifacts: each path, type, size, whether it is the entry file and whether readers can download it). After finalize_upload returns converting, poll no faster than every 15–30 seconds. Show the preview to the user once ready. To read the rendered body of a file listed here, use read_version.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
version_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, so the burden is lower. The description nonetheless adds real behavioral value: the polling cadence after conversion, the fact that content may be in a 'converting' state, and how artifacts are shaped (entry file, downloadability). It does not describe pagination or error behavior, so not a 5.

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-loads the return contents, then operational guidance, then the sibling route-out — a sensible order. The parenthetical artifact field list is dense but each item earns its place; overall a touch long but no wasted sentences.

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 does the work of explaining the return shape (status, pages, issues, artifact fields), which is the key content an agent needs. The only real gap is the version_id parameter, which is omitted entirely from an otherwise thorough definition.

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 0% and the description never explains the version_id parameter's format or where to obtain it. It implies the tool operates on a single version, but with one undocumented required parameter and no field-level guidance, this is minimum-viable rather than compensating for the coverage gap.

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 (read) plus resource (a version) and enumerates exactly what it returns: status, page count, validation/review issues, and contained artifacts with their fields. It is clearly distinguishable from siblings like read_version (rendered body), preview_version, and list_versions.

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 trigger (after finalize_upload returns 'converting'), an explicit constraint (poll no faster than every 15–30 seconds), a follow-up action (show the preview once ready), and a named alternative for a different need (read_version for rendered body).

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