Skip to main content
Glama

Read a studio document

read_studio_document
Read-onlyIdempotent

Read a saved Film, Series or GenAds document and its exact native content revision. Page long text with offset and limit; season_id selects an explicit Series season. Read all source text before replacing a complete body.

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": {
      "document_id": "<document_id>",
      "workspace_id": "<workspace_id>"
    },
    "name": "read_studio_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
offsetNo
season_idNo
document_idYes
workspace_idYes
folders_offsetNo
expected_revisionNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so safety is covered. The description adds genuinely new behavioral context: content is returned at an exact native revision, results are paginated, and full text must be read before a body replacement. It still does not say what happens when expected_revision does not match, which is the main behavioral unknown for a revision-aware read.

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?

Three sentences, front-loaded with purpose and then usage rules, with no filler. Some phrasing is compressed to the point of opacity ('exact native content revision', 'replacing a complete body'), which costs a little clarity without adding length.

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?

An output schema exists, so return values need not be described, and the read-only annotations cover the safety profile. For a seven-parameter tool with zero schema descriptions, though, the definition leaves how to discover document_id, what expected_revision enforces, and what folders_offset pages over entirely unaddressed.

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 burden and it only explains three of seven parameters (offset, limit, season_id). The two most semantically loaded parameters, expected_revision and folders_offset, are left entirely unexplained, and document_id/workspace_id are only implied by 'saved ... document'.

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 gives a specific verb and resource ('Read a saved Film, Series or GenAds document') plus the scope of what is returned ('its exact native content revision'), which is far more precise than the bare title. It does not name a sibling it is not, so the agent must infer the boundary against read_studio_document_changes or native.read_document on its own.

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?

It states concrete usage conditions: page long text via offset/limit, use season_id when an explicit Series season is wanted, and read all source text before replacing a complete body. What is missing is any exclusion or pointer to alternatives, such as using list_studio_documents first to obtain document_id or read_studio_document_changes for diffs.

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