Skip to main content
Glama

Restore document

restore-document
DestructiveIdempotent

Restores an archived document, making it show up in the account's default document lists again.

Use this tool when:

  • An archived document should become actively used again

  • The user asks to restore or unarchive a document

The document must currently be archived. Archived documents do not appear in list-documents results by default: pass filter_archived_state: "archived" to the list-documents tool to find them.

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_uuid": "<document_uuid>"
    },
    "name": "restore-document"
  }
}

Input Schema

NameRequiredDescriptionDefault
document_uuidYesUUID of the archived document to restore. If you don't already have the document's UUID, use the list-documents tool with filter_archived_state set to "archived" to find it.

Output Schema

NameRequiredDescriptionDefault
urlNoURL to open the document in fynk
nameNoName of the document
uuidNoUnique identifier for the document. Do not show to the user unless they ask for it
stageNoWhat stage the document is in currently
created_atNoWhen the document was created.
updated_atNoWhen the document was last updated.
archived_atNoWhen the document was archived. Absent when the document is not archived.
_entity_typeNoOnly relevant for tooling. Do not show to the user
document_typeNoIf present, indicates what kind of document this is. Absent when the document has no type assigned

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly=false, destructive=true, idempotent=true, so the mutation/safety profile is covered. The description adds useful context beyond that: the document must be in the archived state and the resulting effect is visibility in default lists. It doesn't say what happens on a non-archived input, which is the one remaining gap.

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?

The one-line purpose is front-loaded, followed by a tight conditional-usage list and the prerequisite. The filter_archived_state tip appears twice (prose and schema), a minor redundancy, but no sentence is wasted.

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 single-parameter mutation with an existing output schema, the description covers purpose, trigger conditions, and the archived-state precondition. Return-value explanation is unnecessary given the output schema, so only the error behavior for non-archived documents is left implicit.

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% and the single parameter is fully documented in-schema. The description reinforces how to obtain the document_uuid (list-documents with filter_archived_state: "archived"), which is a genuine discovery aid even though it duplicates the schema text.

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 (restore) and resource (archived document), plus the observable effect: it reappears in the account's default document lists. This is distinguishable from the archive-document sibling without opening either schema.

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?

Two explicit 'use this tool when' bullets cover the trigger cases (unarchive/reactivate a document). It also states the precondition that the document must currently be archived and routes the agent to list-documents with filter_archived_state to locate candidates. It stops short of naming archive-document as the inverse operation, but the context is clear.

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