Skip to main content
Glama

Archive a page

wiki_archive_page
Idempotent

Archives a wiki page without deleting it by setting its lifecycle to archived and recording a reason; preserves existing links and supports preview before confirmation.

Instructions

Retire one page under wiki/ without deleting it: set lifecycle: archived, archived_reason and last_updated in its frontmatter. The file stays where it is, so links keep working, and wiki_update_frontmatter with lifecycle: reviewed restores it. Nothing is ever deleted. Refused for system pages and pages with origin: human. Without confirm=true it writes nothing and returns a preview. Ask the user before confirm=true. Returns JSON {path, previous_lifecycle, written}. Use wiki_lifecycle with state 'archived' to list archived pages.

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": {
      "path": "<path>",
      "reason": "<reason>"
    },
    "name": "wiki_archive_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesExisting page path relative to the repo root, under wiki/.
reasonYesWhy the page is retired, at most 200 characters, single line. Stored as archived_reason.
confirmNoRequired to actually write. Without confirm=true the call returns a preview and writes nothing.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare non-readonly, non-destructive, idempotent, but the description adds substantial context beyond them: the file is not moved so links keep working, nothing is ever deleted, writes are refused for system pages and origin: human pages, and without confirm=true the call writes nothing and returns a preview. It even discloses the return payload shape, which no output schema provides.

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?

Front-loaded with the core action and mechanism, then alternatives, safety gates, and return shape in a logical order. Slightly redundant in restating non-deletion twice ('without deleting it' and 'Nothing is ever deleted'), but nearly every sentence carries actionable information.

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?

With no output schema, the description supplies the return shape {path, previous_lifecycle, written}. Combined with refusal conditions, dry-run semantics, and restore path, an agent has everything needed to call this correctly and safely.

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 coverage is 100%, so the schema already documents all three parameters including the confirm preview behavior and archived_reason storage. The description reinforces the confirm gate but adds no syntax or format detail beyond what the schema provides; baseline 3 is appropriate.

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 and resource ('Retire one page under wiki/ without deleting it') plus the concrete mechanism (set lifecycle: archived, archived_reason, last_updated in frontmatter). It also distinguishes itself from siblings by naming wiki_update_frontmatter for restore and wiki_lifecycle for listing archived pages.

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 routes the agent: use wiki_update_frontmatter with lifecycle: reviewed to restore, and wiki_lifecycle with state 'archived' to list. It also states the operational precondition ('Ask the user before confirm=true') and the exclusion cases (system pages, origin: human), which is unusually complete guidance.

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