Skip to main content
Glama

Read applied document changes

read_studio_document_changes
Read-onlyIdempotent

Read applied changes and this viewer's read state without acknowledging anything. Use exact returned change IDs for mark-read or undo. Page with offset and expected_revision; a changed feed must be read again.

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

Input Schema

NameRequiredDescriptionDefault
limitNo
offsetNo
season_idNo
document_idYes
source_pathNoExact change field path
unread_onlyNo
workspace_idYes
expected_revisionNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/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 safety profile is covered; the description adds genuinely new behavior — reads do not advance or acknowledge read state, and optimistic concurrency via expected_revision means a changed feed must be re-read. Rate limits and page-size caps are left unstated.

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?

Three short sentences, front-loaded with the core read scope, then follow-up usage, then paging constraint. No filler or redundant restatement of the name.

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?

Output schema exists, so return values needn't be explained, and the acknowledging/paging semantics are covered. With eight parameters and near-zero schema descriptions, though, several filter parameters remain opaque, leaving the definition only partially complete for the tool's complexity.

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 only 13% (only source_path is annotated), so the description has to compensate. It clarifies the roles of offset and expected_revision, but leaves limit, unread_only, season_id, document_id and workspace_id entirely to the bare schema.

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 and resource (read applied document changes plus this viewer's read state) and immediately differentiates itself from the acknowledgement path with 'without acknowledging anything', which separates it from mark_studio_document_changes_read and undo_studio_document_changes.

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?

Gives forward guidance on what to do with the result (use exact returned change IDs for mark-read or undo) and on paging via offset and expected_revision. It does not explicitly say when to prefer read_studio_document or which sibling covers unfiltered reads, so it falls just short of full alternative routing.

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