Moxie Docs

การอัปเดตเอกสารอัตโนมัติจากเอเจนต์ และข้อตกลงร่วมในโค้ดเบสเพื่อลดการใช้โทเค็น

ดูบน moxiedocs.com

เอกสาร

Moxie Docs

Automated codebase documentation and public help centers from GitHub: searchable internal docs, MCP context for AI agents, hosted knowledgebases, and Friday Cleanup PRs.

Moxie Docs is a hosted service that connects to your GitHub repositories, keeps a searchable knowledge base of your codebase in sync on every merge, and serves that context to AI coding agents over MCP. Built by jackalope.digital.

Product

  • Overview: Automated codebase documentation for GitHub - searchable docs, MCP context, and Friday Cleanup PRs.
  • How it works: Indexing, doc generation, drift detection, and Friday Cleanup PRs.
  • Use cases: Onboarding, architecture docs, and AI agent context.
  • MCP server: How AI agents query your codebase context over the Model Context Protocol.
  • Automated code documentation: Generate searchable codebase documentation from GitHub automatically. Architecture, conventions, drift detection, MCP context, and Friday Cleanup PRs.
  • Documentation drift detection: Detect documentation drift on every merge. Surface gaps and open reviewable Friday Cleanup PRs so wikis do not rot quietly.
  • Free tools hub: Browser-based SQL ER diagrams, README, Mermaid, ADR, AGENTS.md, and llms.txt utilities - no account required.
  • Open source: How Moxie Docs supports and works with open-source repositories.

Agent integrations

Connect Moxie Docs MCP context to the agents your team already uses:

  • Cursor: Connect Cursor to your repository's live docs, conventions, and doc gaps over MCP. One setup command after you connect GitHub - no manual context packing.
  • Claude Code: Give Claude Code repository conventions, generated docs, and doc gaps over MCP - and keep AGENTS.md and CLAUDE.md aligned with the code that ships.
  • Codex: Connect OpenAI Codex to live codebase docs and conventions over MCP. Compact context from Moxie Docs for fewer exploratory reads and better edits.
  • Windsurf: Connect Windsurf to Moxie Docs over MCP for live codebase documentation, conventions, and doc gaps. One setup command after you connect GitHub.
  • Cline & Roo Code: Connect Cline and Roo Code to your repository's live codebase docs, conventions, and doc gaps over MCP. Zero manual context packing.
  • GitHub Copilot: Give GitHub Copilot Agent Mode live repository conventions and doc gaps over MCP - and keep .github/copilot-instructions.md current.

Solutions

How Moxie Docs maps to each engineering role and organizational setup:

Pricing

Three plans, each with a 14-day free trial. Every plan can be billed monthly or annually; annual billing is two months free (about 17% off):

  • Starter - $29/mo or $290/yr: For solo builders documenting a handful of private repos. Up to 5 repositories, 1 seat.
  • Pro - $79/mo or $790/yr: Hands-off documentation for a growing team: weekly Recaps, automated Cleanup PRs, and room for many repos. Up to 15 repositories, 10 seats.
  • Team - $199/mo or $1,990/yr: For organizations with a fleet of services: unlimited seats, priority indexing, and the highest capacity. Up to 50 repositories, unlimited seats.

