Moxie Docs

MCP开发工具

提供方 Jackalope-Dev · 包名 moxie-docs

开发工具 stdio · 本地进程 OAuth 授权 社区 / 第三方 ClaudeCursorVS CodeWindsurf
查看接入方式

Automated codebase documentation for GitHub: searchable docs, MCP context for AI agents, doc drift detection, and Friday Cleanup PRs.

一句话选型结论

按资料字段整理

Moxie Docs 属于开发工具类 MCP 服务器,stdio · 本地进程,OAuth 授权,可直接接入 Claude、Cursor、VS Code 等,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类开发工具 传输方式stdio · 本地进程 鉴权OAuth 授权 部署方式本地部署
GitHub 星标 未标注 仓库热度,无公开仓库时显示未标注
工具数 未标注 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

开发工具
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量未标注暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

developer toolsdocumentationgithub

安装与配置

stdio · 本地进程 OAuth 授权
客户端在本机拉起子进程,数据不出本机
npx moxie-docs setup

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 node,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后随便调一个只读工具,确认能返回结果,再接入正式流程。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
代码与仓库操作

在对话里直接查代码、提 issue、走 PR,省掉来回切工具。

本地命令与脚本

把构建、测试、格式化这类重复命令交给模型执行。

接口联调与测试

让模型调你的接口、跑一遍用例,快速定位问题。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 Claude、Cursor、VS Code,换客户端不用重新研究配置。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 使用前要准备好OAuth 授权对应的凭据,并按最小权限配置。
  • 资料没标注工具数量,实际能力要装好后确认。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在开发工具场景里让模型直接调用外部能力的人。
  • 已经在用 Claude、Cursor 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Moxie Docs当前 未标注 stdio · 本地进程 本地部署 有 未标注
Git 838e2ec1 12 stdio · 本地进程 本地部署 有 2026-05-17
Markitdown MCP 2c653a5f 1 stdio · 本地进程 本地部署 有 2026-05-17
JavaGuide 未标注 stdio · 本地进程 本地部署 有 2026-04-11
awesome-claude-skills 未标注 stdio · 本地进程 本地部署 有 2026-04-26
Context7 831acf40 未标注 stdio · 本地进程 本地部署 有 2026-05-17

服务器档案

开发工具
字段来自项目仓库与公开索引,中文说明由本站标注
提供方Jackalope-Dev上游标注的维护方 Jackalope-Dev
分类开发工具本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式OAuth 授权远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时moxie-docs · node本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验未标注上游最后核验时间

详细介绍

16.7 KB
来自项目仓库与上游目录的原文,未做删改

Visit Moxie Docs

Moxie Docs — MCP & Agent Tools

The Moxie Docs Model Context Protocol (MCP) server, the agent skills Moxie Docs installs into your repository, and the moxie-docs CLI that wires it all up — npx moxie-docs setup.

This repo is also the open-source home of the moxie-docs npm package: a setup CLI plus the MCP interface (tool catalog, prompts, server metadata, and skill renderers) you can import. The hosted server, indexing pipeline, and your generated docs stay in the private Moxie Docs service.

Moxie Docs indexes a connected GitHub repository and keeps its documentation alive — generating docs, discovering conventions, tracking documentation gaps and drift, and opening pull requests that keep docs in sync with code. The MCP server exposes that living context to coding agents (Claude Code, Cursor, VS Code, Codex, and any MCP-capable client) so they ground their work in how your repository actually does things — and keep the docs current as they change code.

  • Website / dashboard: https://moxiedocs.com
  • Human docs for the MCP server: https://moxiedocs.com/mcp
  • MCP endpoint: https://moxiedocs.com/api/mcp

This repository is documentation and distribution assets only. The hosted server, indexing pipeline, and your repositories' documentation are not stored here.


Contents

  • Quick start
  • CLI
  • The MCP server
  • Connection
  • Authentication
  • Client configuration
  • Tools
  • Prompts
  • Claude plugin
  • Skills
  • The moxie-docs skill
  • What Moxie Docs installs into your repository
  • Use as a library
  • Find the server
  • Discovery endpoints
  • License

