Sumi Docs

English | 简体中文

Sumi Docs は、2つの利用者向けに1つのレビュー済みドキュメントコーパスを公開します：

• 人は Astro と Starlight の Web サイトを閲覧します；

• エージェントは読み取り専用の MCP サーバーを通じて同じコーパスを照会します。

レビュー済みのルート docs/ ツリーとコンテンツカタログが、意味的な真実の源泉です。 Web サイトと MCP サーバーは、独立してアドレス指定可能なプロジェクションです； エージェントホストが MCP クライアントです。

ソースリポジトリ と ドキュメントサイト は公開されており、 活発に開発が進められています。npm パッケージ、タグ付き GitHub リリース、サポート対象の バイナリはまだ公開されていません。

前提条件

• Node.js 25.5.0 以降

• Corepack 経由の pnpm 10.26.0、または packageManager で宣言されたバージョン

• リポジトリ提供のエージェントホスト設定を読み込む際の、信頼できるチェックアウト

Related MCP server: mcp-docs

初回実行

pnpm install --frozen-lockfile
pnpm run build
node packages/mcp/dist/index.js doctor --json

Doctor は、デフォルトでプロジェクト相対パスまたは外部プレースホルダーを報告します。 ローカル診断の場合にのみ --show-paths を追加してください。その出力を 公開 issue やビルド成果物に添付しないでください。

チェックイン済みの sumi-docs.config.json は、ルート docs/ とサンプルの OpenAPI ドキュメントを選択します。人間向けサイトは次のコマンドで開始します：

pnpm --filter @sumi-os/docs-web dev

http://127.0.0.1:4321 を開きます。Codex、Claude Code、VS Code のプロジェクトアダプターは エージェントホスト統合 に記載されています。これらは、 オプションのメンテナー向け Skill を必要とせずに、4つの MCP ツールを公開します。

同じコーパスをループバックの Streamable HTTP エンドポイントで公開するには：

node packages/mcp/dist/index.js serve --transport streamable-http

互換性のある MCP クライアントを http://127.0.0.1:3000/mcp に接続します。静的 Web サイトと _mcp コーパスプロジェクションは、それ自体ではこのエンドポイントを実行しません。

同じレビュー済みルートコーパスを使用する、堅牢化されたローカルコンテナの場合：

docker compose up --build

このサービスは、http://localhost:3000/mcp で MCP を公開し、/healthz で 死活監視を、/readyz でコーパスの準備状態を公開します。Docker はソース開発には オプションです。本番デプロイでは、HTTPS 終端と明示的な Host ポリシーが依然として必要です。

リポジトリは、.agents/skills/ の下に3つのオプションのプロジェクトワークフローも提供します： セットアップと操作のための $sumi-docs-use、提案とプルリクエスト準備のための $sumi-docs-pr、 読み取り専用で証拠に基づくリポジトリおよびリリース監査のための $sumi-docs-audit。 これらは作業を誘導しますが、MCP を置き換えるものではなく、リモートの変更を公開するものでもありません。

ワークスペース

apps/web/                   Astro/Starlight site and corpus publisher
packages/mcp/               stdio and Streamable HTTP MCP server and CLI
packages/corpus-contract/   manifest schemas and conformance fixtures
docs/                       product handbook and default corpus
.agents/skills/             optional project usage and contribution workflows

ローカル操作とデフォルトの Pages のみの公開には、実行時 シークレットは不要です。SITE_URL は、リリース候補サイトの場合にのみ必要です。 オプションの本番 Streamable HTTP サービスを有効にするには、レビュー済みの 変数と SSH 素材が保護された production-mcp 環境に必要です。この コンテナは、文書化された SUMI_DOCS_* デプロイ変数を受け入れます。生成された 出力、ローカル状態、ログ、キャッシュ、および .env ファイルは無視されます。

パッケージ固有の手順は、各ワークスペースに残ります。アクティブなアーキテクチャ 決定は、所有ワークスペースの docs/decisions/ ディレクトリにあります。ルート ハンドブックは、決定記録を複製することなく、ユーザー向けの影響を提示します。

ソースとサイトの可視性は、タグ、パッケージ、バイナリを公開しません。これらの 成果物は、文書化されたリリースゲートの対象のままです。