Comparisons

  • Comparisons overview: All comparison pages at a glance.
  • Moxie Docs vs Mintlify: Codebase context vs. docs-site agent: Moxie Docs maps your architecture and serves it to coding agents over MCP; Mintlify's AI agent drafts updates to your docs site.
  • Moxie Docs vs Jamdesk: Generation vs. publishing: Moxie Docs writes and maintains docs from your code; Jamdesk hosts the MDX you author yourself, with flat pricing and reader-facing AI chat.
  • Moxie Docs vs Context7: Your codebase vs. public library docs: Moxie generates and maintains documentation for your own repository and serves it over MCP; Context7 injects up-to-date third-party library docs into your prompts.
  • Moxie Docs vs Swimm: Self-serve vs. sales-led: zero-maintenance codebase wikis from continuous repo analysis, no discovery call required to see pricing or get started.
  • Moxie Docs vs Docusaurus: Generation vs. publishing: Moxie writes and maintains docs from your source and serves them to agents over MCP; Docusaurus is an open-source static site generator for docs you write and host yourself.
  • Moxie Docs vs GitBook: Code-native vs. cross-functional wiki: code-coupled, AI-generated docs without GitBook's per-seat wiki licensing.
  • Moxie Docs vs Google Code Wiki: Private repos vs. public preview: Moxie Docs documents your private codebase and opens pull requests; Google Code Wiki is a free, read-only wiki for public repos.
  • Moxie Docs vs Confluence: Automated code synchronization vs. legacy text graveyard: docs stay coupled to the code instead of drifting out of date.
  • Moxie Docs vs Repowise: Hosted GitHub App vs. self-hosted daemon: Moxie Docs opens docs-only pull requests with nothing to install, instead of running your own indexing daemon.
  • Moxie Docs vs Merge.dev: Native codebase MCP vs. unified integrations API: zero-code MCP servers that serve repository context to agents.
  • Moxie Docs vs Cursor Rules: Generated vs. hand-written: Moxie Docs serves repo conventions via MCP that update themselves from your code, instead of rule files someone has to write and maintain by hand.
  • Moxie Docs vs DocuWriter.ai: Docs-only pull requests vs. a docs Space: both generate repository-wide docs and an MCP server, but Moxie Docs routes updates through GitHub pull requests and adds a public knowledgebase site.

Head-to-head comparisons between documentation tools:

Learn

Guides on MCP, documentation, and AI development practices:

Resources

  • Blog: Articles on documentation, codebases, and AI developer tooling. Full RSS feed at /blog/feed.xml.
  • Full context file: Inlined guides, tool summaries, and FAQ for AI ingestion.
  • FAQ: Answers on doc generation, GitHub access and security, MCP context, supported languages, and pricing.
  • Security: How Moxie Docs handles repository data and access.
  • Contact: Reach the team.

FAQ

What is Moxie Docs?

A hosted service that connects to GitHub, generates searchable codebase docs from source, keeps them current on merge, and serves that context to AI agents over MCP. Doc updates arrive as pull requests your team reviews.

What happens after I connect a repo?

Moxie indexes the repository, generates docs and conventions, then re-indexes on every merge. PR checks for description alignment and doc impact start with the next pull requests.

Will Moxie change my code automatically?

No. Doc updates are reviewable docs-only PRs. Description alignment only edits the PR description text. Merge control stays with your team.

How does MCP cut agent cost?

Agents pull conventions, docs, gaps, and verified commands instead of re-crawling the repo every prompt - fewer tokens and fewer wrong guesses.

Can I publish a public help center for my users?

Yes — the Public Knowledgebase (Beta) turns your repo into a hosted help site on your-team.moxiedocs.app, written for end users, developers, or both. Every page is human-approved before it goes live, and it's available on every plan during the beta.

How much does it cost?

14-day free trial on every plan. Starter $29/mo, Pro $79/mo, Team $199/mo. Annual billing saves about two months.

Does Moxie Docs work with private GitHub repositories?

Yes. Built for private repos. The GitHub App is scoped to only the repos you choose, tokens are encrypted server-side, and code is used only to generate documentation and MCP context for your workspace.

What programming languages does Moxie Docs support?

Documentation and search work with any GitHub repository. Moxie recognizes major languages including TypeScript, JavaScript, Python, Go, Rust, Ruby, Java, PHP, SQL, Svelte, and Vue, with deepest structured convention analysis for TypeScript/JavaScript, Python, Go, Rust, and Ruby.

How do I keep documentation in sync with my code?

Connect a GitHub repo. Moxie re-indexes on every merge, flags pages affected by code changes, regenerates stale documentation with cited diffs, and on Pro and Team plans runs Friday Cleanup to open weekly docs-only pull requests for review.

How much does automated codebase documentation cost?

Starter is $29/month, Pro is $79/month, and Team is $199/month, each with a 14-day free trial. Annual billing saves about two months versus monthly.