Quick start

The fastest path — from your repository's directory:```bash
npx moxie-docs setup


This signs you in (OAuth in your browser), writes the MCP config for your editor, installs the `moxie-docs` skill + `AGENTS.md` guidance, and verifies the connection. After that, your agent reads live context with `moxie.get_ai_context` before editing and proposes doc updates that land in the same PR.

Prefer to do it by hand? Connect a repository at https://moxiedocs.com, then add the server to your agent with a config block.

---

## CLI

The `moxie-docs` CLI (Node ≥ 18, zero runtime dependencies) sets up and manages the connection. Run it with `npx moxie-docs ` or install it globally (`npm i -g moxie-docs`).

| Command | What it does |
| --- | --- |
| `moxie-docs setup` | End-to-end: sign in, configure your MCP client, install the skill + `AGENTS.md` block, and smoke-test. |
| `moxie-docs login` | Sign in via the browser (OAuth 2.1 + PKCE) and store credentials in `~/.moxie-docs/`. |
| `moxie-docs status` | Show your scope, connected repositories, and available tool count. |
| `moxie-docs config ` | Write the `moxie-docs` server entry into a client config (`claude-code`, `cursor`, or `vscode`). |
| `moxie-docs install-skill` | Install the `moxie-docs` skill and `AGENTS.md` guidance into the current repo. |
| `moxie-docs logout` | Remove stored credentials. |

Useful flags: `--client `, `--token `, `--repo owner/name`, `--no-browser`, `--yes`.

**How authentication is written.** By default `setup`/`config` write a **URL-only** server entry and let your editor perform its own OAuth sign-in on first use — so nothing in your committed config expires. The CLI's own browser sign-in (used for `status` and the setup smoke-test) stores a short-lived token plus a refresh token under `~/.moxie-docs/` (file mode `0600`); it is **never** written into a client config. If you'd rather pin a static `Authorization` header, pass a long-lived dashboard token with `--token` and the CLI writes that instead. The CLI never logs token values, and it refuses to overwrite a client config it can't safely parse rather than discarding your other MCP servers.

---

## The MCP server

### Connection

**Transport** · Streamable HTTP MCP
**Endpoint** · `https://moxiedocs.com/api/mcp`
**Protocol version** · `2025-06-18`
**Repository selection** · Tools accept an optional `repository` argument (`owner/name`, e.g. `acme/app`). It is required only when a token serves multiple repositories and no single default applies. Matching is case-insensitive.

All write tools are **proposals** — Moxie Docs returns the file path and content for *you* (the agent) to write into your own branch. Moxie Docs never edits your repository directly through MCP, and never merges. Reads return compact, citation-backed context rather than raw code dumps.

### Authentication

**Bearer token (available today).** Create a token in the dashboard and send it as a header:```
Authorization: Bearer <MOXIE_TOKEN>

Moxie Docs stores only the token hash (plus an encrypted copy so you can reveal it), a prefix, scope, and a last-used timestamp. You can reveal, rotate, or revoke tokens from the dashboard at any time.

OAuth 2.1 sign-in (for clients that support it). MCP clients that implement the OAuth authorization flow can connect by signing in through the browser instead of pasting a token — the client discovers the server's OAuth metadata, registers itself dynamically (RFC 7591), and obtains a token via the authorization-code + PKCE flow. Discovery documents:

  • Protected resource metadata: https://moxiedocs.com/.well-known/oauth-protected-resource
  • Authorization server metadata: https://moxiedocs.com/.well-known/oauth-authorization-server

Both authentication paths resolve to the same token model, so either works with the same tools. Connected applications can be reviewed and revoked from the dashboard.

Client configuration

Most agents accept a remote MCP server with a URL and headers. Replace `` with a token from the dashboard.

Claude Code — .mcp.json (or claude mcp add):```json
{
"mcpServers": {
"moxie-docs": {
"url": "https://moxiedocs.com/api/mcp",
"headers": {
"Authorization": "Bearer <MOXIE_TOKEN>"
}
}
}
}


