Skip to main content
Glama
arimxyer

Documentation Manager

by arimxyer

Documentation Manager

PyPI version Python Version License

Comprehensive documentation lifecycle management powered by an MCP (Model Context Protocol) server. Automates documentation creation, maintenance, quality assessment, and synchronization for software projects.

Features

  • Automatic change detection - Track code changes and affected documentation

  • Link validation - Find broken links and missing assets

  • Quality assessment - Evaluate docs against 7 quality criteria

  • Symbol tracking - TreeSitter-based code symbol extraction (Python, Go, TypeScript, Rust)

  • Dependency mapping - Automatic code-to-docs relationships

  • Platform detection - Auto-detect MkDocs, Sphinx, Hugo, Docusaurus, etc.

  • Documentation migration - Restructure docs with git history preservation

Related MCP server: Spec Workflow MCP

Installation

The doc-management plugin provides an interactive documentation workflow with specialized agents and quick commands, powered by the doc-manager MCP server.

Install:

# Add the marketplace
/plugin marketplace add arimxyer/doc-manager-mcp

# Install the plugin (automatically configures MCP server)
/plugin install doc-manager@doc-manager-suite

What you get:

  • @doc-expert - Documentation expert who analyzes state and directs next steps

  • @doc-writer - Content specialist who creates/updates docs

  • /doc-status, /doc-sync, /doc-quality - Quick commands for common workflows

Example workflow:

You: "Set up documentation management"
Claude: [Invokes @doc-expert to detect platform and initialize]

You: "/doc-sync"
Claude: [Detects changes, updates docs via @doc-writer, validates, updates baselines]

You: "Check quality before release"
Claude: [Runs quality assessment and shows actionable findings]

See the Claude Code Plugin guide for details.


Standalone MCP Server

For using the MCP server without the plugin.

Claude Code:

claude mcp add doc-manager --scope project -- uvx doc-manager-mcp

Claude Desktop:

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "doc-manager": {
      "command": "uvx",
      "args": ["doc-manager-mcp"]
    }
  }
}

Restart your client. Your AI assistant can then use the 8 doc-manager tools directly.

Other MCP clients:

See Installation Guide for local development setup and alternative installation methods.

Quick Start

With Claude Code plugin:

You: "Set up documentation management for this project"
You: "/doc-sync"

With any MCP client:

Ask your AI assistant to initialize documentation management, check sync status, or validate quality. The AI will use the appropriate tools (docmgr_init, docmgr_sync, etc.) automatically.

See Quick Start Guide for complete workflows and examples.

MCP Server Tools

The doc-manager MCP server provides 8 tools for documentation management:

  • docmgr_init - Initialize doc-manager for a project (modes: existing, bootstrap)

  • docmgr_detect_changes - Detect code/doc changes (read-only, never writes baselines)

  • docmgr_detect_platform - Auto-detect documentation platform (MkDocs, Sphinx, Hugo, etc.)

  • docmgr_validate_docs - Check for broken links, missing assets, invalid code snippets

  • docmgr_assess_quality - Evaluate documentation against 7 quality criteria

  • docmgr_update_baseline - Update all baselines atomically (repo, symbols, dependencies)

  • docmgr_sync - Orchestrate change detection + validation + quality + baseline updates

  • docmgr_migrate - Restructure/migrate documentation with git history preservation

See Tools Reference for complete API documentation.

Architecture

Baseline System

Doc-manager maintains 3 baseline files in .doc-manager/memory/:

  1. repo-baseline.json - File checksums and metadata

  2. symbol-baseline.json - TreeSitter code symbols (functions, classes, config fields)

  3. dependencies.json - Code-to-docs dependency mappings

Workflow:

1. docmgr_init              → Create initial baselines
2. (make code changes)
3. docmgr_detect_changes    → Detect changes (read-only)
4. (update documentation)
5. docmgr_update_baseline   → Refresh baselines

Or use docmgr_sync mode="resync" to combine steps 3-5.

Configuration

Example .doc-manager.yml:

platform: mkdocs
use_gitignore: true
exclude:
  - "tests/**"
sources:
  - "src/**/*.py"
docs_path: docs
metadata:
  language: Python
  created: '2025-01-19T20:00:00'
  version: '2.0.0'

