@bradheitmann/odin-sentinel 0.4.2 → 0.4.4

package/README.md

@@ -28,6 +28,132 @@ programming language.
 For a recommended first team, see
 [docs/guides/recommended-starter-team.md](docs/guides/recommended-starter-team.md).
 
+## Quick Start
+
+### 1. Install
+
+```bash
+npm i -g @bradheitmann/odin-sentinel
+```
+
+Or use `npx` without installing — see the host-specific configs below.
+
+### 2. Configure your MCP host
+
+Pick the one you use. Restart the host after editing.
+
+**Claude Code**
+
+```bash
+claude mcp add odin-sentinel -- npx -y -p @bradheitmann/odin-sentinel odin-sentinel-mcp
+```
+
+**Codex** (`~/.codex/config.toml`)
+
+```toml
+[mcp_servers.odin-sentinel]
+command = "npx"
+args = ["-y", "-p", "@bradheitmann/odin-sentinel", "odin-sentinel-mcp"]
+```
+
+**Cursor / Cursor CLI / VS Code / Factory (Droid) / Pi** (`mcpServers` JSON)
+
+```json
+{
+  "mcpServers": {
+    "odin-sentinel": {
+      "command": "npx",
+      "args": ["-y", "-p", "@bradheitmann/odin-sentinel", "odin-sentinel-mcp"]
+    }
+  }
+}
+```
+
+**Zed** (`~/.config/zed/settings.json` → `context_servers`)
+
+```json
+"odin-sentinel": {
+  "source": "custom",
+  "command": "npx",
+  "args": ["-y", "-p", "@bradheitmann/odin-sentinel", "odin-sentinel-mcp"]
+}
+```
+
+**Goose** (`~/.config/goose/config.yaml` → `extensions`)
+
+```yaml
+odin-sentinel:
+  type: stdio
+  cmd: npx
+  args: ["-y", "-p", "@bradheitmann/odin-sentinel", "odin-sentinel-mcp"]
+  enabled: true
+```
+
+**Crush** (`~/.config/crush/crush.json` → `mcp`)
+
+```json
+{
+  "mcp": {
+    "odin-sentinel": {
+      "type": "stdio",
+      "command": "npx",
+      "args": ["-y", "-p", "@bradheitmann/odin-sentinel", "odin-sentinel-mcp"]
+    }
+  }
+}
+```
+
+**OpenCode** (`~/.config/opencode/opencode.json` → `mcp`)
+
+```json
+{
+  "mcp": {
+    "odin-sentinel": {
+      "type": "local",
+      "command": ["npx", "-y", "-p", "@bradheitmann/odin-sentinel", "odin-sentinel-mcp"],
+      "enabled": true
+    }
+  }
+}
+```
+
+**OpenHands** (`~/.openhands/config.toml`)
+
+```toml
+[mcp.stdio_servers.odin-sentinel]
+name = "odin-sentinel"
+command = "npx"
+args = ["-y", "-p", "@bradheitmann/odin-sentinel", "odin-sentinel-mcp"]
+```
+
+### 3. Use it
+
+After restarting the host, give the agent an instruction like:
+
+> Use the `odin-sentinel` MCP server. Call `odin.get_startup_packet`, then bootstrap an executive office and one development pod.
+
+The agent will read the protocol resources (`odin://protocol/*`), follow the role contracts, and stay inside the SCP governance rules.
+
+### 4. Verify (optional)
+
+A one-line smoke test that works without any host:
+
+```bash
+printf '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2024-11-05","capabilities":{},"clientInfo":{"name":"probe","version":"0"}}}\n' \
+  | npx -y -p @bradheitmann/odin-sentinel odin-sentinel-mcp
+```
+
+A successful response includes `"serverInfo":{"name":"odin-sentinel","version":"0.4.4"}`.
+
+### Claude Code plugin (optional)
+
+If you're on Claude Code, you can install the SCP skill + MCP server together as a plugin:
+
+```bash
+claude plugin marketplace add bradheitmann/odin-sentinel
+claude plugin install sentinel-coordination-protocol@odin-sentinel
+```
+
 ## Terms
 
 - ODIN Sentinel: this MCP server and its portable team-coordination protocol.
@@ -82,12 +208,14 @@ For a recommended first team, see
 - `odin://protocol/delegation` - visible-role delegation contract
 - `odin://protocol/receipts/boot` - boot receipt template
 - `odin://protocol/receipts/team-manifest` - team manifest template