**Cursor** — `.cursor/mcp.json`:```json
{
  &quot;mcpServers&quot;: {
    &quot;moxie-docs&quot;: {
      &quot;url&quot;: &quot;https://moxiedocs.com/api/mcp&quot;,
      &quot;headers&quot;: { &quot;Authorization&quot;: &quot;Bearer &lt;MOXIE_TOKEN&gt;&quot; }
    }
  }
}

VS Code — .vscode/mcp.json:```json
{
"servers": {
"moxie-docs": {
"type": "http",
"url": "https://moxiedocs.com/api/mcp",
"headers": { "Authorization": "Bearer <MOXIE_TOKEN>" }
}
}
}


&gt; Keep tokens out of source control. Reference an environment variable where your client supports it, or paste the token only into local, untracked config.

## Tools

- **`moxie.get_ai_context`**: Compact pre-edit briefing: repo status, verified commands, top conventions, open gaps, team notes. Read this first.
- **`moxie.get_doc_impact`**: Given the paths you&#x27;re about to change (and any you&#x27;re deleting), returns the conventions, gaps, and existing docs whose evidence overlaps them.
- **`moxie.get_api_context`**: Given paths you&#x27;re about to touch, returns structured context for any API endpoints they map to: method, path, schema, and known consumers.
- **`moxie.review_change`**: Self-review a change before opening the PR; returns a severity-ranked list of convention breaches, stale docs, undocumented surface, and broken references.
- **`moxie.get_conventions`**: Discovered coding conventions, grouped by category, with confidence scores, agent guidance, and source-file citations.
- **`moxie.search_docs`**: Semantic + keyword search over generated docs, conventions, gaps, and AI context.
- **`moxie.get_doc_gaps`**: Unresolved documentation gaps with severity and the paths they concern.
- **`moxie.get_documentation_opportunities`**: Recommended doc work: missing docs, drift repairs, and PR templates.
- **`moxie.get_documentation_patterns`**: How the repository organizes and maintains its docs (where new docs belong).
- **`moxie.list_docs`**: Paginated, section-grouped table of contents of every generated doc.
- **`moxie.propose_doc_update`**: Add or update a doc as part of your current change; returns target path + Markdown to write into branch.
- **`moxie.propose_doc_removal`**: Remove a Moxie Docs-tracked doc your change makes obsolete; returns path to delete in branch.

| Tool | Purpose |
| --- | --- |
| `moxie.get_ai_context` | Compact pre-edit briefing: repo status, verified commands, top conventions, open gaps, team notes. Read this first. |
| `moxie.get_doc_impact` | Given the paths you&#x27;re about to change (and any you&#x27;re deleting), returns the conventions, gaps, and existing docs whose evidence overlaps them - and flags net-new/undocumented surfaces. |
| `moxie.get_api_context` | Given paths you&#x27;re about to touch, returns structured context for any API endpoints they map to: method, path, schema, and known consumers/features. |
| `moxie.review_change` | Self-review a change before opening the PR; returns a severity-ranked verdict (clean / warnings / must-fix) covering convention breaches, stale docs, undocumented surface, and broken references. |
| `moxie.get_conventions` | Discovered coding conventions, grouped by category, with confidence scores, agent guidance, and source-file citations. |
| `moxie.search_docs` | Semantic + keyword search over generated docs, conventions, gaps, and AI context. |
| `moxie.get_doc_gaps` | Unresolved documentation gaps with severity and the paths they concern. |
| `moxie.get_documentation_opportunities` | Recommended doc work: missing docs, drift repairs, and PR templates. |
| `moxie.get_documentation_patterns` | How the repository organizes and maintains its docs (where new docs belong). |
| `moxie.list_docs` | Paginated, section-grouped table of contents of every generated doc. |
| `moxie.propose_doc_update` | Add or update a doc as part of your current change; returns the target path + Markdown to write into your branch. |
| `moxie.propose_doc_removal` | Remove a Moxie Docs-tracked doc your change makes obsolete; returns the path to delete in your branch. |

