Buckets:
| Name | Size | Uploaded | Xet hash |
|---|---|---|---|
| Sources | 7 items | ||
| Tests | 12 items | ||
| AGENTS.md | 4.96 kB xet | 3921fd12 | |
| ARCHITECTURE.md | 4.38 kB xet | 1fb80e4d | |
| Package.swift | 1 kB xet | 7aac1b91 | |
| README.md | 6.01 kB xet | c8b12637 | |
| SSK_DocGen_Manual_Testing_Guide.md | 10.3 kB xet | a77f9564 |
SSK_DocGen
Status: P0 and P1 source and configuration are implemented. Manual Xcode verification is not run.
See SSK_DocGen Phase and Priority Roadmap for the complete phase matrix, priority specifications, and capability roadmap.
1. Module Role and Topology
SSK_DocGen is the private documentation generator and resource worker for SovereignSurvivalKit. It is not the external Xcode MCP entry point.
Xcode has one external MCP entry point:
SSK_StorageHost acp-agent
The request path is:
Xcode or Approved MCP Client
│ (stdio)
▼
SSK_StorageHost acp-agent (External MCP Facade)
│ (com.ssk.vaulthost Mach XPC)
▼
SSKVaultHost Daemon (Validates Audit Token & Code Signature)
│ (Private Worker Process)
▼
SSK_DocGen (Isolated Resource Worker)
│ (Descriptor-Relative Read)
▼
Approved Documentation Ledger (SSK_Ledger_Vault)
The commerce tools in SSK_StorageHost acp-agent remain unchanged. DocGen adds documentation resources and maintenance tools.
2. P0 and P1 User Capabilities
An approved local MCP client can discover and read documentation resources:
| Resource | Logical URI | MIME Type |
|---|---|---|
| DocC Index | ssk://spec:SSK-DocGen-P0/ledger/documentation/docc-index |
application/json |
| Codebase Graph | ssk://spec:SSK-DocGen-P0/ledger/documentation/codebase-graph |
application/json |
| Documentation Index | ssk://spec:SSK-DocGen-P0/ledger/documentation/master-index |
text/markdown |
| Refresh Status | ssk://spec:SSK-DocGen-P1/ledger/documentation/status |
application/json |
P1 adds documentation refresh and status query tools to SSK_StorageHost acp-agent:
refresh_docs: Triggers background documentation rescanning and updates the ledger in isolated staging.get_docgen_status: Returns current state (queued,running,ready, orfailed) and process metrics.
The client does not provide a file path, executable path, workspace path, or vault path. SSKVaultHost stores operator-approved roots in secure configuration. The daemon reads this configuration and starts the private worker.
3. Phase Summary
| Phase | Priority Level | User Capability | Status |
|---|---|---|---|
| P0 | Critical | Read approved local documentation resources via SSK_StorageHost acp-agent. |
Implemented, not verified |
| P1 | High | Request local documentation refresh and query status. | Implemented, not verified |
| P2 | Medium | Review proposed documentation changes and approve or reject before publication. | Planned. Not available in P1. |
| P3 | Low | Read approved documentation from enrolled peer mesh devices. | Planned. Not available in P1. |
4. Xcode Setup
Use the SSKVaultHost scheme to prepare the local daemon:
- Create an isolated workspace directory and an isolated vault directory.
- In the
SSKVaultHostRun scheme, setSSK_DOCGEN_WORKSPACEto the absolute workspace directory. - Set
SSK_DOCGEN_VAULTto the absolute vault directory. - Build and run
SSKVaultHost. - Confirm that the application contains
SSK_StorageHost,SSK_DocGen, andContents/Library/LaunchAgents/com.ssk.vaulthost.plist. - Confirm that the launch agent is registered or approve it when macOS requests permission.
- Build and install
XCPSSKPlugin, or use/usr/local/bin/SSK_StorageHost. - Configure the MCP command in Xcode as
SSK_StorageHost acp-agent.
Do not configure Xcode to start
SSK_DocGen servedirectly.
See SSK_DocGen_Manual_Testing_Guide.md for the complete manual procedure.
5. Private Worker Commands
SSK_DocGen provides two internal engineering commands:
SSK_DocGen generate --vault <path> [--workspace <path>] [--clean|--no-clean]
SSK_DocGen serve [--vault <path>] [--workspace <path>]
generatebuilds ledger artifacts. It requires--vault. Do not use a shared or production vault for a test.serveis a private worker protocol mode. The host starts it with trusted configuration. It receives JSON-RPC requests on standard input and writes protocol responses to standard output. Diagnostics go to standard error.
6. Security Boundaries
SSK_StorageHost acp-agentowns MCP standard input and standard output.- The MCP facade accepts only fixed logical DocGen URIs.
- The named XPC route uses typed, versioned
DocGenHostCommandmessages. - The XPC listener verifies the audit token and Apple code signature before exporting the service.
SSKVaultHostpersists approved roots in an owner-only directory and configuration file.- The daemon resolves approved roots and the bundled worker. Clients cannot select them.
- Child-process input, output, diagnostics, duration, and response counts are bounded.
- The resource reader uses descriptor-relative access, no-symlink checks, regular-file checks, and bounded reads.
- Content is redacted in the worker and again at the external MCP boundary.
- Errors never return local file paths, private keys, claims, or credentials.
7. Development and Testing Rules
- Use
SSK_DocGenTestsfor private worker and resource-reader tests. - Use
SSK_AbstractionsTestsfor typed resource and command model tests. - Use
SSK_FoundationTestsfor process launcher and XPC route tests. - Use
SSK_ProvidersTestsfor secure configuration store and MCP facade tests. - Use
SSKVaultHostandXCPSSKPluginschemes for bundle and lifecycle checks. - Do not claim that an Xcode test passed without the attached Xcode result.
- Do not add a second Xcode agent, daemon, Mach service, or DocGen network server.
- Do not make
SSK_ProvidersimportSSK_Orchestrator. - Do not use
git. This workspace useslorefor version control.
- Total size
- 1.06 GB
- Files
- 1,825
- Last updated
- Sep 19
- Pre-warmed CDN
- US EU US EU