See Configuration Reference for all options.

Development

Running tests

# All tests
uv run pytest

# Unit tests only
uv run pytest tests/unit/

# With coverage
uv run pytest --cov=doc_manager_mcp

Running the server locally

# Install in development mode
pip install -e .

# Run server (stdio transport)
doc-manager-mcp

# Or with uv
uvx --from . doc-manager-mcp

Linting

# Ruff (linter + formatter)
uv run ruff check .
uv run ruff format .

# Pyright (type checker)
uv run pyright

Adding new tools

  1. Create implementation in doc_manager_mcp/tools/

  2. Define Pydantic model in doc_manager_mcp/models.py

  3. Register tool in doc_manager_mcp/server.py with @mcp.tool

  4. Add tests in tests/unit/ and tests/integration/

  5. Update documentation

Documentation

License

MIT License

Available Tools

8 tools
docmgr_assess_qualityA
Read-onlyIdempotent

Assess documentation quality against 7 criteria with scores and actionable findings.

Use when: Auditing documentation health, before major releases, or tracking quality improvements over time Result: Returns quality scores (good/fair/poor) for each criterion plus specific findings, issues, and metrics Mode: Read-only (analyzes documentation only)

7 Quality criteria evaluated:

  • Relevance: Addresses current user needs (not outdated)

  • Accuracy: Reflects actual codebase state

  • Purposefulness: Clear goals and target audience

  • Uniqueness: No redundant or conflicting information

  • Consistency: Aligned terminology, formatting, style

  • Clarity: Precise language and navigation

  • Structure: Logical organization and hierarchy

Typical workflow: Run periodically to track quality trends, use findings to prioritize documentation improvements

ParametersJSON Schema
NameRequiredDescriptionDefault
project_pathYes
docs_pathNo
criteriaNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4/5.0
Behavior4/5

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

The description adds value beyond annotations by clarifying the read-only nature ('Mode: Read-only') and detailing the return of quality scores and findings. Annotations already indicate readOnlyHint=true and idempotentHint=true, and the description reinforces these without contradiction.

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 description is well-structured with sections for purpose, usage, result, mode, criteria list, and workflow. It is comprehensive but not excessively verbose. Minor redundancy exists (e.g., result and typical workflow), but overall it is efficient.

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?

Given the presence of an output schema, the description appropriately focuses on behavior and usage. It covers the tool's purpose, criteria, read-only mode, and typical workflow. Missing parameter explanations reduce completeness, but the overall context is sufficient for most agents.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description should compensate by explaining each parameter. While it lists the seven quality criteria assessed, it does not clarify that the 'criteria' parameter allows selecting which ones to evaluate. The 'project_path' and 'docs_path' parameters are not explained in the description, relying solely on their schema names.

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 assesses documentation quality against 7 specific criteria, with scores and actionable findings. It distinguishes itself from sibling tools like docmgr_validate_docs by focusing on quality assessment rather than validation or detection.

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?

The description explicitly provides usage contexts: auditing documentation health, before major releases, and tracking improvements. It also suggests a typical workflow. However, it does not explicitly state when not to use the tool or mention alternative tools for other scenarios.

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

docmgr_detect_changesA
Read-onlyIdempotent

Detect code changes without modifying baselines (pure read-only).

Use when: Checking if documentation is out of sync after code changes Result: Lists changed files (categorized as code/docs/assets/etc.), affected documentation, and optional semantic changes Mode: Read-only (never modifies any files)

Modes:

  • mode="checksum": Compare current file checksums against repo-baseline.json

  • mode="git_diff": Compare current files against a specific git commit

Set include_semantic=true to detect symbol-level changes (functions/classes added/modified/deleted).

Typical workflow: Run after code changes to identify which docs may need updates, before deciding whether to update documentation or baselines

ParametersJSON Schema
NameRequiredDescriptionDefault
project_pathYes
since_commitNo
modeNochecksum
include_semanticNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already indicate read-only, non-destructive, and idempotent behavior. The description reinforces this and adds context about modes (checksum vs git_diff) and results (categorized changed files), providing extra value beyond annotations.

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 well-structured with sections for purpose, usage, result, modes, and workflow. Every sentence adds value without repetition, making it efficient and easy to parse.

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?

