Sumi Docs

Englisch | 简体中文

Sumi Docs veröffentlicht ein einziges, geprüftes Dokumentationskorpus für zwei Zielgruppen:

• Menschen durchsuchen eine Astro- und Starlight-Website;

• Agenten fragen dasselbe Korpus über einen schreibgeschützten MCP-Server ab.

Der geprüfte docs/-Baum und der Inhaltskatalog sind die semantische Quelle der Wahrheit. Die Website und der MCP-Server sind unabhängig adressierbare Projektionen; ein Agenten-Host ist der MCP-Client.

Das Quellrepository und die Dokumentationswebsite sind öffentlich und werden aktiv weiterentwickelt. Es wurde kein npm-Paket, kein getaggtes GitHub-Release und keine unterstützte Binärdatei veröffentlicht.

Voraussetzungen

• Node.js 25.5.0 oder neuer

• pnpm 10.26.0 über Corepack oder die in packageManager deklarierte Version

• ein vertrauenswürdiger Checkout beim Laden der Agenten-Host-Konfiguration des Repositorys

Related MCP server: mcp-docs

Erster Start

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

Der Doktor meldet projektrelative Pfade oder externe Platzhalter standardmäßig. Fügen Sie --show-paths nur für die lokale Diagnose hinzu; hängen Sie diese Ausgabe nicht an öffentliche Issues oder Build-Artefakte an.

Die eingecheckte sumi-docs.config.json wählt das Wurzelverzeichnis docs/ und das Beispiel- OpenAPI-Dokument aus. Starten Sie die menschliche Website mit:

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

Öffnen Sie http://127.0.0.1:4321. Codex-, Claude-Code- und VS-Code-Projektadapter werden in Agenten-Host-Integration beschrieben. Sie exponieren die vier MCP-Tools, ohne dass der optionale Maintainer erforderlich ist.

Um dasselbe Korpus über einen Loopback-Streamable-HTTP-Endpunkt zu exponieren:

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

Verbinden Sie einen kompatiblen MCP-Client mit http://127.0.0.1:3000/mcp. Die statische Website und die _mcp-Korpusprojektion führen diesen Endpunkt nicht selbst aus.

Für einen gehärteten lokalen Container, der dasselbe geprüfte Wurzelkorpus verwendet:

docker compose up --build

Der Dienst exponiert MCP unter http://localhost:3000/mcp, den Livness-Check unter /healthz und die Korpusbereitschaft unter /readyz. Docker ist für die Quellentwicklung optional; für die öffentliche Bereitstellung sind weiterhin HTTPS-Terminierung und eine explizite Host-Richtlinie erforderlich.

Das Repository bietet außerdem drei optionale Projekt-Workflows unter .agents/skills/: $sumi-docs-use für Einrichtung und Betrieb, $sumi-docs-pr für Vorschlag und Pull-Request-Vorbereitung sowie $sumi-docs-audit für schreibgeschützte, evidenzgebundene Repository- und Release-Prüfungen. Sie lenken die Arbeit, ersetzen aber weder MCP noch veröffentlichen sie Remote-Änderungen.

Arbeitsbereich

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

Der lokale Betrieb und die reine Pages-Veröffentlichung erfordern keine Laufzeit- Geheimnisse. SITE_URL wird nur für eine Release-Kandidaten-Site benötigt. Die Aktivierung des optionalen Produktions-Streamable-HTTP-Dienstes erfordert geprüfte Endpunkt- Variablen und SSH-Material in der geschützten production-mcp-Umgebung. Der Container akzeptiert dokumentierte SUMI_DOCS_*-Bereitstellungsvariablen; generierte Ausgaben, lokaler Zustand, Logs, Caches und .env-Dateien bleiben ignoriert.

Paketspezifische Anweisungen verbleiben in jedem Arbeitsbereich. Aktive Architektur- entscheidungen liegen im docs/decisions/-Verzeichnis des jeweiligen Arbeitsbereichs; das Wurzel- Handbuch stellt ihre benutzerorientierten Konsequenzen dar, ohne die Entscheidungsdatensätze zu duplizieren.

Quelle und Site-Sichtbarkeit veröffentlichen weder ein Paket, einen Tag noch eine Binärdatei. Diese Artefakte unterliegen weiterhin den dokumentierten Release-Pforten.