Skip to main content
Glama
huiseo

Outline Wiki MCP Server

by huiseo

restore_document

Recover deleted documents from trash in Outline wiki by specifying the document ID to restore them to their original location.

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, 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 definition for the input of restore_document tool, requiring a documentId.
    export const restoreDocumentSchema = z.object({ documentId });
  • Registration of the 'restore_document' tool in the allTools array, providing name, description, and schema reference.
    createTool(
      'restore_document',
      'Restore a document from trash.',
      'restore_document'
    ),
  • Mapping of 'restore_document' tool name to its schema in the central toolSchemas object.
    restore_document: restoreDocumentSchema,
  • 'restore_document' is listed as a write operation tool in the WRITE_TOOLS set for access control checks.
    'restore_document',
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. While 'Restore' implies a mutation operation, it doesn't specify permissions required, whether the action is reversible, what happens if the document isn't in trash, or any rate limits. This leaves significant behavioral gaps for a mutation tool.

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 wasted words. It's appropriately sized for a simple tool and front-loads the essential information immediately.

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?

For a mutation tool with no annotations, no output schema, and minimal parameter documentation, the description is inadequate. It doesn't address what happens after restoration, error conditions, or how this differs from similar operations like unarchiving, leaving the agent with insufficient context for reliable use.

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 mentions 'a document' which implies the 'documentId' parameter, but with 0% schema description coverage, it doesn't explain what format the ID should be, where to find it, or provide any examples. Since there's only one parameter, the baseline is 4, but the lack of any parameter guidance beyond basic implication reduces this to 3.

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'), making the tool's purpose immediately understandable. However, it doesn't differentiate from sibling tools like 'unarchive_document' or 'move_document' which might have overlapping functionality, preventing a perfect 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 like 'unarchive_document' or 'move_document', nor does it mention prerequisites such as needing a document to be in trash first. It simply states what the tool does without contextual usage information.

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-smart-mcp'

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