Given the presence of an output schema and comprehensive annotations, the description covers all necessary aspects: purpose, usage, behavior, parameters, and workflow. An agent has enough information to select and invoke the tool correctly.

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?

The input schema has 0% coverage, but the description explains the mode and include_semantic parameters, and implies since_commit's role in git_diff. It does not elaborate on project_path, but the overall parameter guidance is sufficient for correct usage.

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 detects code changes without modifying baselines, specifies it is pure read-only, and distinguishes it from sibling tools like docmgr_update_baseline by emphasizing detection over modification.

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?

The description provides explicit use cases ('when checking if documentation is out of sync after code changes') and a typical workflow, guiding the agent on when to invoke. However, it does not explicitly list alternatives or when not to use.

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

docmgr_detect_platformA
Read-onlyIdempotent

Auto-detect documentation platform (MkDocs, Sphinx, Hugo, etc.) or recommend one.

Use when: Setting up doc-manager for first time and unsure which platform is in use Result: Returns detected platform or recommendations based on project language and structure Mode: Read-only (analyzes project files only)

Detects by checking for platform-specific config files (mkdocs.yml, conf.py, config.toml, docusaurus.config.js).

Typical workflow: Run before docmgr_init to determine correct platform value for configuration

ParametersJSON Schema
NameRequiredDescriptionDefault
project_pathYes

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false. The description reinforces this with 'Mode: Read-only' and adds behavioral context (checks config files, returns recommendations). It goes beyond annotations by explaining the detection process.

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?

Description is brief (3 short paragraphs), front-loaded with purpose, then usage, result, mode, detection details, and workflow. Every sentence adds value without redundancy.

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 simple detection tool with one parameter and an output schema, the description covers purpose, usage, mode, detection mechanism, and typical workflow. Minor omission: no mention of error handling if no platform detected, but overall complete.

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 description coverage is 0%—the 'project_path' parameter has no description. The description implies its purpose (project root where config files reside) through context like 'checks for platform-specific config files', but does not explicitly define the parameter or its expected format. Partial compensation.

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 auto-detects documentation platforms (MkDocs, Sphinx, Hugo, etc.) or recommends one. It specifies the detection method (checking config files), making it distinct from sibling tools like docmgr_init or docmgr_validate_docs.

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?

Provides explicit 'Use when' context (first-time setup, unsure platform) and a 'Typical workflow' (run before docmgr_init). This helps agents decide when to invoke it, though it does not explicitly list situations to avoid.

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

docmgr_initA
Idempotent

Initialize doc-manager for a project (existing docs or create new).

Use when: Setting up doc-manager for the first time in a project Result: Creates .doc-manager.yml, baselines (repo, symbols, dependencies), and optionally bootstraps documentation structure Mode: State-modifying (creates files and directories)

Modes:

  • mode="existing": For projects with existing documentation - creates config and baselines only

  • mode="bootstrap": For new projects - creates documentation structure from templates plus config and baselines

Typical workflow: Run once at project setup, before any other doc-manager tools

ParametersJSON Schema
NameRequiredDescriptionDefault
project_pathYes
modeNoexisting
platformNo
exclude_patternsNo
docs_pathNo
sourcesNo
use_gitignoreNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.8/5.0
Behavior5/5

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

The description states 'State-modifying (creates files and directories)' and lists specific outputs (config, baselines, optionally documentation structure). This adds significant context beyond annotations, which only provide idempotentHint=true. No contradiction with annotations.

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 description is relatively concise and uses a clear structure with sections for 'Use when', 'Result', 'Mode', and 'Typical workflow'. It packs useful information without being verbose, though the parameter section is missing.

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?

Despite having a output schema (not shown), the description lacks critical details about parameters and return values. For a tool with 7 parameters and state-modifying behavior, the description is incomplete, leaving the agent to guess about most inputs and outputs.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With schema description coverage at 0%, the description does not explain any of the 7 parameters except for 'mode' by referencing 'existing' and 'bootstrap' in the Modes section. Other parameters like project_path, platform, exclude_patterns, docs_path, sources, and use_gitignore are entirely undocumented. This is a critical gap.

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 initializes doc-manager for a project, with two modes for existing or new docs. This verb+resource combination is specific and distinguishes it from sibling tools like docmgr_assess_quality and docmgr_detect_changes.

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?