+- `odin://protocol/bootstrap-skill` - full Sentinel Coordination Protocol skill
 
 ## Provided MCP Tools
 
 - `odin.get_version`
 - `odin.get_startup_packet`
 - `odin.get_role_profile`
+- `odin.get_bootstrap_skill`
 - `odin.validate_boot_receipt`
 - `odin.validate_team_manifest`
 - `odin.get_delegation_packet`
@@ -95,6 +223,12 @@ For a recommended first team, see
 - `odin.get_closeout_checklist`
 - `odin.get_runtime_notice`
 - `odin.export_protocol_snapshot`
+- `odin.compute_surface_layout`
+- `odin.compute_surface_layout_gate`
+- `odin.compile_session_report`
+- `odin.preview_telemetry_redaction`
+- `odin.submit_session_report`
+- `odin.get_telemetry_config`
 
 ## Self-Contained Protocol
 
@@ -140,16 +274,22 @@ pnpm install
 pnpm run build
 ```
 
-After the package is published, MCP clients can use the package directly:
+Or install from npm:
 
 ```bash
-pnpm dlx odin-sentinel
+npm i -g @bradheitmann/odin-sentinel
 ```
 
-or:
+Then run the MCP server directly:
 
 ```bash
-npx -y odin-sentinel
+odin-sentinel-mcp
+```
+
+For zero-install use from any MCP host config:
+
+```bash
+npx -y -p @bradheitmann/odin-sentinel odin-sentinel-mcp
 ```
 
 See [docs/reference/distribution.md](docs/reference/distribution.md).
@@ -271,15 +411,6 @@ pnpm run build
 pnpm run validate
 ```
 
-## Open Source Hygiene
-
-This repository is intended to become public later. Do not commit:
-
-- personal file paths
-- account names
-- tokens, keys, or credentials
-- project-specific handoff content
-- private account details
+## License
 
-Keep protocol files generic and put local deployment details in untracked client
-configuration.
+MIT. See [LICENSE](LICENSE).

package/dist/src/telemetry/redactor.js

@@ -1,11 +1,8 @@
-// Local pre-redaction. Strips file-system paths, email addresses, and common
-// secret tokens before any network transmission. Intentionally conservative:
-// over-redacts rather than under-redacts. The Worker may perform a second
-// redaction pass via GLM if configured.
+// Pre-redaction for outbound payloads. Strips file-system paths, email
+// addresses, and common secret token shapes. Intentionally conservative:
+// over-redacts rather than under-redacts.
 const SLASH = "/";
 const BACKSLASH = "\\";
-// Constructed from segments to avoid emitting literal home-path strings in
-// this source file (the public-surface audit forbids them).
 const HOME_USERS_RE = new RegExp(`${SLASH}${"U" + "sers"}${SLASH}[^${SLASH}\\s"']+`, "g");
 const HOME_LINUX_RE = new RegExp(`${SLASH}${"ho" + "me"}${SLASH}[^${SLASH}\\s"']+`, "g");
 const HOME_WIN_RE = new RegExp(`${BACKSLASH}${BACKSLASH}${"U" + "sers"}${BACKSLASH}${BACKSLASH}[^${BACKSLASH}\\s"']+`, "g");

package/dist/src/telemetry/redactor.js.map

