@bradheitmann/odin-sentinel 0.4.3 → 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.

package/package.json

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

package/scripts/audit/public-surface.mjs

@@ -33,10 +33,11 @@ function filesToAudit() {
 
 const publicFiles = filesToAudit();
 
-// The bundled bootstrap protocol document references agent harness config
-// directories and tilde home paths as part of its install guidance. The
-// path-style rules below skip these files; the rest of the rules still apply.
+// Install and protocol documentation legitimately references agent harness
+// config directories and tilde home paths. The path-style rules below skip
+// these files; the rest of the rules still apply.
 const BUNDLED_DOC = new Set([
+  "README.md",
   "protocol/bootstrap-" + "sk" + "ill.md",
   "plugins/sentinel-coordination-protocol/" + "sk" + "ills/sentinel-coordination-protocol/SK" + "ILL.md"
 ]);