The description explicitly says 'Use when: Setting up doc-manager for the first time in a project' and 'Typical workflow: Run once at project setup, before any other doc-manager tools.' It provides clear context but does not explicitly state when not to use it or list alternatives.

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

docmgr_migrateA

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

ParametersJSON Schema
NameRequiredDescriptionDefault
project_pathYes
source_pathYes
target_pathNodocs
target_platformNo
preserve_historyNo
rewrite_linksNo
regenerate_tocNo
dry_runNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4/5.0
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.

docmgr_syncA
Idempotent

Orchestrate complete documentation sync: detect changes, validate, assess quality, optionally update baselines.

Use when: After code changes to get complete documentation health report, or after doc updates to reset baselines Result: Comprehensive sync report with changed files, affected docs, validation issues, quality scores, and baseline status Mode: Depends on mode parameter - "check" is read-only, "resync" modifies baselines

Modes:

  • mode="check": Read-only analysis - detects changes, validates docs, assesses quality (no baseline updates)

  • mode="resync": Full sync - runs all checks PLUS updates all baselines atomically

This tool orchestrates: change detection → affected doc mapping → validation → quality assessment → optional baseline update.

Typical workflow: Use mode="check" after code changes to see documentation impact → fix identified issues → use mode="resync" to update baselines

ParametersJSON Schema
NameRequiredDescriptionDefault
project_pathYes
modeNocheck
docs_pathNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.2/5.0
Behavior4/5

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

Annotations provide readOnlyHint=false and idempotentHint=true. The description adds value by explaining that mode='check' is read-only and mode='resync' modifies baselines atomically, and detailing the orchestration steps. No contradiction with annotations.

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 well-structured with an overview, usage guidance, result summary, mode explanations, and a typical workflow. It is front-loaded with the purpose, and every sentence adds value without being verbose.

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?

Given the tool's complexity (orchestrating multiple sub-tools) and that an output schema exists (not shown), the description provides a thorough overview, workflow, and mode details. It could mention prerequisites (e.g., initialized docs) but is otherwise quite complete.

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 the description must compensate. It explains the 'mode' parameter and its two values (check, resync) in detail. However, it does not describe 'project_path' or 'docs_path' explicitly, though their purpose is implied. Partial compensation, but could be more explicit.

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 orchestrates a complete documentation sync, listing specific actions (detect changes, validate, assess quality, update baselines). It distinguishes from siblings like docmgr_assess_quality or docmgr_detect_changes by being a higher-level orchestrator.

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?

The description explicitly says 'Use when: After code changes to get complete documentation health report, or after doc updates to reset baselines' and outlines a typical workflow. It contrasts modes (check vs resync) but does not explicitly mention when to use sibling tools instead.

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

docmgr_update_baselineA
Idempotent

Update all baseline files to reflect current project state.

Use when: After updating documentation to match code changes, resetting the "clean" baseline Result: Atomically updates three baseline files: repo-baseline.json (checksums), symbol-baseline.json (code symbols), dependencies.json (code-doc mappings) Mode: State-modifying (rewrites baseline files)

This resets change detection to current state - run this when documentation is in sync with code.

Typical workflow: After writing/updating docs → run this to update baselines → future change detection starts from new baseline

ParametersJSON Schema
NameRequiredDescriptionDefault
project_pathYes
docs_pathNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.9/5.0
Behavior5/5

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

Annotations already indicate idempotentHint=true and not read-only. The description adds valuable context: 'Mode: State-modifying (rewrites baseline files)', 'Atomically updates three baseline files', and 'This resets change detection to current state'. No contradiction with annotations.

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 description is well-structured with clear sections (Use when, Result, Mode, Workflow) and is concise. Minor redundancy (e.g., 'update all baseline files' and 'resets change detection') prevents a perfect score.

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 the tool has 2 parameters and 0% schema coverage, the description should explain the parameters. It does cover purpose and behavior thoroughly and the output schema exists so return values are not needed. The missing parameter semantics reduce completeness.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% and the description does not explain the two parameters (project_path, docs_path) beyond their names. With no documentation in schema or description, the agent gets no guidance on what values to provide or their format.

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 action ('update all baseline files') and lists the specific files affected (repo-baseline.json, symbol-baseline.json, dependencies.json). It distinguishes from siblings like docmgr_detect_changes (detects changes) and docmgr_sync (syncronizes).

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?

