* refactor: implement channel architecture and dynamic setup - Introduced ChannelRegistry for dynamic channel loading - Decoupled WhatsApp from core index.ts and config.ts - Updated setup wizard to support ENABLED_CHANNELS selection - Refactored IPC and group registration to be channel-aware - Verified with 359 passing tests and clean typecheck * style: fix formatting in config.ts to pass CI * refactor(setup): full platform-agnostic transformation - Harmonized all instructional text and help prompts - Implemented conditional guards for WhatsApp-specific steps - Normalized CLI terminology across all 4 initial channels - Unified troubleshooting and verification logic - Verified 369 tests pass with clean typecheck * feat(skills): transform WhatsApp into a pluggable skill - Created .claude/skills/add-whatsapp with full 5-phase interactive setup - Fixed TS7006 'implicit any' error in IpcDeps - Added auto-creation of STORE_DIR to prevent crashes on fresh installs - Verified with 369 passing tests and clean typecheck * refactor(skills): move WhatsApp from core to pluggable skill - Move src/channels/whatsapp.ts to add-whatsapp skill add/ folder - Move src/channels/whatsapp.test.ts to skill add/ folder - Move src/whatsapp-auth.ts to skill add/ folder - Create modify/ for barrel file (src/channels/index.ts) - Create tests/ with skill package validation test - Update manifest with adds/modifies lists - Remove WhatsApp deps from core package.json (now skill-managed) - Remove WhatsApp-specific ghost language from types.ts - Update SKILL.md to reflect skill-apply workflow Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * refactor(skills): move setup/whatsapp-auth.ts into WhatsApp skill The WhatsApp auth setup step is channel-specific — move it from core to the add-whatsapp skill so core stays minimal. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * refactor(skills): convert Telegram skill to pluggable channel pattern Replace the old direct-integration approach (modifying src/index.ts, src/config.ts, src/routing.test.ts) with self-registration via the channel registry, matching the WhatsApp skill pattern. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix(skills): fix add-whatsapp build failure and improve auth flow - Add missing @types/qrcode-terminal to manifest npm_dependencies (build failed after skill apply without it) - Make QR-browser the recommended auth method (terminal QR too small, pairing codes expire too fast) - Remove "replace vs alongside" question — channels are additive - Add pairing code retry guidance and QR-browser fallback Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: remove hardcoded WhatsApp default and stale Baileys comment - ENABLED_CHANNELS now defaults to empty (fresh installs must configure channels explicitly via /setup; existing installs already have .env) - Remove Baileys-specific comment from storeMessageDirect() in db.ts Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * refactor(skills): convert Discord, Slack, Gmail skills to pluggable channel pattern All channel skills now use the same self-registration pattern: - registerChannel() factory at module load time - Barrel file append (src/channels/index.ts) instead of orchestrator modifications - No more *_ONLY flags (DISCORD_ONLY, SLACK_ONLY) — use ENABLED_CHANNELS instead - Removed ~2500 lines of old modify/ files (src/index.ts, src/config.ts, src/routing.test.ts) Gmail retains its container-runner.ts and agent-runner modifications (MCP mount + server config) since those are independent of channel wiring. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * refactor: use getRegisteredChannels instead of ENABLED_CHANNELS Remove the ENABLED_CHANNELS env var entirely. The orchestrator now iterates getRegisteredChannelNames() from the channel registry — channels self-register via barrel imports and their factories return null when credentials are missing, so unconfigured channels are skipped automatically. Deleted setup/channels.ts (and its tests) since its sole purpose was writing ENABLED_CHANNELS to .env. Refactored verify, groups, and environment setup steps to detect channels by credential presence instead of reading ENABLED_CHANNELS. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: add breaking change notice and whatsapp migration instructions CHANGELOG.md documents the pluggable channel architecture shift and provides migration steps for existing WhatsApp users. CLAUDE.md updated: Quick Context reflects multi-channel architecture, Key Files lists registry.ts instead of whatsapp.ts, and a new Troubleshooting section directs users to /add-whatsapp if WhatsApp stops connecting after upgrade. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: rewrite READMEs for pluggable multi-channel architecture Reflects the architectural shift from a hardcoded WhatsApp bot to a pluggable channel platform. Adds upgrading notice, Mermaid architecture diagram, CI/License/TypeScript/PRs badges, and clarifies that slash commands run inside the Claude Code CLI. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: move pluggable channel architecture details to SPEC.md Revert READMEs to original tone with only two targeted changes: - Add upgrading notice for WhatsApp breaking change - Mention pluggable channels in "What It Supports" Move Mermaid diagram, channel registry internals, factory pattern explanation, and self-registration walkthrough into docs/SPEC.md. Update stale WhatsApp-specific references in SPEC.md to be channel-agnostic. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: move upgrading notice to CHANGELOG, add changelog link Remove the "Upgrading from Pre-Pluggable Versions" section from README.md — breaking change details belong in the CHANGELOG. Add a Changelog section linking to CHANGELOG.md. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: expand CHANGELOG with full PR #500 changes Cover all changes: channel registry, WhatsApp moved to skill, removed core dependencies, all 5 skills simplified, orchestrator refactored, setup decoupled. Use Claude Code CLI instructions for migration. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * chore: bump version to 1.2.0 for pluggable channel architecture Minor version bump — new functionality (pluggable channels) with a managed migration path for existing WhatsApp users. Update version references in CHANGELOG and update skill. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Fix skill application * fix: use slotted barrel file to prevent channel merge conflicts Pre-allocate a named comment slot for each channel in src/channels/index.ts, separated by blank lines. Each skill's modify file only touches its own slot, so three-way merges never conflict when applying multiple channels. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: resolve real chat ID during setup for token-based channels Instead of registering with `pending@telegram` (which never matches incoming messages), the setup skill now runs an inline bot that waits for the user to send /chatid, capturing the real chat ID before registration. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: setup delegates to channel skills, fix group sync and Discord metadata - Restructure setup SKILL.md to delegate channel setup to individual channel skills (/add-whatsapp, /add-telegram, etc.) instead of reimplementing auth/registration inline with broken placeholder JIDs - Move channel selection to step 5 where it's immediately acted on - Fix setup/groups.ts: write sync script to temp file instead of passing via node -e which broke on shell escaping of newlines - Fix Discord onChatMetadata missing channel and isGroup parameters - Add .tmp-* to .gitignore for temp sync script cleanup Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: align add-whatsapp skill with main setup patterns Add headless detection for auth method selection, structured inline error handling, dedicated number DM flow, and reorder questions to match main's trigger-first flow. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: add missing auth script to package.json The add-whatsapp skill adds src/whatsapp-auth.ts but doesn't add the corresponding npm script. Setup and SKILL.md reference `npm run auth` for WhatsApp QR terminal authentication. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: update Discord skill tests to match onChatMetadata signature The onChatMetadata callback now takes 5 arguments (jid, timestamp, name, channel, isGroup) but the Discord skill tests only expected 3. This caused skill application to roll back on test failure. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: replace 'pluggable' jargon with clearer language User-facing text now says "multi-channel" or describes what it does. Developer-facing text uses "self-registering" or "channel registry". Also removes extra badge row from README. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: align Chinese README with English version Remove extra badges, replace pluggable jargon, remove upgrade section (now in CHANGELOG), add missing intro line and changelog section, fix setup FAQ answer. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: warn on installed-but-unconfigured channels instead of silent skip Channels with missing credentials now emit WARN logs naming the exact missing variable, so misconfigurations surface instead of being hidden. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: simplify changelog to one-liner with compare link Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * feat: add isMain flag and channel-prefixed group folders Replace MAIN_GROUP_FOLDER constant with explicit isMain boolean on RegisteredGroup. Group folders now use channel prefix convention (e.g., whatsapp_main, telegram_family-chat) to prevent cross-channel collisions. - Add isMain to RegisteredGroup type and SQLite schema (with migration) - Replace all folder-based main group checks with group.isMain - Add --is-main flag to setup/register.ts - Strip isMain from IPC payload (defense in depth) - Update MCP tool description for channel-prefixed naming - Update all channel SKILL.md files and documentation Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: gavrielc <gabicohen22@yahoo.com> Co-authored-by: Koshkoshinski <daniel.milliner@gmail.com>
286 lines
11 KiB
TypeScript
286 lines
11 KiB
TypeScript
/**
|
|
* Stdio MCP Server for NanoClaw
|
|
* Standalone process that agent teams subagents can inherit.
|
|
* Reads context from environment variables, writes IPC files for the host.
|
|
*/
|
|
|
|
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
|
|
import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
|
|
import { z } from 'zod';
|
|
import fs from 'fs';
|
|
import path from 'path';
|
|
import { CronExpressionParser } from 'cron-parser';
|
|
|
|
const IPC_DIR = '/workspace/ipc';
|
|
const MESSAGES_DIR = path.join(IPC_DIR, 'messages');
|
|
const TASKS_DIR = path.join(IPC_DIR, 'tasks');
|
|
|
|
// Context from environment variables (set by the agent runner)
|
|
const chatJid = process.env.NANOCLAW_CHAT_JID!;
|
|
const groupFolder = process.env.NANOCLAW_GROUP_FOLDER!;
|
|
const isMain = process.env.NANOCLAW_IS_MAIN === '1';
|
|
|
|
function writeIpcFile(dir: string, data: object): string {
|
|
fs.mkdirSync(dir, { recursive: true });
|
|
|
|
const filename = `${Date.now()}-${Math.random().toString(36).slice(2, 8)}.json`;
|
|
const filepath = path.join(dir, filename);
|
|
|
|
// Atomic write: temp file then rename
|
|
const tempPath = `${filepath}.tmp`;
|
|
fs.writeFileSync(tempPath, JSON.stringify(data, null, 2));
|
|
fs.renameSync(tempPath, filepath);
|
|
|
|
return filename;
|
|
}
|
|
|
|
const server = new McpServer({
|
|
name: 'nanoclaw',
|
|
version: '1.0.0',
|
|
});
|
|
|
|
server.tool(
|
|
'send_message',
|
|
"Send a message to the user or group immediately while you're still running. Use this for progress updates or to send multiple messages. You can call this multiple times. Note: when running as a scheduled task, your final output is NOT sent to the user — use this tool if you need to communicate with the user or group.",
|
|
{
|
|
text: z.string().describe('The message text to send'),
|
|
sender: z.string().optional().describe('Your role/identity name (e.g. "Researcher"). When set, messages appear from a dedicated bot in Telegram.'),
|
|
},
|
|
async (args) => {
|
|
const data: Record<string, string | undefined> = {
|
|
type: 'message',
|
|
chatJid,
|
|
text: args.text,
|
|
sender: args.sender || undefined,
|
|
groupFolder,
|
|
timestamp: new Date().toISOString(),
|
|
};
|
|
|
|
writeIpcFile(MESSAGES_DIR, data);
|
|
|
|
return { content: [{ type: 'text' as const, text: 'Message sent.' }] };
|
|
},
|
|
);
|
|
|
|
server.tool(
|
|
'schedule_task',
|
|
`Schedule a recurring or one-time task. The task will run as a full agent with access to all tools.
|
|
|
|
CONTEXT MODE - Choose based on task type:
|
|
\u2022 "group": Task runs in the group's conversation context, with access to chat history. Use for tasks that need context about ongoing discussions, user preferences, or recent interactions.
|
|
\u2022 "isolated": Task runs in a fresh session with no conversation history. Use for independent tasks that don't need prior context. When using isolated mode, include all necessary context in the prompt itself.
|
|
|
|
If unsure which mode to use, you can ask the user. Examples:
|
|
- "Remind me about our discussion" \u2192 group (needs conversation context)
|
|
- "Check the weather every morning" \u2192 isolated (self-contained task)
|
|
- "Follow up on my request" \u2192 group (needs to know what was requested)
|
|
- "Generate a daily report" \u2192 isolated (just needs instructions in prompt)
|
|
|
|
MESSAGING BEHAVIOR - The task agent's output is sent to the user or group. It can also use send_message for immediate delivery, or wrap output in <internal> tags to suppress it. Include guidance in the prompt about whether the agent should:
|
|
\u2022 Always send a message (e.g., reminders, daily briefings)
|
|
\u2022 Only send a message when there's something to report (e.g., "notify me if...")
|
|
\u2022 Never send a message (background maintenance tasks)
|
|
|
|
SCHEDULE VALUE FORMAT (all times are LOCAL timezone):
|
|
\u2022 cron: Standard cron expression (e.g., "*/5 * * * *" for every 5 minutes, "0 9 * * *" for daily at 9am LOCAL time)
|
|
\u2022 interval: Milliseconds between runs (e.g., "300000" for 5 minutes, "3600000" for 1 hour)
|
|
\u2022 once: Local time WITHOUT "Z" suffix (e.g., "2026-02-01T15:30:00"). Do NOT use UTC/Z suffix.`,
|
|
{
|
|
prompt: z.string().describe('What the agent should do when the task runs. For isolated mode, include all necessary context here.'),
|
|
schedule_type: z.enum(['cron', 'interval', 'once']).describe('cron=recurring at specific times, interval=recurring every N ms, once=run once at specific time'),
|
|
schedule_value: z.string().describe('cron: "*/5 * * * *" | interval: milliseconds like "300000" | once: local timestamp like "2026-02-01T15:30:00" (no Z suffix!)'),
|
|
context_mode: z.enum(['group', 'isolated']).default('group').describe('group=runs with chat history and memory, isolated=fresh session (include context in prompt)'),
|
|
target_group_jid: z.string().optional().describe('(Main group only) JID of the group to schedule the task for. Defaults to the current group.'),
|
|
},
|
|
async (args) => {
|
|
// Validate schedule_value before writing IPC
|
|
if (args.schedule_type === 'cron') {
|
|
try {
|
|
CronExpressionParser.parse(args.schedule_value);
|
|
} catch {
|
|
return {
|
|
content: [{ type: 'text' as const, text: `Invalid cron: "${args.schedule_value}". Use format like "0 9 * * *" (daily 9am) or "*/5 * * * *" (every 5 min).` }],
|
|
isError: true,
|
|
};
|
|
}
|
|
} else if (args.schedule_type === 'interval') {
|
|
const ms = parseInt(args.schedule_value, 10);
|
|
if (isNaN(ms) || ms <= 0) {
|
|
return {
|
|
content: [{ type: 'text' as const, text: `Invalid interval: "${args.schedule_value}". Must be positive milliseconds (e.g., "300000" for 5 min).` }],
|
|
isError: true,
|
|
};
|
|
}
|
|
} else if (args.schedule_type === 'once') {
|
|
if (/[Zz]$/.test(args.schedule_value) || /[+-]\d{2}:\d{2}$/.test(args.schedule_value)) {
|
|
return {
|
|
content: [{ type: 'text' as const, text: `Timestamp must be local time without timezone suffix. Got "${args.schedule_value}" — use format like "2026-02-01T15:30:00".` }],
|
|
isError: true,
|
|
};
|
|
}
|
|
const date = new Date(args.schedule_value);
|
|
if (isNaN(date.getTime())) {
|
|
return {
|
|
content: [{ type: 'text' as const, text: `Invalid timestamp: "${args.schedule_value}". Use local time format like "2026-02-01T15:30:00".` }],
|
|
isError: true,
|
|
};
|
|
}
|
|
}
|
|
|
|
// Non-main groups can only schedule for themselves
|
|
const targetJid = isMain && args.target_group_jid ? args.target_group_jid : chatJid;
|
|
|
|
const data = {
|
|
type: 'schedule_task',
|
|
prompt: args.prompt,
|
|
schedule_type: args.schedule_type,
|
|
schedule_value: args.schedule_value,
|
|
context_mode: args.context_mode || 'group',
|
|
targetJid,
|
|
createdBy: groupFolder,
|
|
timestamp: new Date().toISOString(),
|
|
};
|
|
|
|
const filename = writeIpcFile(TASKS_DIR, data);
|
|
|
|
return {
|
|
content: [{ type: 'text' as const, text: `Task scheduled (${filename}): ${args.schedule_type} - ${args.schedule_value}` }],
|
|
};
|
|
},
|
|
);
|
|
|
|
server.tool(
|
|
'list_tasks',
|
|
"List all scheduled tasks. From main: shows all tasks. From other groups: shows only that group's tasks.",
|
|
{},
|
|
async () => {
|
|
const tasksFile = path.join(IPC_DIR, 'current_tasks.json');
|
|
|
|
try {
|
|
if (!fs.existsSync(tasksFile)) {
|
|
return { content: [{ type: 'text' as const, text: 'No scheduled tasks found.' }] };
|
|
}
|
|
|
|
const allTasks = JSON.parse(fs.readFileSync(tasksFile, 'utf-8'));
|
|
|
|
const tasks = isMain
|
|
? allTasks
|
|
: allTasks.filter((t: { groupFolder: string }) => t.groupFolder === groupFolder);
|
|
|
|
if (tasks.length === 0) {
|
|
return { content: [{ type: 'text' as const, text: 'No scheduled tasks found.' }] };
|
|
}
|
|
|
|
const formatted = tasks
|
|
.map(
|
|
(t: { id: string; prompt: string; schedule_type: string; schedule_value: string; status: string; next_run: string }) =>
|
|
`- [${t.id}] ${t.prompt.slice(0, 50)}... (${t.schedule_type}: ${t.schedule_value}) - ${t.status}, next: ${t.next_run || 'N/A'}`,
|
|
)
|
|
.join('\n');
|
|
|
|
return { content: [{ type: 'text' as const, text: `Scheduled tasks:\n${formatted}` }] };
|
|
} catch (err) {
|
|
return {
|
|
content: [{ type: 'text' as const, text: `Error reading tasks: ${err instanceof Error ? err.message : String(err)}` }],
|
|
};
|
|
}
|
|
},
|
|
);
|
|
|
|
server.tool(
|
|
'pause_task',
|
|
'Pause a scheduled task. It will not run until resumed.',
|
|
{ task_id: z.string().describe('The task ID to pause') },
|
|
async (args) => {
|
|
const data = {
|
|
type: 'pause_task',
|
|
taskId: args.task_id,
|
|
groupFolder,
|
|
isMain,
|
|
timestamp: new Date().toISOString(),
|
|
};
|
|
|
|
writeIpcFile(TASKS_DIR, data);
|
|
|
|
return { content: [{ type: 'text' as const, text: `Task ${args.task_id} pause requested.` }] };
|
|
},
|
|
);
|
|
|
|
server.tool(
|
|
'resume_task',
|
|
'Resume a paused task.',
|
|
{ task_id: z.string().describe('The task ID to resume') },
|
|
async (args) => {
|
|
const data = {
|
|
type: 'resume_task',
|
|
taskId: args.task_id,
|
|
groupFolder,
|
|
isMain,
|
|
timestamp: new Date().toISOString(),
|
|
};
|
|
|
|
writeIpcFile(TASKS_DIR, data);
|
|
|
|
return { content: [{ type: 'text' as const, text: `Task ${args.task_id} resume requested.` }] };
|
|
},
|
|
);
|
|
|
|
server.tool(
|
|
'cancel_task',
|
|
'Cancel and delete a scheduled task.',
|
|
{ task_id: z.string().describe('The task ID to cancel') },
|
|
async (args) => {
|
|
const data = {
|
|
type: 'cancel_task',
|
|
taskId: args.task_id,
|
|
groupFolder,
|
|
isMain,
|
|
timestamp: new Date().toISOString(),
|
|
};
|
|
|
|
writeIpcFile(TASKS_DIR, data);
|
|
|
|
return { content: [{ type: 'text' as const, text: `Task ${args.task_id} cancellation requested.` }] };
|
|
},
|
|
);
|
|
|
|
server.tool(
|
|
'register_group',
|
|
`Register a new chat/group so the agent can respond to messages there. Main group only.
|
|
|
|
Use available_groups.json to find the JID for a group. The folder name must be channel-prefixed: "{channel}_{group-name}" (e.g., "whatsapp_family-chat", "telegram_dev-team", "discord_general"). Use lowercase with hyphens for the group name part.`,
|
|
{
|
|
jid: z.string().describe('The chat JID (e.g., "120363336345536173@g.us", "tg:-1001234567890", "dc:1234567890123456")'),
|
|
name: z.string().describe('Display name for the group'),
|
|
folder: z.string().describe('Channel-prefixed folder name (e.g., "whatsapp_family-chat", "telegram_dev-team")'),
|
|
trigger: z.string().describe('Trigger word (e.g., "@Andy")'),
|
|
},
|
|
async (args) => {
|
|
if (!isMain) {
|
|
return {
|
|
content: [{ type: 'text' as const, text: 'Only the main group can register new groups.' }],
|
|
isError: true,
|
|
};
|
|
}
|
|
|
|
const data = {
|
|
type: 'register_group',
|
|
jid: args.jid,
|
|
name: args.name,
|
|
folder: args.folder,
|
|
trigger: args.trigger,
|
|
timestamp: new Date().toISOString(),
|
|
};
|
|
|
|
writeIpcFile(TASKS_DIR, data);
|
|
|
|
return {
|
|
content: [{ type: 'text' as const, text: `Group "${args.name}" registered. It will start receiving messages immediately.` }],
|
|
};
|
|
},
|
|
);
|
|
|
|
// Start the stdio transport
|
|
const transport = new StdioServerTransport();
|
|
await server.connect(transport);
|