Skip to main content
Glama
arimxyer

Documentation Manager

by arimxyer

docmgr_migrate

Migrate documentation to a new location or structure while preserving git history. Optionally rewrite internal links and regenerate table of contents; preview changes with dry run before execution.

Instructions

Migrate or restructure documentation while optionally preserving git history.

Use when: Moving docs to new location, changing documentation platform, or reorganizing documentation structure Result: Moves/restructures documentation files, optionally rewrites internal links, regenerates TOC, preserves git history Mode: State-modifying (moves files, modifies content)

Options:

  • preserve_history=true: Uses git mv to maintain file history

  • rewrite_links=true: Updates internal links to match new structure

  • regenerate_toc=true: Rebuilds table of contents

  • dry_run=true: Shows what would be done without making changes

Typical workflow: Set dry_run=true first to preview changes → review plan → run with dry_run=false to execute migration

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_pathYes
source_pathYes
target_pathNodocs
target_platformNo
preserve_historyNo
rewrite_linksNo
regenerate_tocNo
dry_runNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

Annotations already indicate readOnlyHint=false and destructiveHint=false. The description adds behavior about preserving git history, rewriting links, and regenerating TOC, but does not fully disclose potential risks like file deletion or revertibility. It adds moderate context beyond annotations but lacks comprehensive behavioral coverage for a migration tool.

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?

Description is well-structured with sections ('Use when', 'Result', 'Mode', 'Options'), making it scannable. It is slightly verbose but each sentence adds value. No wasted words, though could be more compact.

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

Completeness3/5

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

Given complexity (8 parameters, 0% schema coverage) and existence of output schema, the description covers workflow and boolean options but omits details on target_platform, target_path defaults, and error handling. Incomplete for a migration tool, leaving gaps for the agent.

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 0%, so description must compensate. It explains the boolean options (preserve_history, rewrite_links, regenerate_toc, dry_run) with their effects, but does not explain required parameters like project_path and source_path, nor optional target_platform. The explanation is partial, meriting a mid-range score.

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?

The description clearly states the tool migrates or restructures documentation with specific verb and resource. It distinguishes from sibling tools by stating 'Use when: Moving docs to new location...' which differentiates it from other doc management tasks.

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?

Explicit 'Use when:' section provides clear context for when to employ this tool. It also includes a typical workflow with dry_run recommendation, guiding the agent on proper usage and previewing before execution.

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/arimxyer/doc-manager-mcp'

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