Skip to main content
Glama
bruhsb
by bruhsb

paperclip_get_document_revisions

Read-only

Retrieve the full revision history of an issue document to audit changes or find a revisionId for document restoration.

Instructions

Get the full revision history for an issue document.

Args:

  • issueId: string — Issue ID or identifier (example: "PAP-42")

  • key: string — Document key (example: "plan")

Returns: Array of revision objects: revisionId, authorId, createdAt, changeSummary.

Examples:

  • Use when: auditing who changed a document or finding a revisionId to pass to paperclip_upsert_document

  • Don't use when: you need the current document body — use paperclip_get_document instead

Error Handling:

  • 401: authentication failed → check PAPERCLIP_API_KEY

  • 404: document or issue not found → verify both issueId and key with paperclip_list_documents

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
issueIdYesIssue ID or identifier (e.g. PAP-22)
keyYesDocument key (e.g. `plan`)
response_formatYesOutput format: 'markdown' (default, human-readable) or 'json' (structured)markdown
Behavior4/5

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

Annotations already indicate readOnlyHint=true; description adds return structure details (fields) and behavior, no contradictions.

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?

Well-organized with sections: main sentence, Args, Returns, Examples, Error Handling. Each sentence is valuable and front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers purpose, parameters, return values, usage guidance, error handling, and distinguishes from siblings. No gaps given annotations and schema coverage.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, but description adds examples for issueId and key, and ties parameters to error handling scenarios.

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?

Clearly states 'Get the full revision history for an issue document.' Distinguishes from siblings like paperclip_get_document (current body) and paperclip_list_documents.

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?

Explicitly provides 'Use when' and 'Don't use when' with specific sibling references, plus error handling guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/bruhsb/paperclip-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server