Moxie Docs
@Jackalope-Dev
关于 Moxie Docs
MCP & Agent Skills for Moxie Docs
基本信息
配置
使用下面的配置,将此服务器添加到你的 MCP 客户端。
{
"mcpServers": {
"moxie-docs": {
"url": "https://moxiedocs.com/api/mcp"
}
}
}工具
10Get the coding conventions Moxie inferred for the repository. Read-only; no side effects. Returns a Markdown list grouped by category (e.g. testing, structure, docs, review); each convention has a title, summary, confidence score, agent guidance, and the source file paths that evidence it. Use this for the general rules to follow; when you already know the files you're about to edit, prefer moxie.get_doc_impact for conventions scoped to those paths.
Keyword and semantic search across the connected repository's generated docs, conventions, documentation gaps, AI-context notes, and indexed code. Read-only; no side effects. Returns ranked matches in Markdown grouped into Documentation and Code sections, each with a title, snippet, and source paths. Use for open-ended lookups when you don't know which category holds the answer; when you do, the specific getters (get_conventions, get_doc_gaps, get_documentation_opportunities) are more direct. Omitting query returns recent context instead.
List the repository's generated documentation as a browsable table of contents — every doc page, not a query-filtered subset. Read-only; no side effects. Returns Markdown grouped by section, each entry with its title, slug, repository path, and source paths, plus the total count and a pagination cursor so you can tell whether more pages remain (no silent truncation). Use this to see what docs already exist before adding one (so you don't duplicate) or to find the slug to pass to propose_doc_update; when you are hunting for a specific topic, search_docs is more direct.
List the unresolved documentation gaps Moxie found — areas of the codebase that lack docs. Read-only; no side effects. Returns a Markdown list, each gap with a title, severity, summary, and suggested file paths. This is gaps only; for the full prioritized work queue that also includes drift repairs and PR-template work, use get_documentation_opportunities, and to scope gaps to files you're about to edit use get_doc_impact.
List the actionable documentation updates Moxie recommends as a prioritized queue: missing docs, drift repairs, and PR-template work. Read-only; no side effects. Returns a Markdown list, each opportunity with a title, kind (documentation_gap | documentation_drift | pr_template), severity, summary, suggested action, estimated files changed, and source paths. Use this to pick the next doc task; it is the superset of get_doc_gaps (which lists gaps only).
Get Moxie's summary of how THIS repository organizes and maintains documentation — where docs live relative to code and how they are kept current. Read-only; no side effects. Returns a Markdown list of pattern entries, each with a title, explanation, and source citations. Use this to decide WHERE a new doc should go before calling propose_doc_update; for the list of WHICH docs need work, use get_documentation_opportunities instead.
Get the compact briefing an agent should read before editing this repository: index status, verified commands, agent tips, top conventions, open documentation gaps, and queued documentation opportunities. Read-only; no side effects. Returns a single Markdown document. Call this first at the start of a task; once you know which files you'll change, follow up with get_doc_impact for path-scoped guidance.
Given the file paths an agent is about to change (and optionally a subset being deleted), return the conventions, documentation gaps, and existing/related docs whose evidence overlaps those paths, plus a net-new/undocumented analysis and any removal candidates. Read-only; no side effects. Returns a Markdown report. Call this BEFORE writing code so doc updates land in the same PR; then use propose_doc_update to write a doc, or propose_doc_removal for an orphaned one.
Propose a documentation file to add or update as part of YOUR current change. Records a new proposal each call (not idempotent) and does NOT modify your repository or open a PR — Moxie resolves the target path and returns the path + Markdown for YOU to write into your working branch, so the docs land in the SAME PR as the code. Returns the resolved target path and the content to write. Provide either targetPath or baseSlug.
Propose deleting a Moxie-tracked documentation file that your change makes irrelevant, as part of YOUR current change. Moxie validates the path and returns it for you to delete in your working branch; Moxie itself does not delete files or open a PR — the deletion happens in your branch, so it lands in the SAME PR as the code. Returns the resolved path to delete. Provide either slug or targetPath.
概览
What is Moxie Docs?
Moxie Docs is a Model Context Protocol (MCP) server that indexes a connected GitHub repository, keeps its documentation alive by generating docs, discovering conventions, tracking gaps and drift, and opening pull requests to sync docs with code. It provides live context and documentation tools for coding agents like Claude Code, Cursor, VS Code, and Codex.
How to use Moxie Docs?
Run npx moxie-docs setup from your repository’s directory. This signs you in via OAuth, writes the MCP config for your editor, installs the moxie-docs skill and AGENTS.md guidance, and verifies the connection. Alternatively, connect a repository at https://moxiedocs.com and configure your MCP client with the server URL and a bearer token.
Key features of Moxie Docs
- Indexes your GitHub repository to keep documentation alive.
- Discovers coding conventions with confidence scores and source citations.
- Identifies documentation gaps, drift, and recommended doc work.
- Provides read‑only tools and proposals for doc updates/removals.
- Exposes prompts to script “document‑this‑change” and “fix‑stale‑docs” workflows.
- Installs deterministic skill and guidance files into your repository.
- Supports both Bearer token and OAuth 2.1 authentication.
Use cases of Moxie Docs
- Before editing code, get a compact briefing of repository conventions, commands, and open gaps.
- After changing files, automatically propose matching documentation updates in the same PR.
- Find and repair stale or missing docs across the entire repository.
- Ground coding agents in your repository’s actual conventions and command verification.
- Keep generated documentation synced with code changes without manual oversight.
FAQ from Moxie Docs
What transport does the Moxie Docs MCP server use?
Streamable HTTP MCP at https://moxiedocs.com/api/mcp (protocol version 2025-06-18).
How does authentication work?
You can use a Bearer token from the dashboard (Authorization: Bearer <TOKEN>) or OAuth 2.1 sign‑in (authorization‑code + PKCE) for clients that support it. Both resolve to the same token model.
Does Moxie Docs edit my repository directly?
No. All write tools are proposals that return file paths and content for your agent to write into its own branch. Moxie never edits your repository through MCP and never merges.
What files does Moxie install into my repository?
An AGENTS.md pointer file, plus the moxie-docs skill in .claude/skills/ and .agents/skills/. These are deterministic and contain no volatile data.
Where is my repository’s data stored?
The hosted server, indexing pipeline, and your generated docs are kept in the private Moxie service (not in this open‑source repository). Only token hashes, prefixes, scope, and last‑used timestamps are stored.
记忆与知识 分类下的更多 MCP 服务器
MCP server for Obsidian
MarkusPfundsteinMCP server that interacts with Obsidian via the Obsidian rest API community plugin
Ultimate Google Docs & Drive MCP Server
a-bonusThe Ultimate Google Docs, Sheets, Drive, Gmail, & Google Calendar MCP Server. This MCP (primarily for use in Claude Desktop) gains full access to your google suite and lets claude do its thing.
Obsidian MCP Server
cyanheadsRead, write, search, and surgically edit Obsidian vault notes, tags, and frontmatter via MCP. STDIO or Streamable HTTP.
Context Portal MCP (ConPort)
GreatScottyMacContext Portal (ConPort): A memory bank MCP server building a project-specific knowledge graph to supercharge AI assistants. Enables powerful Retrieval Augmented Generation (RAG) for context-aware development in your IDE.
Semantic Scholar MCP Server
YUZongminA FastMCP server implementation for the Semantic Scholar API, providing comprehensive access to academic paper data, author information, and citation networks.
评论