@canonmsg/claude-code-plugin 0.3.0

package/dist/setup.js

@@ -0,0 +1,66 @@
+#!/usr/bin/env node
+/**
+ * Setup script for the Canon Claude Code plugin.
+ *
+ * Run after `npm install -g @canon/claude-code-plugin` to:
+ * 1. Install the /canon-register and /canon-configure skills
+ * 2. Show the user how to add the MCP server to their .mcp.json
+ */
+import { mkdirSync, writeFileSync, existsSync, readFileSync } from 'node:fs';
+import { join, dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const home = process.env.HOME || process.env.USERPROFILE || '';
+const skillsDir = join(home, '.claude', 'skills');
+// ── Install skills ─────────────────────────────────────────────────────
+function installSkills() {
+    const pluginRoot = join(__dirname, '..');
+    const sourceSkills = join(pluginRoot, 'skills');
+    const skills = ['register', 'configure'];
+    for (const skill of skills) {
+        const srcFile = join(sourceSkills, skill, 'SKILL.md');
+        const destDir = join(skillsDir, `canon-${skill}`);
+        const destFile = join(destDir, 'SKILL.md');
+        if (!existsSync(srcFile)) {
+            console.log(`  Skipping canon-${skill} (source not found at ${srcFile})`);
+            continue;
+        }
+        mkdirSync(destDir, { recursive: true });
+        // Read the skill and replace ${CLAUDE_PLUGIN_ROOT} with the actual installed path
+        let content = readFileSync(srcFile, 'utf-8');
+        content = content.replace(/\$\{CLAUDE_PLUGIN_ROOT\}/g, pluginRoot);
+        writeFileSync(destFile, content);
+        console.log(`  Installed /canon-${skill}`);
+    }
+}
+// ── Show MCP config instructions ───────────────────────────────────────
+function showMcpInstructions() {
+    // Find the installed server.js path
+    const serverPath = join(__dirname, 'server.js');
+    console.log(`
+Add this to your project's .mcp.json (or ~/.mcp.json for global):
+
+{
+  "mcpServers": {
+    "canon-channel": {
+      "command": "node",
+      "args": ["${serverPath}"]
+    }
+  }
+}
+
+Then start Claude Code with:
+
+  claude --dangerously-load-development-channels server:canon-channel
+`);
+}
+// ── Main ───────────────────────────────────────────────────────────────
+console.log('Canon Claude Code Plugin Setup');
+console.log('==============================\n');
+console.log('Installing skills...');
+installSkills();
+console.log('\nRegistering your agent...');
+console.log('  Run /canon-register in Claude Code to register a new agent');
+console.log('  Run /canon-configure if you already have an API key\n');
+console.log('MCP server configuration:');
+showMcpInstructions();

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@canonmsg/claude-code-plugin",
+  "version": "0.3.0",
+  "description": "Canon channel plugin for Claude Code — messaging where AI agents are first-class citizens",
+  "type": "module",
+  "main": "dist/server.js",
+  "bin": {
+    "canon-channel-server": "dist/server.js",
+    "canon-claude": "dist/host.js",
+    "canon-register": "dist/register.js",
+    "canon-setup": "dist/setup.js"
+  },
+  "files": [
+    "dist",
+    "skills",
+    ".claude-plugin"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@anthropic-ai/claude-agent-sdk": "^0.2.92",
+    "@canonmsg/core": "^0.2.2",
+    "@modelcontextprotocol/sdk": "^1.12.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "canon",
+    "claude-code",
+    "channels",
+    "mcp",
+    "ai-agents",
+    "messaging"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/HeyBobChan/canon",
+    "directory": "packages/claude-code-plugin"
+  },
+  "homepage": "https://github.com/HeyBobChan/canon/tree/main/packages/claude-code-plugin",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "~5.7.0"
+  },
+  "license": "MIT"
+}

package/skills/configure/SKILL.md

@@ -0,0 +1,50 @@
+---
+name: canon-configure
+description: Configure an existing Canon agent API key
+user-invocable: true
+allowed-tools:
+  - Read
+  - Write
+---
+
+# Configure Canon API Key
+
+Add an existing Canon agent API key as a named profile.
+
+## Steps
+
+1. Ask the user for:
+   - **API key** — must start with `agk_live_`
+   - **Profile name** — a short identifier (e.g., "my-agent", "reviewer")
+   - **Agent name** (optional) — display name for reference
+
+2. Validate the API key format — it must start with `agk_live_` and be non-empty.
+
+3. Read the existing profiles from `~/.canon/agents.json` (create if missing).
+
+4. Add/update the profile:
+   ```json
+   {
+     "<profile>": {
+       "apiKey": "<key>",
+       "agentId": "",
+       "agentName": "<name or 'Unknown'>",
+       "registeredAt": "<current ISO date>"
+     }
+   }
+   ```
+
+5. Write the updated profiles to `~/.canon/agents.json`.
+
+6. Tell the user: **"API key saved as profile '<profile>'. Restart Claude Code to connect."**
+
+   If they have multiple agents and want to pin one, add to `.mcp.json`:
+   ```json
+   {
+     "mcpServers": {
+       "canon-channel": {
+         "env": { "CANON_AGENT": "<profile>" }
+       }
+     }
+   }
+   ```

package/skills/register/SKILL.md

@@ -0,0 +1,41 @@
+---
+name: canon-register
+description: Register a new Canon agent and get an API key
+user-invocable: true
+allowed-tools:
+  - Bash(canon-register *)
+  - Bash(node *)
+  - Read
+---
+
+# Canon Agent Registration
+
+Register a new Canon agent so it can send and receive messages. Each agent is saved as a named profile in `~/.canon/agents.json`.
+
+## Steps
+
+1. Ask the user for:
+   - **Agent name** — The display name for the agent in Canon
+   - **Description** — What the agent does (shown to users in Canon)
+   - **Owner phone number** — The Canon account owner's phone number in E.164 format (e.g., +15551234567)
+   - **Profile name** (optional) — A short identifier for this agent (e.g., "reviewer", "notifier"). Defaults to a sanitized version of the agent name.
+
+2. Run the registration CLI:
+   ```bash
+   canon-register --name "<name>" --description "<description>" --phone "<phone>" --profile "<profile>"
+   ```
+
+3. Tell the user: **"Open your Canon app and approve the agent registration request. Waiting for approval..."**
+
+   The CLI will poll automatically for up to 5 minutes.
+
+4. On approval, the CLI saves the agent to `~/.canon/agents.json` automatically.
+
+5. Tell the user: **"Agent registered! Run `canon-claude` to start. Or specify a project: `canon-claude --cwd /path/to/project`"**
+
+## Error handling
+
+- If the registration fails, show the error and ask the user to retry.
+- If status returns `"rejected"`, tell the user the registration was rejected by the owner.
+- If polling times out after 5 minutes, tell the user to try again later.
+- If the phone number format is wrong (must start with `+`, 8-16 digits), ask the user to re-enter it.