Skip to main content
Glama

host.docs.purge

Drop stored versions of a document older than older_than_versions versions back from its current one -- get {version: } then reads not found.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoDocument id to purge old versions of; use name instead if you don't have it.
nameNoDocument name to purge old versions of; use id instead if you have it.
tenant_keyNoThe key `signup` returned. Required only when this connection carries no Authorization: Bearer header -- when both are present, the header wins.
older_than_versionsYesHow many versions back from the current one to keep.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4/5.0
Behavior4/5

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

With no annotations, the description carries the burden of behavioral disclosure. It goes beyond the basic action by exposing an important postcondition: after purging, reading a dropped version returns not found. It does not mention irreversibility, auth requirements, or rate limits, but the core destructive side effect is clearly conveyed.

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?

The description is a single sentence with no filler, and the main action and condition are front-loaded. The postcondition is expressed compactly using the {version: ...} response notation.

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 destructive version-pruning tool with no annotations and no output schema, the description adequately conveys the action, retention condition, and consequence of reading dropped versions. It could be more complete by noting what the purge call itself returns or explicitly warning that the operation is irreversible, but the essential behavior is clear enough for correct invocation.

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 all four parameters. The description references older_than_versions but adds no new parameter-level detail such as accepted value ranges, defaults, or edge-case behavior.

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?

The description states a specific verb ('Drop') and resource ('stored versions of a document') with a retention condition based on older_than_versions. It is clearly distinct from sibling docs.delete, which removes a whole document, and from docs.get/list/put/status.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

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

The description implies when to use this tool: when you want to prune old versions of a document while keeping a certain number of recent ones. However, it does not explicitly contrast it with docs.delete or describe scenarios where this tool should not be used.

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