Skip to main content
Glama
huiseo
by huiseo

restore_document

Recover deleted documents from the Outline wiki trash to restore access and content.

Instructions

Restore a document from trash.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentIdYes

Implementation Reference

  • The main handler function for the 'restore_document' tool. It performs an access check and calls the Outline API to restore the document from trash by ID, returning formatted result.
    async restore_document(args: RestoreDocumentInput) {
      checkAccess(config, 'restore_document');
      const { data } = await apiCall(() =>
        apiClient.post<OutlineDocument>('/documents.restore', { id: args.documentId })
      );
      return docResult(data, MESSAGES.DOCUMENT_RESTORED);
    },
  • Zod schema defining the input for restore_document: requires a documentId string.
    export const restoreDocumentSchema = z.object({ documentId });
  • Registration of the 'restore_document' tool definition, including name, description, and reference to its Zod schema for MCP tool list.
    createTool(
      'restore_document',
      'Restore a document from trash.',
      'restore_document'
    ),
  • Handler registration where document handlers (including restore_document) are spread into the complete ToolHandlers object for the MCP server.
    export function createAllHandlers(ctx: AppContext): ToolHandlers {
      return {
        ...createSearchHandlers(ctx),
        ...createDocumentHandlers(ctx),
        ...createCollectionHandlers(ctx),
        ...createCommentHandlers(ctx),
        ...createBatchHandlers(ctx),
        ...createSmartHandlers(ctx),
      } as ToolHandlers;
Behavior2/5

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

No annotations are provided, so the description carries full burden. It implies a mutation operation ('restore') but doesn't disclose behavioral traits like required permissions, whether the action is reversible, side effects (e.g., moving document out of trash), or error conditions. This is inadequate for a mutation tool with zero annotation coverage.

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, efficient sentence with zero waste. It's appropriately sized and front-loaded, directly stating the tool's purpose without unnecessary elaboration.

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

Completeness2/5

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

Given this is a mutation tool with no annotations, no output schema, and minimal parameter documentation, the description is incomplete. It lacks details on behavior, outcomes, or context needed for safe and effective use, making it inadequate 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?

The description doesn't add any parameter information beyond the input schema, which has 0% description coverage for the single parameter 'documentId'. However, with only one parameter and a straightforward tool, the baseline is 3 as the schema minimally defines the requirement, though the description doesn't compensate for the coverage gap.

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?

The description clearly states the action ('restore') and target resource ('a document from trash'), which is specific and unambiguous. However, it doesn't differentiate from sibling tools like 'unarchive_document' or 'move_document' that might also involve document state changes, so it doesn't reach the highest score.

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?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., document must be in trash), exclusions, or compare to related tools like 'unarchive_document' or 'move_document' for different scenarios.

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/huiseo/outline-wiki-mcp'

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