Moxie Docs について
Moxie DocsはGitHubリポジトリをインデックス化し、ドキュメントの生成・維持、規約の発見、文書の不足や陳腐化の検出を行います。MCPサーバーはコーディングエージェントに出典付きのリポジトリ情報を提供し、CLIとスキルで導入を支援します。
主な機能
- 01リポジトリ文書の生成と維持
- 02コーディング規約の検出
- 03文書の不足や陳腐化の発見
- 04文書とリポジトリ情報の検索
- 05ブランチ向け文書変更の提案
- 06CLIによる設定とエージェントスキル
活用シーン
- 01編集前にエージェントへリポジトリ情報を提供
- 02変更に関係する古い文書や不足文書を確認
- 03変更ファイルに関係する規約を検索
- 04プルリクエストで文書更新を提案
MCP 対応
ホスト型MCPサーバーは、リポジトリ情報、文書検索、レビュー用ツール、プロンプト、ファイル変更の提案を提供します。リポジトリを直接編集・マージせず、Streamable HTTPでOAuthまたはBearerトークンを使って接続します。
設定
リモートサーバーはインストール不要です。クライアントを選んで設定をコピーするか、ワンクリックで導入できます。
https://moxiedocs.com/api/mcpclaude mcp add --transport http moxie-docs https://moxiedocs.com/api/mcp{"mcpServers":{"moxie-docs":{"type":"http","url":"https://moxiedocs.com/api/mcp"}}}Cursor で開く{"servers":{"moxie-docs":{"type":"http","url":"https://moxiedocs.com/api/mcp"}}}VS Code で開く{"mcpServers":{"moxie-docs":{"type":"http","url":"https://moxiedocs.com/api/mcp"}}}{"mcpServers":{"moxie-docs":{"serverUrl":"https://moxiedocs.com/api/mcp"}}}コマンドはターミナルで実行し、JSON は各クライアントの MCP 設定に貼り付けて再起動します。認可が必要なサーバーは初回接続時にログインを求めます。
ツール
12| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
| repository | string | いいえ | 対象リポジトリ。形式は "owner/name"(例:"acme/app")です。トークンの対象が単一のリポジトリのみでない限り、必ず指定してください。一致判定では大文字と小文字を区別しません。トークンが複数のリポジトリに対応している場合に省略すると、回答の代わりに選択可能なリポジトリの一覧が返されます。 |
| category | string | いいえ | 任意のカテゴリフィルター(例:testing、structure、docs、review)。 |
詳細
Moxie Docs — MCP とエージェントツール
Moxie Docs の Model Context Protocol(MCP)サーバー、Moxie Docs がリポジトリにインストールするエージェント スキル、そしてすべてを連携させる moxie-docs CLI — npx moxie-docs setup。
このリポジトリは、インポートして利用できるセットアップ CLI と MCP インターフェース(ツールカタログ、プロンプト、サーバーメタデータ、スキルレンダラー)を提供する、moxie-docs npm パッケージのオープンソース版でもあります。ホスト型サーバー、インデックス作成パイプライン、生成されたドキュメントは、非公開の Moxie Docs サービスに保存されます。
Moxie Docs は接続された GitHub リポジトリにインデックスを作成し、ドキュメントを常に最新の状態に保ちます。ドキュメントを生成し、規約を見つけ、ドキュメントの不足や乖離を追跡し、コードとドキュメントを同期させるプルリクエストを作成します。MCP サーバーは、この継続的に更新されるコンテキストをコーディングエージェント(Claude Code、Cursor、VS Code、Codex、およびMCP対応のあらゆるクライアント)に提供します。これにより、エージェントは あなたの リポジトリで実際に使われている方法を踏まえて作業し、コードの変更に合わせてドキュメントも最新の状態に保ちます。
- ウェブサイト/ダッシュボード: https://moxiedocs.com
- MCP サーバーのユーザー向けドキュメント: https://moxiedocs.com/mcp
- MCP エンドポイント:
https://moxiedocs.com/api/mcp
このリポジトリには、ドキュメントと配布用アセットのみが含まれています。ホスト型サーバー、インデックス作成パイプライン、および各リポジトリのドキュメントはここには保存されません。
目次
クイックスタート
最も手早く始めるには、リポジトリのディレクトリで次を実行します。
npx moxie-docs setup
ブラウザーでの OAuth によるサインイン、エディター向け MCP 設定の書き込み、moxie-docs スキルと AGENTS.md のガイダンスのインストール、接続の確認が行われます。その後、エージェントは編集前に moxie.get_ai_context で最新のコンテキストを読み込み、同じ PR に含まれるドキュメントの更新を提案します。
手動で設定する場合は、https://moxiedocs.com でリポジトリを接続してから、設定ブロックを使ってエージェントにサーバーを追加してください。
CLI
moxie-docs CLI(Node ≥ 18、ランタイム依存関係ゼロ)は、接続をセットアップして管理します。npx moxie-docs <command> で実行するか、グローバルにインストールしてください(npm i -g moxie-docs)。
| コマンド | 機能 |
|---|---|
moxie-docs setup | エンドツーエンドでセットアップします。サインインし、MCP クライアントを設定し、スキルと AGENTS.md ブロックをインストールして、スモークテストを実行します。 |
moxie-docs login | ブラウザー経由でサインインし(OAuth 2.1 + PKCE)、認証情報を ~/.moxie-docs/ に保存します。 |
moxie-docs status | スコープ、接続済みリポジトリ、利用可能なツールの数を表示します。 |
moxie-docs config <client> | クライアント設定(claude-code、cursor、vscode)に moxie-docs サーバーエントリーを書き込みます。 |
moxie-docs install-skill | moxie-docs スキルと AGENTS.md のガイダンスを現在のリポジトリにインストールします。 |
moxie-docs logout | 保存済みの認証情報を削除します。 |
便利なフラグ:--client <name>、--token <dashboard-token>、--repo owner/name、--no-browser、--yes。
認証情報の書き込み方法。 デフォルトでは、setup/config はURL のみのサーバーエントリーを書き込み、初回使用時にエディター自身が OAuth サインインを実行します。そのため、コミットした設定の有効期限が切れることはありません。CLI 自体によるブラウザーサインイン(status とセットアップのスモークテストで使用)は、短期間有効なトークンとリフレッシュトークンを ~/.moxie-docs/ に保存します(ファイルモード 0600)。これらがクライアント設定に書き込まれることはありません。静的な Authorization ヘッダーを固定したい場合は、長期間有効なダッシュボードトークンを --token で渡すと、CLI は代わりにそのトークンを書き込みます。CLI がトークン値をログに記録することはありません。また、他の MCP サーバーを破棄することのないよう、安全に解析できないクライアント設定の上書きは拒否します。
MCP サーバー
接続
| トランスポート | Streamable HTTP MCP |
| エンドポイント | https://moxiedocs.com/api/mcp |
| プロトコルバージョン | 2025-06-18 |
| リポジトリの選択 | ツールでは省略可能な repository 引数(owner/name、例:acme/app)を受け付けます。トークンが複数のリポジトリに対応し、単一のデフォルトが適用されない場合に限り必須です。一致判定では大文字と小文字を区別しません。 |
すべての書き込みツールは提案として動作します。Moxie Docs は、ファイルパスと内容を返し、あなた(エージェント)が自身のブランチに書き込みます。Moxie Docs が MCP 経由でリポジトリを直接編集したり、マージしたりすることはありません。読み取りでは、生のコードダンプではなく、引用情報に裏付けられた簡潔なコンテキストを返します。
認証
Bearer トークン(現在利用可能)。 ダッシュボードでトークンを作成し、ヘッダーとして送信します。
Authorization: Bearer <MOXIE_TOKEN>
Moxie Docs が保存するのは、トークンのハッシュ(表示できるよう暗号化したコピーも保存します)、プレフィックス、スコープ、最終使用日時のみです。ダッシュボードからいつでもトークンを表示、ローテーション、または取り消せます。
OAuth 2.1 サインイン(対応クライアント向け)。 OAuth 認可フローを実装している MCP クライアントは、トークンを貼り付ける代わりに、ブラウザーからサインインして接続できます。クライアントはサーバーの OAuth メタデータを検出し、自身を動的に登録して(RFC 7591)、認可コード + PKCE フローでトークンを取得します。ディスカバリー文書:
- 保護対象リソースのメタデータ:
https://moxiedocs.com/.well-known/oauth-protected-resource - 認可サーバーのメタデータ:
https://moxiedocs.com/.well-known/oauth-authorization-server
どちらの認証方法でも同じトークンモデルが使用されるため、同じツールでどちらも利用できます。接続済みアプリケーションは、ダッシュボードで確認して取り消せます。
クライアント設定
ほとんどのエージェントは、URL とヘッダーを指定したリモート MCP サーバーを受け付けます。<MOXIE_TOKEN> をダッシュボードのトークンに置き換えてください。
Claude Code — .mcp.json(または claude mcp add):
{
"mcpServers": {
"moxie-docs": {
"url": "https://moxiedocs.com/api/mcp",
"headers": {
"Authorization": "Bearer <MOXIE_TOKEN>"
}
}
}
}
Cursor — .cursor/mcp.json:
{
"mcpServers": {
"moxie-docs": {
"url": "https://moxiedocs.com/api/mcp",
"headers": { "Authorization": "Bearer <MOXIE_TOKEN>" }
}
}
}
VS Code — .vscode/mcp.json:
{
"servers": {
"moxie-docs": {
"type": "http",
"url": "https://moxiedocs.com/api/mcp",
"headers": { "Authorization": "Bearer <MOXIE_TOKEN>" }
}
}
}
トークンをソース管理に含めないでください。クライアントが対応している場合は環境変数を参照するか、ローカルの未追跡設定にのみトークンを貼り付けてください。
ツール
moxie.get_ai_context:編集前の簡潔なブリーフィングです。リポジトリの状態、検証済みのコマンド、主要な規約、未解決の課題、チームのメモを確認できます。まずこれを読みます。moxie.get_doc_impact:変更予定のパス(削除するパスも含む)を指定すると、それらと根拠が重なる規約、課題、既存ドキュメントを返します。moxie.get_api_context:操作する予定のパスを指定すると、それらに対応する API エンドポイントの構造化コンテキスト(メソッド、パス、スキーマ、既知の利用者)を返します。moxie.review_change:PR を作成する前に変更を自己レビューします。規約違反、古くなったドキュメント、未文書化の機能、壊れた参照を深刻度順に一覧表示します。moxie.get_conventions:発見されたコーディング規約をカテゴリ別にまとめ、信頼度スコア、エージェント向けガイダンス、ソースファイルの引用とともに返します。moxie.search_docs:生成されたドキュメント、規約、課題、AI コンテキストを対象に、セマンティック検索とキーワード検索を行います。moxie.get_doc_gaps:深刻度と関連するパスを含む、未解決のドキュメント課題を返します。moxie.get_documentation_opportunities:不足しているドキュメント、差分の修正、PR テンプレートなど、推奨されるドキュメント作業を返します。moxie.get_documentation_patterns:リポジトリのドキュメントの構成と管理方法(新しいドキュメントの配置場所)を示します。moxie.list_docs:生成されたすべてのドキュメントの目次を、セクションごとにまとめてページ分割して返します。moxie.propose_doc_update:現在の変更にドキュメントの追加または更新を含めます。ブランチに書き込む対象パスと Markdown を返します。moxie.propose_doc_removal:変更によって不要になった、Moxie Docs が追跡するドキュメントを削除します。ブランチで削除するパスを返します。
| ツール | 目的 |
|---|---|
moxie.get_ai_context | 編集前の簡潔なブリーフィングです。リポジトリの状態、検証済みのコマンド、主要な規約、未解決の課題、チームのメモを確認できます。まずこれを読みます。 |
moxie.get_doc_impact | 変更予定のパス(削除するパスも含む)を指定すると、それらと根拠が重なる規約、課題、既存ドキュメントを返し、新規または未文書化の機能に警告します。 |
moxie.get_api_context | 操作する予定のパスを指定すると、それらに対応する API エンドポイントの構造化コンテキスト(メソッド、パス、スキーマ、既知の利用者や機能)を返します。 |
moxie.review_change | PR を作成する前に変更を自己レビューします。規約違反、古くなったドキュメント、未文書化の機能、壊れた参照について、深刻度順の判定(問題なし/警告/要修正)を返します。 |
moxie.get_conventions | 発見されたコーディング規約をカテゴリ別にまとめ、信頼度スコア、エージェント向けガイダンス、ソースファイルの引用とともに返します。 |
moxie.search_docs | 生成されたドキュメント、規約、課題、AI コンテキストを対象に、セマンティック検索とキーワード検索を行います。 |
moxie.get_doc_gaps | 深刻度と関連するパスを含む、未解決のドキュメント課題を返します。 |
moxie.get_documentation_opportunities | 不足しているドキュメント、差分の修正、PR テンプレートなど、推奨されるドキュメント作業を返します。 |
moxie.get_documentation_patterns | リポジトリのドキュメントの構成と管理方法(新しいドキュメントの配置場所)を示します。 |
moxie.list_docs | 生成されたすべてのドキュメントの目次を、セクションごとにまとめてページ分割して返します。 |
moxie.propose_doc_update | 現在の変更にドキュメントの追加または更新を含めます。ブランチに書き込む対象パスと Markdown を返します。 |
moxie.propose_doc_removal | 変更によって不要になった、Moxie Docs が追跡するドキュメントを削除します。ブランチで削除するパスを返します。 |
プロンプト
サーバーは、一般的なワークフローを自動化する MCP プロンプトも公開しています。
| プロンプト | 目的 |
|---|---|
document-this-change | 変更したパスのドキュメント影響を確認し、同じ PR にドキュメントの更新を含めるための提案手順を案内します。 |
fix-stale-docs | リポジトリ内の未解決のドキュメント課題と差分の修正機会を見つけ、Moxie Docs を通じて修正します。 |
review-before-finalize | PR を作成する前に、Moxie Docs のガードレールで差分を確認し、規約違反、古くなったドキュメント、未文書化の機能、壊れた参照を検出します。 |
Claude plugin
Claude Code と Claude Cowork では、このリポジトリはプラグインマーケットプレイスとしても機能します。Moxie Docs コネクターとスキルをまとめて追加できるワンコマンド方式です。プラグインには次のものが含まれます。
moxie-docsMCP サーバー(上記のリモートエンドポイント)。初回使用時にクライアントが独自のOAuth サインインを実行するよう設定されているため、トークンを貼り付けたりコミットしたりする必要はありません。moxie-docsスキル。プラグインをインストールした時点で、編集してからドキュメント化するワークフローを利用できます。
Claude Code(または Cowork)内からインストールします。
/plugin marketplace add Jackalope-Dev/Moxie-Docs-MCP
/plugin install moxie-docs@moxie-docs
最初のコマンドでこのリポジトリをマーケットプレイスとして登録し、2つ目のコマンドでそこから moxie-docs プラグインをインストールします。Moxie Docs ツールを初めて使用すると、クライアントがブラウザーを開いてサインインします。その後、上記のツールとプロンプトを利用できます。後で更新するには /plugin marketplace update moxie-docs を実行し、削除するには /plugin uninstall moxie-docs@moxie-docs を実行します。
静的トークンを使用したい場合や、プラグインに対応していないクライアントを使用する場合は、クライアント設定のブロックかCLIを使用してください。プラグイン、CLI、手書きの設定は、いずれも同じサーバーと同じ認証モデルを使用します。
プラグインのマニフェストは .claude-plugin/ に、サーバーのエントリは .mcp.json にあります。
スキル
Agent Skillsは、エージェントに機能をいつ、どのように使用するかを教える、小規模でトリガー式の指示ファイルです。Moxie Docs は、エージェントを編集してからドキュメント化するワークフローに接続する moxie-docs スキルを公開しています。
moxie-docs スキル
正規のスキルは、このリポジトリの skills/moxie-docs/SKILL.md にあり、SHA-256 ダイジェストとともにウェブサイトでも次の場所から提供されています。
https://moxiedocs.com/.well-known/agent-skills/moxie-docs/SKILL.md
このスキルは、編集前に最新のコンテキスト(get_ai_context、get_doc_impact)を読み、リポジトリで実際に使われている規約と検証済みのコマンドに従い、コード変更と同じ PRで反映するドキュメントの更新や削除を提案するようエージェントに指示します。水増しのためのドキュメントをでっち上げることはありません。
Moxie Docs がリポジトリにインストールするもの
Moxie Docs がリポジトリに接続すると、次の3つの自己修復型で決定的なファイルを追加する 「Add Moxie Docs agent guidance」 PR を1つ作成します。これらのファイルは、内容に差異が生じた場合、またはリポジトリ名が変更された場合にのみ再生成され、インデックス作成のたびに不要な変更が発生することはありません。
| ファイル | 目的 |
|---|---|
AGENTS.md | どのエージェントにも MCP サーバーと moxie-docs スキルを使うよう伝える、常時有効な短いポインターブロック(/ マーカーの間に配置)。マーカーの外に人が追加した内容は保持されます。templates/AGENTS.mdを参照してください。 |
.claude/skills/moxie-docs/SKILL.md | Claude Code 用の、リポジトリ固有の moxie-docs スキルです。 |
.agents/skills/moxie-docs/SKILL.md | .agents 対応クライアント用の同じスキルです。 |
インストールされるスキルは、skills/moxie-docs/SKILL.mdのリポジトリ固有版です。ワークフローは同一ですが、複数リポジトリ用のトークンが正しいリポジトリを対象にできるよう、owner/name が組み込まれています。Moxie Docs が書き込む内容はすべて決定的で、変動するデータは含まれません。最新の規約やコマンドは常にコミット済みファイルではなく、MCP サーバーから取得されます。
Cursor Rules
Moxie Docs は、Cursor の AI Agent モード向けに、ネイティブの Cursor ルールファイル(.mdc)を公開しています。正規のルールはこのリポジトリの rules/moxie-docs.mdc にあり、リポジトリの .cursor/rules/moxie-docs.mdc に追加するか、cursor.directory からインポートできます。
ライブラリとして使用する
このパッケージは、オープンソースの MCP インターフェース(バックエンドに依存しない契約)もエクスポートするため、プライベートサーバーに依存せずに Moxie Docs 用のツールを構築できます。シークレットやサーバーロジックは含まれていません。
import {
moxieMcpTools, // the tool catalog (names, descriptions, input schemas, annotations)
moxieMcpPrompts, // the document-this-change / fix-stale-docs prompt descriptors
moxieMcpServerInfo, // { name, version }
moxieMcpProtocolVersion, // "2025-06-18"
moxieMcpCapabilities,
buildMoxieMcpServerCard, // full /.well-known/mcp/server-card.json document
moxieMcpServerCard, // canonical server card (tools + prompts included)
moxieMcpPublicMethods, // ["initialize", "tools/list", "prompts/list", "resources/list", "resources/read"]
renderSkillMarkdown, // ({ repository }) => the moxie-docs SKILL.md for a repo
renderAgentsGuidanceBlock,// ({ repository }) => the AGENTS.md guidance block
moxieDocsSkillMarkdown, // the canonical published skill, as a string
MOXIE_MCP_ENDPOINT, // "https://moxiedocs.com/api/mcp"
MOXIE_SITE_URL,
} from "moxie-docs";
含まれないもの:ツールハンドラー、インデックス作成/ドキュメント生成パイプライン、AI/ベクトル検索、データベース層、トークンストレージ。これらは引き続きホスト型 Moxie Docs サービスに含まれます。
サーバーを見つける
Moxie Docs は、MCP クライアントやディレクトリに以下の名前で掲載されています。
| 場所 | 識別子/リンク |
|---|---|
| 公式 MCP Registry | io.github.Jackalope-Dev/moxie-docs — moxie-docs を検索 |
| Smithery | smithery.ai/servers/jackalope-digital/moxie-docs(上のバッジ) |
| 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 |
ホスト型エンドポイントの機械可読なレジストリメタデータは、このリポジトリの server.json にあります。
検出用エンドポイント
Moxie Docs は、エージェントやクローラーがサーバーを見つけられるよう、小規模な機械検出可能なインターフェースを公開しています。
| エンドポイント | 提供する内容 |
|---|---|
/.well-known/mcp/server-card.json | MCP サーバーカード:serverInfo、プロトコルバージョン、トランスポート、機能、tools/prompts の全カタログ、および publicMethods(認証不要の一覧)。 |
/.well-known/api-catalog | サーバーカードと人間向けドキュメントへのリンクを含む RFC 9727 カタログ。 |
/.well-known/agent-skills/index.json | Agent Skills 検出インデックス(スキルと SHA-256 ダイジェスト)。 |
/.well-known/agent-skills/moxie-docs/SKILL.md | 公開されている moxie-docs スキル。 |
/.well-known/oauth-protected-resource | OAuth 保護リソースのメタデータ(RFC 9728)。 |
/.well-known/oauth-authorization-server | OAuth 認可サーバーのメタデータ(RFC 8414)。 |
ライセンス
MIT © Jackalope Dev。このリポジトリの内容(ドキュメント、スキルファイル、テンプレート)はオープンソースです。ホスト型 Moxie Docs サービス、インデックス作成パイプライン、生成されたドキュメントは、このリポジトリには含まれません。
コメント
AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。