### Prompts

The server also exposes MCP prompts that script the common workflows:

| Prompt | Purpose |
| --- | --- |
| `document-this-change` | Runs the doc-impact check on your changed paths and walks you through proposing the doc updates so they land in the same PR. |
| `fix-stale-docs` | Finds the repository&#x27;s open documentation gaps and drift opportunities and repairs them through Moxie Docs. |
| `review-before-finalize` | Runs Moxie Docs&#x27; guardrail over your diff before you open the PR to catch convention breaches, stale docs, undocumented surface, and broken references. |

---

## Claude plugin

For **Claude Code** and **Claude Cowork**, this repository doubles as a plugin marketplace — a one-command way to add the Moxie Docs connector and skill together. The plugin bundles:

- the **`moxie-docs` MCP server** (the remote endpoint above), wired up so your client runs its own OAuth sign-in on first use — no token to paste or commit; and
- the **`moxie-docs` skill**, so the edit-then-document workflow is available the moment the plugin is installed.

Install it from inside Claude Code (or Cowork):```
/plugin marketplace add Jackalope-Dev/Moxie-Docs-MCP
/plugin install moxie-docs@moxie-docs

The first command registers this repo as a marketplace; the second installs the moxie-docs plugin from it. On first use of a Moxie Docs tool, your client opens the browser to sign in, then the tools and prompts above are available. Update later with /plugin marketplace update moxie-docs, and remove with /plugin uninstall moxie-docs@moxie-docs.

Prefer a static token, or a client without plugin support? Use the client configuration blocks or the CLI instead — the plugin, the CLI, and a hand-written config all resolve to the same server and the same auth model.

The plugin's manifest lives in .claude-plugin/ and its server entry in .mcp.json.


Skills

Agent Skills are small, triggered instruction files that teach an agent when and how to use a capability. Moxie Docs publishes one skill, moxie-docs, that wires an agent into the edit-then-document workflow.

The moxie-docs skill

The canonical skill lives in this repo at skills/moxie-docs/SKILL.md and is also served from the website (with a published SHA-256 digest) at:```
https://moxiedocs.com/.well-known/agent-skills/moxie-docs/SKILL.md


It tells an agent to read live context before editing (`get_ai_context`, `get_doc_impact`), follow the repository&#x27;s real conventions and verified commands, and propose doc updates/removals that ship in the **same PR** as the code change — never inventing filler docs.

### What Moxie Docs installs into your repository

When Moxie Docs connects a repository it opens one **&quot;Add Moxie Docs agent guidance&quot;** PR that adds three self-healing, deterministic files (regenerated only when they drift or the repo is renamed — never churning on every index):

| File | Purpose |
| --- | --- |
| `AGENTS.md` | A short, always-on pointer block (between `` / `` markers) telling any agent to use the MCP server and the `moxie-docs` skill. Human-added content outside the markers is preserved. See `templates/AGENTS.md`. |
| `.claude/skills/moxie-docs/SKILL.md` | The repo-specific `moxie-docs` skill for Claude Code. |
| `.agents/skills/moxie-docs/SKILL.md` | The same skill for `.agents`-aware clients. |

The installed skill is the repo-specific variant of `skills/moxie-docs/SKILL.md`: identical workflow, with your `owner/name` baked in so multi-repo tokens target the right repository. Everything Moxie Docs writes is deterministic and contains no volatile data — live conventions and commands always come from the MCP server, not the committed file.

---

## Cursor Rules

Moxie Docs publishes native Cursor rule files (`.mdc`) for Cursor AI Agent mode. The canonical rule lives in this repository at `rules/moxie-docs.mdc` and can be added to your repository under `.cursor/rules/moxie-docs.mdc` or imported via cursor.directory.

---

## Use as a library