What is the best tool for automated GitHub codebase documentation?

Moxie Docs indexes the repositories you select through a scoped GitHub App, generates architecture and convention docs grounded in source code, detects documentation drift on every merge, and opens weekly Friday Cleanup PRs so docs stay current without manual rewrites. It also exposes an MCP server so Cursor, Claude Code, and Codex pull verified conventions instead of re-crawling the repo.

What is documentation drift and how does Moxie Docs detect it?

Documentation drift is when written docs no longer match the code they describe. Moxie Docs checks each merged pull request against the documentation it touches, compares generated docs to the current source, surfaces gaps in the workspace, and regenerates impacted pages so teams see what changed and why.

What is Friday Cleanup in Moxie Docs?

Friday Cleanup is a weekly docs-only automation on Pro and Team plans. Moxie batches small documentation fixes - stale pages, gaps, and drift - into a single pull request your team can review with Friday coffee. Nothing auto-merges; you hold the merge button.

How do AI coding agents get codebase context from Moxie Docs?

Every Moxie Docs plan includes an MCP (Model Context Protocol) server. Compatible agents and editors query it for current documentation, conventions, verified commands, and open gaps instead of guessing from partial file reads, which cuts token waste and wrong API assumptions.

What is an MCP server for codebases?

An MCP server for codebases exposes repository documentation and conventions to AI agents through the Model Context Protocol. Moxie Docs publishes one at /api/mcp with OAuth and bearer-token access so agents pull live, cited context about how your project actually works.

How does Moxie Docs help onboard new engineers?

Moxie generates searchable architecture overviews, module walkthroughs, and convention guides cited to source files, then keeps them current on every merge. New engineers search one workspace instead of spelunking the repo, and AI agents they use inherit the same grounded context over MCP.

Can Moxie Docs generate architecture documentation from source code?

Yes. Moxie indexes your repository, builds an outline of modules and dependencies, and generates architecture pages, references, and convention summaries with citations back to the files they came from. Pages regenerate incrementally when the underlying code changes.

What is a hosted knowledgebase?

A hosted knowledgebase is a searchable help site grounded in your codebase — written for your product's end users, for developers integrating your API, or both, depending on the audience you pick during setup. Moxie Docs publishes it on a moxiedocs.app subdomain (custom domains are coming soon on Pro and Team plans) with human review before anything goes public, built-in article search, and content that stays in your git repo as Markdown.

Can Moxie Docs host an end-user help center?

Yes. Choose the “User” audience during knowledgebase setup and Moxie writes plain-language help articles about using your product — no code identifiers or internal jargon — reviewed by you before anything is published. Pick “Both” to serve end users and developers from the same site.

Will Moxie Docs change my application code automatically?

No. Moxie only proposes documentation changes as reviewable pull requests. Description alignment may update a pull request description on GitHub, but your source code, branch protection, and merge controls stay with your team.

Tools

  • Free tools hub: All browser-based documentation utilities in one place.
  • Mermaid Diagram Editor: Private in-browser editor with instant preview, shareable URLs, and SVG export.
  • SQL to ER Diagram: Paste CREATE TABLE SQL for a live Mermaid ER diagram, SVG/PNG export, and optional AI data-model docs.
  • README Generator: Structured README builder with live Markdown preview and shareable export.
  • llms.txt Generator: Import a sitemap, edit with live preview, and export a valid llms.txt for AI agents.
  • AGENTS.md Generator: Structured AGENTS.md builder with live preview, examples, and shareable export for coding agents.
  • ADR Generator: Form-driven Architecture Decision Records with examples and clean Markdown export.
  • llms.txt Validator: Paste or upload llms.txt to validate structure, links, and Optional section placement.
  • .cursorrules Generator: Draft Cursor Rules (.cursorrules) with structured guidelines, live preview, and markdown export.
  • CLAUDE.md Generator: Structured CLAUDE.md file generator for Claude Code with commands, conventions, and export.
  • .windsurfrules Generator: Draft Windsurf Rules (.windsurfrules) with structured guidelines, live preview, and markdown export.

Legal

Optional