Skip to main content

SnapDoczilla MCP server

Offline docs-as-code for any backend and any frontend, driven by your AI agent. SnapDoczilla keeps a documentation/ folder inside your repo: a static HTML site (MkDocs Material, local Mermaid diagrams, ADRs, API map and component pages with real code and real usage) that anyone opens with a double click and any dev refreshes with one command.

Working under CMMI? Install with profile: "cmmi" to add a process-evidence page (practice areas → repo evidence), DAR-style ADRs, a requirement → code → tests traceability matrix and release baselines.

This MCP server gives your agent the deterministic half of that workflow. The agent writes the docs from your code; the server installs, tracks what changed since the last documented commit, writes pages safely, and builds the site.

Install

Needs uv (for uvx), git, and bash (on Windows: Git for Windows). Building the site also needs Python 3 on PATH, and internet the first time (MkDocs and Mermaid are downloaded once).

Claude Code

claude mcp add snapdoczilla -- uvx snapdoczilla-mcp

Claude Desktop, Cursor and other clients that use mcpServers JSON

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

Codex CLI (~/.codex/config.toml)

[mcp_servers.snapdoczilla]
command = "uvx"
args = ["snapdoczilla-mcp"]

This server does not read your source code. Your client does, with its own file tools (Claude Code, Cursor and Codex have them; in Claude Desktop add a filesystem server).

Tools

Tool What it does
snapdoczilla_status Installed? Areas, commits not yet documented per area, existing pages, next ADR number, suggested next step. Start here.
snapdoczilla_install Scaffolds documentation/ (templates, update script, pre-push reminder), writes areas.conf, downloads Mermaid once. Refuses to touch a documentation/ it did not create.
snapdoczilla_add_manual Adds an end-user manual (user-manual/ section in nav, manual rules: steps, exact UI labels, messages, screenshot placeholders) to an install of any profile.
snapdoczilla_get_rules Returns the rules the pages must follow (language, never invent, embed real code).
snapdoczilla_changes_since_sync Files, commits and diffstat of an area since its last documented commit, so only affected pages are updated.
snapdoczilla_write_page Creates or overwrites one Markdown page, confined to documentation/source/, and adds it to nav.
snapdoczilla_build_html Strict MkDocs build into documentation/html/. A failed build keeps the previous site. No AI agent is invoked.
snapdoczilla_mark_synced Records HEAD as the last documented commit of an area.

There is also a prompt, document_project, that starts the whole flow.

Typical use

Ask your agent: "Document this project" (or "update the docs"). It checks status, installs if needed, reads the real code, writes the pages, builds, and marks the areas as synced. It never commits or pushes: you review git diff.

Also available as a plain Agent Skill

The same workflow ships as a SKILL.md for Claude Code, Codex, OpenCode, Gemini CLI and more. See the repository for screenshots, the examples/shop result and the full documentation.

MIT License.

Metadata

Release files for snapdoczilla-mcp 1.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for snapdoczilla-mcp 1.2.0
File Size Uploaded Provenance
snapdoczilla_mcp-1.2.0.tar.gz 30.7 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for snapdoczilla-mcp 1.2.0
File Interpreter ABI Platform
snapdoczilla_mcp-1.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 68.0 kB

Release files / snapdoczilla_mcp-1.2.0.tar.gz

Download URL snapdoczilla_mcp-1.2.0.tar.gz
Size 30.7 kB
Tags Source
SHA-256 checksum
How to use checksums
d7330a150381269df7ed873a6b351a9b4c46d91ee1d99726e3b3695532b690d1
BLAKE2b-256 checksum
How to use checksums
94439a804be737aea749ffc6be1e173874df0b7c1aef140f223fae7a3889177e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.0

Release files / snapdoczilla_mcp-1.2.0-py3-none-any.whl

Download URL snapdoczilla_mcp-1.2.0-py3-none-any.whl
Size 37.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fd19cddd736722f29c119fc2e896c9e83f49eddab94e325eab7aa2491403a05e
BLAKE2b-256 checksum
How to use checksums
c82c221a41c555e37e981465f7fb62e80de52fa24b63ab7bb060df71e54ffecb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.0

Security for snapdoczilla-mcp 1.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

1.2.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page