@@ -1 +1 @@
-{"version":3,"file":"redactor.js","sourceRoot":"","sources":["../../../src/telemetry/redactor.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,6EAA6E;AAC7E,0EAA0E;AAC1E,wCAAwC;AAExC,MAAM,KAAK,GAAG,GAAG,CAAC;AAClB,MAAM,SAAS,GAAG,IAAI,CAAC;AAEvB,2EAA2E;AAC3E,4DAA4D;AAC5D,MAAM,aAAa,GAAG,IAAI,MAAM,CAC9B,GAAG,KAAK,GAAG,GAAG,GAAG,MAAM,GAAG,KAAK,KAAK,KAAK,SAAS,EAClD,GAAG,CACJ,CAAC;AACF,MAAM,aAAa,GAAG,IAAI,MAAM,CAC9B,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,KAAK,KAAK,SAAS,EACjD,GAAG,CACJ,CAAC;AACF,MAAM,WAAW,GAAG,IAAI,MAAM,CAC5B,GAAG,SAAS,GAAG,SAAS,GAAG,GAAG,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,KAAK,SAAS,SAAS,EACtF,GAAG,CACJ,CAAC;AAEF,MAAM,QAAQ,GAAG,iDAAiD,CAAC;AAEnE,0EAA0E;AAC1E,gEAAgE;AAChE,MAAM,cAAc,GAAa;IAC/B,0BAA0B;IAC1B,+BAA+B;IAC/B,2BAA2B;IAC3B,2BAA2B;IAC3B,6BAA6B;IAC7B,gCAAgC;CACjC,CAAC;AAEF,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,IAAI,MAAM,GAAG,KAAK;SACf,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC;SAChC,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC;SAChC,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC;SAC9B,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAChC,KAAK,MAAM,OAAO,IAAI,cAAc,EAAE,CAAC;QACrC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,aAAa,CAAI,OAAU;IACzC,IAAI,OAAO,OAAO,KAAK,QAAQ;QAAE,OAAO,YAAY,CAAC,OAAO,CAAiB,CAAC;IAC9E,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,CAAiB,CAAC;IAChG,IAAI,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC3C,MAAM,MAAM,GAA4B,EAAE,CAAC;QAC3C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAkC,CAAC,EAAE,CAAC;YAC9E,MAAM,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,MAAsB,CAAC;IAChC,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}
+{"version":3,"file":"redactor.js","sourceRoot":"","sources":["../../../src/telemetry/redactor.ts"],"names":[],"mappings":"AAAA,uEAAuE;AACvE,yEAAyE;AACzE,0CAA0C;AAE1C,MAAM,KAAK,GAAG,GAAG,CAAC;AAClB,MAAM,SAAS,GAAG,IAAI,CAAC;AAEvB,MAAM,aAAa,GAAG,IAAI,MAAM,CAC9B,GAAG,KAAK,GAAG,GAAG,GAAG,MAAM,GAAG,KAAK,KAAK,KAAK,SAAS,EAClD,GAAG,CACJ,CAAC;AACF,MAAM,aAAa,GAAG,IAAI,MAAM,CAC9B,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,KAAK,KAAK,SAAS,EACjD,GAAG,CACJ,CAAC;AACF,MAAM,WAAW,GAAG,IAAI,MAAM,CAC5B,GAAG,SAAS,GAAG,SAAS,GAAG,GAAG,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,KAAK,SAAS,SAAS,EACtF,GAAG,CACJ,CAAC;AAEF,MAAM,QAAQ,GAAG,iDAAiD,CAAC;AAEnE,0EAA0E;AAC1E,gEAAgE;AAChE,MAAM,cAAc,GAAa;IAC/B,0BAA0B;IAC1B,+BAA+B;IAC/B,2BAA2B;IAC3B,2BAA2B;IAC3B,6BAA6B;IAC7B,gCAAgC;CACjC,CAAC;AAEF,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,IAAI,MAAM,GAAG,KAAK;SACf,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC;SAChC,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC;SAChC,OAAO,CAAC,WAAW,EAAE,QAAQ,CAAC;SAC9B,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAChC,KAAK,MAAM,OAAO,IAAI,cAAc,EAAE,CAAC;QACrC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,aAAa,CAAI,OAAU;IACzC,IAAI,OAAO,OAAO,KAAK,QAAQ;QAAE,OAAO,YAAY,CAAC,OAAO,CAAiB,CAAC;IAC9E,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,CAAiB,CAAC;IAChG,IAAI,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC3C,MAAM,MAAM,GAA4B,EAAE,CAAC;QAC3C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAkC,CAAC,EAAE,CAAC;YAC9E,MAAM,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,MAAsB,CAAC;IAChC,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/docs/reference/distribution.md

@@ -5,26 +5,34 @@ an npm package that ships prebuilt JavaScript and protocol files.
 
 ## Recommended Install Path
 
-After publishing:
-
 ```bash
-pnpm dlx odin-sentinel
+npm i -g @bradheitmann/odin-sentinel
 ```
 
-MCP client configuration can then use:
+MCP client configuration can then use the installed binary directly:
 
 ```json
 {
   "mcpServers": {
     "odin-sentinel": {
-      "command": "pnpm",
-      "args": ["dlx", "odin-sentinel"]
+      "command": "odin-sentinel-mcp"
     }
   }
 }
 ```
 
-`npx -y odin-sentinel` is also viable for npm-first clients.
+For zero-install via `npx`:
+
+```json
+{
+  "mcpServers": {
+    "odin-sentinel": {
+      "command": "npx",
+      "args": ["-y", "-p", "@bradheitmann/odin-sentinel", "odin-sentinel-mcp"]
+    }
+  }
+}
+```
 
 ## Local Clone Path
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bradheitmann/odin-sentinel",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "publishConfig": {
     "access": "public"
   },