The package also exports the open-source MCP **interface** — the backend-independent contract — so you can build tooling against Moxie Docs without depending on the private server. It carries no secrets and no server logic.```ts
import {
  moxieMcpTools,            // the tool catalog (names, descriptions, input schemas, annotations)
  moxieMcpPrompts,          // the document-this-change / fix-stale-docs prompt descriptors
  moxieMcpServerInfo,       // { name, version }
  moxieMcpProtocolVersion,  // &quot;2025-06-18&quot;
  moxieMcpCapabilities,
  buildMoxieMcpServerCard,  // full /.well-known/mcp/server-card.json document
  moxieMcpServerCard,       // canonical server card (tools + prompts included)
  moxieMcpPublicMethods,    // [&quot;initialize&quot;, &quot;tools/list&quot;, &quot;prompts/list&quot;, &quot;resources/list&quot;, &quot;resources/read&quot;]
  renderSkillMarkdown,      // ({ repository }) =&gt; the moxie-docs SKILL.md for a repo
  renderAgentsGuidanceBlock,// ({ repository }) =&gt; the AGENTS.md guidance block
  moxieDocsSkillMarkdown,   // the canonical published skill, as a string
  MOXIE_MCP_ENDPOINT,       // &quot;https://moxiedocs.com/api/mcp&quot;
  MOXIE_SITE_URL,
} from &quot;moxie-docs&quot;;

What it does not include: the tool handlers, the indexing/doc-generation pipeline, AI/vector-search, the database layer, or token storage — those remain in the hosted Moxie Docs service.


Find the server

Moxie Docs is listed for MCP clients and directories under these names:

Where Identifier / link
Official MCP Registry io.github.Jackalope-Dev/moxie-docs — search for moxie-docs
Smithery smithery.ai/servers/jackalope-digital/moxie-docs (badge above)
Glama glama.ai/mcp/servers/Jackalope-Dev/Moxie-Docs-MCP
LobeHub Marketplace lobehub.com/mcp/jackalope-dev-moxie-docs-mcp
npm CLI moxie-docs — npx moxie-docs setup

Machine-readable registry metadata for the hosted endpoint is in server.json in this repo.

Discovery endpoints

Moxie Docs publishes a small machine-discoverable surface so agents and crawlers can find the server:

Endpoint What it serves
/.well-known/mcp/server-card.json MCP server card: serverInfo, protocol version, transport, capabilities, full tools/prompts catalogs, and publicMethods (unauthenticated listing).
/.well-known/api-catalog RFC 9727 catalog linking to the server card and human docs.
/.well-known/agent-skills/index.json Agent Skills discovery index (skills + SHA-256 digests).
/.well-known/agent-skills/moxie-docs/SKILL.md The published moxie-docs skill.
/.well-known/oauth-protected-resource OAuth protected-resource metadata (RFC 9728).
/.well-known/oauth-authorization-server OAuth authorization-server metadata (RFC 8414).

License

MIT © Jackalope Dev. The contents of this repository (documentation, skill files, and templates) are open source. The hosted Moxie Docs service, indexing pipeline, and generated documentation are not part of this repository.

常见问题

8 问
答案由本站依据条目字段整理,不引用上游原文
Moxie Docs 怎么安装?

在客户端按下面的安装命令接入:npx moxie-docs setup。对应的包名是 moxie-docs。装完在客户端配置里引用同一个包或端点。

Moxie Docs 怎么在 Claude、Cursor、VS Code 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

Moxie Docs 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

Moxie Docs 需要 API Key 吗?

资料标注需要OAuth 授权认证,使用前准备好对应凭据,并按最小权限配置。

Moxie Docs 支持哪些客户端?

资料标注支持 Claude、Cursor、VS Code、Windsurf、Codex、Zed;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

Moxie Docs 能提供哪些能力?

资料显示能力标签包括 developer tools、documentation、github、ai context、code analysis、mcp server。具体工具清单以官方文档为准。

Moxie Docs 需要什么运行环境?

运行时为 node;属于本地进程,需要在本机装好运行环境。

Moxie Docs 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 未标注。