The description provides explicit usage guidance: 'Use when: After updating documentation to match code changes, resetting the clean baseline' and includes a typical workflow. It does not explicitly state when not to use or list alternatives, which would elevate it to 5.

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

docmgr_validate_docsA
Read-onlyIdempotent

Validate documentation for broken links, missing assets, code snippet syntax, and convention compliance.

Use when: Before releases, after major doc updates, or as part of CI/CD to catch documentation issues Result: Returns list of validation issues categorized by type (broken links, missing assets, syntax errors, convention violations) with file/line numbers Mode: Read-only (only analyzes documentation)

Optional checks:

  • check_links: Validate internal links point to existing files

  • check_assets: Verify images/assets exist and have alt text

  • check_snippets: Validate code block syntax

  • validate_code_syntax: Deep syntax validation with TreeSitter (slower)

  • validate_symbols: Check documented symbols exist in codebase

Typical workflow: Run regularly to maintain documentation quality, fix reported issues, re-run until clean

ParametersJSON Schema
NameRequiredDescriptionDefault
project_pathYes
docs_pathNo
check_linksNo
check_assetsNo
check_snippetsNo
validate_code_syntaxNo
validate_symbolsNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already provide readOnlyHint=true, destructiveHint=false, and idempotentHint=true. The description adds that it is 'Read-only (only analyzes documentation)' and notes that validate_code_syntax is 'slower'. This provides useful behavioral context beyond the annotations.

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 concise and well-structured with sections for usage, result, mode, optional checks, and workflow. Every sentence adds value, and there is no redundancy or wasted text.

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?

Given 7 parameters, 1 required, 0% schema descriptions, and an output schema, the description covers the main checks and the result format. It could be more explicit about the path parameters, but it provides sufficient context for effective use.

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?

The schema has 0% description coverage. The description compensates by explaining each optional boolean check (e.g., 'Validate internal links', 'Verify images/assets exist'). However, it does not elaborate on the project_path or docs_path parameters, which could benefit from additional clarity.

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 'Validate documentation for broken links, missing assets, code snippet syntax, and convention compliance.' It uses a specific verb and resource, listing distinct validation categories. This differentiates it from sibling tools like docmgr_assess_quality or docmgr_detect_changes.

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?

The description explicitly provides usage scenarios: 'Use when: Before releases, after major doc updates, or as part of CI/CD' and mentions a typical workflow. While it does not explicitly mention alternatives, the context implies when to use this tool over others.

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

TDQS

A4.3/5.0
Disambiguation5/5

Each tool has a clearly distinct purpose: quality assessment, change detection, platform detection, initialization, migration, orchestrated sync, baseline updates, and validation. No two tools overlap in functionality; even docmgr_sync, which orchestrates multiple steps, is distinct as a high-level workflow tool.

Naming Consistency5/5

All tools follow the consistent pattern 'docmgr_verb_noun' (e.g., assess_quality, detect_changes, update_baseline), with minor abbreviations like 'init' and 'sync' that still fit the pattern. The prefix and underscore convention are uniform throughout.

Tool Count5/5

With 8 tools, the server is well-scoped for a documentation management system. Each tool covers a necessary operation (init, validate, assess, detect, migrate, sync, baseline update, platform detection) without being bloated or sparse.

Completeness5/5

The tool set covers the full documentation management lifecycle: setup (docmgr_init, docmgr_detect_platform), maintenance (docmgr_detect_changes, docmgr_validate_docs, docmgr_assess_quality), restructuring (docmgr_migrate), and baseline resetting (docmgr_update_baseline). The orchestrating tool docmgr_sync ties them together. No obvious gaps for the stated purpose.

Maintenance

ActivityInactive
ResponsivenessNo issues

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Connectors

Related MCP Servers

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