Skip to main content
Glama

Document diff

document_diff
Read-onlyIdempotent

Compare two versions of a document line by line. Output is bounded and flags truncation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesDocument ID.
limitNoMaximum lines to return, 1 to 200.
to_versionYesNewer version.
from_versionYesOlder version.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/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 beyond that: output is bounded and truncation is signaled, which tells the agent how to interpret the result size. It stops short of stating the max/limit behavior explicitly.

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?

Two short sentences, zero filler, and the core purpose is front-loaded before the output note. Every clause earns its place.

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?

For a 4-parameter, no-output-schema tool, the schema fully documents inputs and the description pre-empts the main output concern (bounded size with a truncation flag). It is nearly complete, missing only a note on return shape or how truncation is surfaced.

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 100%, so the schema already documents id, from_version, to_version, and limit with ranges and defaults. The description adds no parameter-level detail; baseline 3 applies since the schema does the heavy lifting.

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 (compare) and resource (two versions of a document) plus the comparison method (line by line). It clearly reads as a diff operation, but it never names or contrasts with any sibling such as read or write_document, so it does not earn the sibling-differentiation credit of 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 Guidelines2/5

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

There is no explicit guidance on when to use this versus alternatives — no prerequisites, no statement about needing both versions to exist, no routing to related read tools. The use case is only weakly implied by the name and first sentence.

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.