openbot 0.4.6 → 0.5.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (132) hide show
  1. package/.claude/agents/runtime-security-reviewer.md +32 -0
  2. package/.claude/hooks/format.sh +18 -0
  3. package/.claude/hooks/protect-secrets.sh +23 -0
  4. package/.claude/settings.json +26 -0
  5. package/.claude/skills/deploy/SKILL.md +26 -0
  6. package/.claude/skills/new-plugin/SKILL.md +46 -0
  7. package/.dockerignore +9 -0
  8. package/.mcp.json +8 -0
  9. package/AGENTS.md +2 -2
  10. package/CLAUDE.md +50 -0
  11. package/Dockerfile +41 -0
  12. package/deploy/README.md +61 -0
  13. package/deploy/entrypoint.sh +6 -0
  14. package/deploy/fly.toml +36 -0
  15. package/dist/app/bootstrap.js +29 -0
  16. package/dist/app/cli.js +3 -1
  17. package/dist/app/cloud-mode.js +26 -0
  18. package/dist/app/config.js +61 -16
  19. package/dist/app/responding-agent.js +32 -0
  20. package/dist/app/server.js +47 -9
  21. package/dist/plugins/approval/index.js +1 -1
  22. package/dist/plugins/bash/index.js +386 -164
  23. package/dist/plugins/memory/service.js +2 -5
  24. package/dist/plugins/openbot/context.js +17 -1
  25. package/dist/plugins/openbot/index.js +25 -9
  26. package/dist/plugins/openbot/model.js +59 -0
  27. package/dist/plugins/openbot/runtime.js +39 -56
  28. package/dist/plugins/openbot/system-prompt.js +44 -9
  29. package/dist/plugins/preview/index.js +267 -0
  30. package/dist/plugins/storage/index.js +3 -3
  31. package/dist/plugins/storage/service.js +58 -12
  32. package/dist/plugins/todo/index.js +131 -38
  33. package/dist/plugins/todo/service.js +93 -0
  34. package/dist/plugins/ui/index.js +8 -1
  35. package/dist/services/plugins/model-registry.js +101 -0
  36. package/dist/services/plugins/registry.js +6 -4
  37. package/dist/services/plugins/service.js +2 -6
  38. package/docs/agents.md +20 -2
  39. package/docs/architecture.md +1 -1
  40. package/docs/plugins.md +13 -3
  41. package/docs/templates/AGENT.example.md +1 -1
  42. package/package.json +5 -2
  43. package/pnpm-workspace.yaml +2 -0
  44. package/src/app/bootstrap.ts +43 -0
  45. package/src/app/cli.ts +3 -1
  46. package/src/app/cloud-mode.ts +41 -0
  47. package/src/app/config.ts +71 -19
  48. package/src/app/responding-agent.ts +46 -0
  49. package/src/app/server.ts +55 -9
  50. package/src/app/types.ts +167 -31
  51. package/src/plugins/approval/index.ts +1 -1
  52. package/src/plugins/bash/index.ts +498 -185
  53. package/src/plugins/memory/service.ts +2 -5
  54. package/src/plugins/openbot/context.ts +17 -1
  55. package/src/plugins/openbot/index.ts +27 -11
  56. package/src/plugins/openbot/model.ts +76 -0
  57. package/src/plugins/openbot/runtime.ts +47 -69
  58. package/src/plugins/openbot/system-prompt.ts +44 -9
  59. package/src/plugins/preview/index.ts +323 -0
  60. package/src/plugins/storage/index.ts +5 -8
  61. package/src/plugins/storage/service.ts +79 -15
  62. package/src/plugins/todo/index.ts +166 -0
  63. package/src/plugins/todo/service.ts +123 -0
  64. package/src/plugins/ui/index.ts +8 -1
  65. package/src/services/plugins/domain.ts +2 -0
  66. package/src/services/plugins/model-registry.ts +146 -0
  67. package/src/services/plugins/registry.ts +6 -4
  68. package/src/services/plugins/service.ts +2 -6
  69. package/dist/agents/openbot/index.js +0 -76
  70. package/dist/agents/openbot/middleware/approval.js +0 -132
  71. package/dist/agents/openbot/runtime.js +0 -289
  72. package/dist/agents/openbot/system-prompt.js +0 -32
  73. package/dist/agents/openbot/tools/delegation.js +0 -78
  74. package/dist/agents/openbot/tools/mcp.js +0 -99
  75. package/dist/agents/openbot/tools/shell.js +0 -91
  76. package/dist/agents/openbot/tools/storage.js +0 -75
  77. package/dist/agents/openbot/tools/ui.js +0 -176
  78. package/dist/agents/system.js +0 -33
  79. package/dist/bus/agent-package.js +0 -1
  80. package/dist/bus/plugin.js +0 -1
  81. package/dist/bus/services.js +0 -754
  82. package/dist/bus/types.js +0 -1
  83. package/dist/harness/agent-harness.js +0 -45
  84. package/dist/harness/agent-invoke-run.js +0 -44
  85. package/dist/harness/agent-turn.js +0 -99
  86. package/dist/harness/channel-participants.js +0 -40
  87. package/dist/harness/constants.js +0 -2
  88. package/dist/harness/context-meter.js +0 -97
  89. package/dist/harness/context.js +0 -363
  90. package/dist/harness/dispatch.js +0 -144
  91. package/dist/harness/dispatcher.js +0 -156
  92. package/dist/harness/event-normalizer.js +0 -59
  93. package/dist/harness/history.js +0 -177
  94. package/dist/harness/mcp.js +0 -61
  95. package/dist/harness/orchestration.js +0 -88
  96. package/dist/harness/orchestrator.js +0 -149
  97. package/dist/harness/participants.js +0 -22
  98. package/dist/harness/process.js +0 -29
  99. package/dist/harness/queue-processor.js +0 -187
  100. package/dist/harness/run-harness.js +0 -154
  101. package/dist/harness/run.js +0 -98
  102. package/dist/harness/runtime-factory.js +0 -73
  103. package/dist/harness/runtime.js +0 -57
  104. package/dist/harness/todo-advance.js +0 -93
  105. package/dist/harness/todo-dispatch.js +0 -51
  106. package/dist/harness/todos.js +0 -5
  107. package/dist/harness/turn.js +0 -79
  108. package/dist/harness/types.js +0 -1
  109. package/dist/plugins/ai-sdk/index.js +0 -34
  110. package/dist/plugins/ai-sdk/runtime.js +0 -395
  111. package/dist/plugins/ai-sdk/system-prompt.js +0 -18
  112. package/dist/plugins/ai-sdk.js +0 -331
  113. package/dist/plugins/approval.js +0 -163
  114. package/dist/plugins/delegation.js +0 -108
  115. package/dist/plugins/mcp/index.js +0 -108
  116. package/dist/plugins/mcp.js +0 -140
  117. package/dist/plugins/shell/index.js +0 -100
  118. package/dist/plugins/shell.js +0 -123
  119. package/dist/plugins/storage-tools/index.js +0 -76
  120. package/dist/plugins/storage.js +0 -737
  121. package/dist/plugins/thread-namer/index.js +0 -72
  122. package/dist/plugins/threads/index.js +0 -114
  123. package/dist/plugins/ui.js +0 -211
  124. package/dist/plugins/workflow/index.js +0 -65
  125. package/dist/registry/agents.js +0 -138
  126. package/dist/registry/plugins.js +0 -110
  127. package/dist/services/agent-packages.js +0 -103
  128. package/dist/services/memory.js +0 -152
  129. package/dist/services/plugins.js +0 -98
  130. package/dist/services/storage.js +0 -1028
  131. package/dist/workflow/service.js +0 -106
  132. package/dist/workflow/types.js +0 -3
@@ -1,5 +1,6 @@
1
1
  import { ORCHESTRATOR_AGENT_ID, STATE_AGENT_ID } from '../../app/agent-ids.js';
2
- import { DEFAULT_PLUGINS_DIR, DEFAULT_AGENTS_DIR, DEFAULT_BASE_DIR, DEFAULT_CHANNELS_DIR, getDefaultChannelCwd, loadConfig, resolvePath, VARIABLES_FILE, } from '../../app/config.js';
2
+ import { assertCloudSystemAgentPluginsMutable, CLOUD_SYSTEM_MODEL, isCloudMode, } from '../../app/cloud-mode.js';
3
+ import { DEFAULT_PLUGINS_DIR, DEFAULT_AGENTS_DIR, DEFAULT_CHANNELS_DIR, getBaseDir, getDefaultChannelCwd, resolvePath, VARIABLES_FILE, } from '../../app/config.js';
3
4
  import fs from 'node:fs/promises';
4
5
  import { readFileSync } from 'node:fs';
5
6
  import path from 'node:path';
@@ -8,13 +9,11 @@ import crypto from 'node:crypto';
8
9
  import matter from 'gray-matter';
9
10
  import { openbotPlugin } from '../openbot/index.js';
10
11
  import { listBuiltInPlugins, parsePluginModule } from '../../services/plugins/registry.js';
12
+ import { enrichOpenbotPluginDescriptor, listRegistryModelOptions, } from '../../services/plugins/model-registry.js';
11
13
  import { processService } from '../../services/process.js';
12
14
  import { memoryService } from '../memory/service.js';
13
15
  import { guessMimeType, resolveChannelFile, statChannelFile, } from './files.js';
14
- const resolveBaseDir = () => {
15
- const config = loadConfig();
16
- return resolvePath(config.baseDir || DEFAULT_BASE_DIR);
17
- };
16
+ const resolveBaseDir = () => getBaseDir();
18
17
  const ENTITY_SVG_CANDIDATE_NAMES = ['avatar.svg', 'icon.svg', 'image.svg', 'logo.svg'];
19
18
  const toSvgDataUrl = (svg) => `data:image/svg+xml;base64,${Buffer.from(svg, 'utf-8').toString('base64')}`;
20
19
  let bundledSystemAgentImage;
@@ -85,11 +84,37 @@ const SYSTEM_DEFAULT_PLUGINS = [
85
84
  config: {
86
85
  model: 'openai/gpt-5.4-mini',
87
86
  approval: {
88
- actions: ['action:bash', 'action:create_channel', 'action:delete_channel'],
87
+ actions: ['action:shell_exec', 'action:create_channel', 'action:delete_channel'],
88
+ },
89
+ },
90
+ },
91
+ ];
92
+ const CLOUD_SYSTEM_DEFAULT_PLUGINS = [
93
+ {
94
+ id: 'openbot',
95
+ config: {
96
+ model: CLOUD_SYSTEM_MODEL,
97
+ approval: {
98
+ actions: ['action:shell_exec', 'action:create_channel', 'action:delete_channel'],
89
99
  },
90
100
  },
91
101
  },
92
102
  ];
103
+ function mergeCloudSystemPluginRefs(defaults, diskRefs) {
104
+ const defaultOpenbot = defaults.find((ref) => ref.id === 'openbot');
105
+ const diskOpenbot = diskRefs.find((ref) => ref.id === 'openbot');
106
+ if (!defaultOpenbot)
107
+ return defaults;
108
+ return [
109
+ {
110
+ ...defaultOpenbot,
111
+ config: {
112
+ ...defaultOpenbot.config,
113
+ ...diskOpenbot?.config,
114
+ },
115
+ },
116
+ ];
117
+ }
93
118
  /** No `openbot` / `bash` — storage-side effects and infra plugins only. */
94
119
  const STATE_DEFAULT_PLUGINS = [
95
120
  { id: 'storage' },
@@ -97,24 +122,41 @@ const STATE_DEFAULT_PLUGINS = [
97
122
  ];
98
123
  const STATE_AGENT_INSTRUCTIONS = 'Built-in infra agent for deterministic state reads. No conversational model is attached; handle storage, approvals, memory, and plugin marketplace events.';
99
124
  function getSystemAgentDetails(overrides) {
125
+ const defaultPlugins = isCloudMode() ? CLOUD_SYSTEM_DEFAULT_PLUGINS : SYSTEM_DEFAULT_PLUGINS;
100
126
  const defaults = {
101
127
  id: SYSTEM_AGENT_ID,
102
128
  name: 'OpenBot',
103
129
  image: getBundledSystemAgentImage(),
104
130
  description: 'First-party orchestration agent for OpenBot.',
105
131
  instructions: '',
106
- plugins: SYSTEM_DEFAULT_PLUGINS.map((ref) => ref.id),
107
- pluginRefs: SYSTEM_DEFAULT_PLUGINS,
132
+ plugins: defaultPlugins.map((ref) => ref.id),
133
+ pluginRefs: defaultPlugins,
108
134
  createdAt: new Date(),
109
135
  updatedAt: new Date(),
110
136
  };
111
137
  if (!overrides)
112
138
  return defaults;
139
+ const diskInstructions = overrides.instructions?.trim();
140
+ const instructions = diskInstructions && diskInstructions.length > 0 ? diskInstructions : defaults.instructions;
141
+ if (isCloudMode()) {
142
+ const diskRefs = overrides.pluginRefs && overrides.pluginRefs.length > 0 ? overrides.pluginRefs : undefined;
143
+ const refs = diskRefs
144
+ ? mergeCloudSystemPluginRefs(defaults.pluginRefs, diskRefs)
145
+ : defaults.pluginRefs;
146
+ return {
147
+ ...defaults,
148
+ ...overrides,
149
+ id: SYSTEM_AGENT_ID,
150
+ instructions,
151
+ image: overrides.image || defaults.image,
152
+ plugins: refs.map((ref) => ref.id),
153
+ pluginRefs: refs,
154
+ updatedAt: new Date(),
155
+ };
156
+ }
113
157
  const refs = overrides.pluginRefs && overrides.pluginRefs.length > 0
114
158
  ? overrides.pluginRefs
115
159
  : defaults.pluginRefs;
116
- const diskInstructions = overrides.instructions?.trim();
117
- const instructions = diskInstructions && diskInstructions.length > 0 ? diskInstructions : defaults.instructions;
118
160
  return {
119
161
  ...defaults,
120
162
  ...overrides,
@@ -775,11 +817,13 @@ export const storageService = {
775
817
  return Array.from(deduped.values()).filter((agent) => !agent.hidden);
776
818
  },
777
819
  getPlugins: async () => {
778
- const [builtIn, fromDisk] = await Promise.all([
820
+ const [builtIn, fromDisk, modelOptions] = await Promise.all([
779
821
  listBuiltInPluginDescriptors(),
780
822
  listPluginsFromDisk(),
823
+ listRegistryModelOptions(),
781
824
  ]);
782
- const merged = [...builtIn, ...fromDisk];
825
+ const enrichedBuiltIn = builtIn.map((plugin) => enrichOpenbotPluginDescriptor(plugin, modelOptions));
826
+ const merged = [...enrichedBuiltIn, ...fromDisk];
783
827
  const deduped = new Map();
784
828
  for (const plugin of merged) {
785
829
  if (!deduped.has(plugin.id)) {
@@ -839,6 +883,7 @@ export const storageService = {
839
883
  },
840
884
  createAgent: async ({ agentId, name, description = '', image, hidden, instructions, plugins, }) => {
841
885
  assertAgentIdFormat(agentId);
886
+ assertCloudSystemAgentPluginsMutable(agentId, plugins);
842
887
  const agentDir = resolvePath(path.join(getAgentsRootDir(), agentId));
843
888
  const agentMdPath = path.join(agentDir, 'AGENT.md');
844
889
  try {
@@ -874,6 +919,7 @@ export const storageService = {
874
919
  },
875
920
  updateAgent: async ({ agentId, name, description, image, hidden, instructions, plugins, }) => {
876
921
  assertAgentIdFormat(agentId);
922
+ assertCloudSystemAgentPluginsMutable(agentId, plugins);
877
923
  const agentDir = resolvePath(path.join(getAgentsRootDir(), agentId));
878
924
  const agentMdPath = path.join(agentDir, 'AGENT.md');
879
925
  let raw;
@@ -1,53 +1,146 @@
1
1
  import z from 'zod';
2
- const todoStatus = z.enum(['pending', 'in_progress', 'done', 'cancelled']);
2
+ import { todoService } from './service.js';
3
+ /**
4
+ * `todo` — thread-scoped task checklist for multi-step agent work.
5
+ *
6
+ * Persisted at `~/.openbot/channels/<channelId>/threads/<threadId>/todos.json`.
7
+ * The agent replaces the full list via `todo_write`; the runtime injects the
8
+ * current list into context each turn.
9
+ */
10
+ /** Map todo statuses onto UI list-item status label + variant. */
11
+ function toWidgetItemStatus(status) {
12
+ switch (status) {
13
+ case 'pending':
14
+ return { status: 'Pending', statusVariant: 'default' };
15
+ case 'in_progress':
16
+ return { status: 'In progress', statusVariant: 'info' };
17
+ case 'completed':
18
+ return { status: 'Done', statusVariant: 'success' };
19
+ case 'cancelled':
20
+ return { status: 'Cancelled', statusVariant: 'danger' };
21
+ }
22
+ }
23
+ function formatTodoOutput(list) {
24
+ if (list.items.length === 0)
25
+ return 'Todo list is empty.';
26
+ const lines = list.items.map((t) => `- [${t.status}] (${t.id}) ${t.content}`);
27
+ return `Todos (${list.items.length}):\n${lines.join('\n')}`;
28
+ }
29
+ function todoListWidget(args) {
30
+ const items = args.list.items.map((t) => ({
31
+ id: t.id,
32
+ label: t.content,
33
+ ...toWidgetItemStatus(t.status),
34
+ }));
35
+ return {
36
+ type: 'client:ui:widget',
37
+ data: {
38
+ // One widget per agent run — repeated todo_write calls update in place.
39
+ widgetId: `todos:${args.runId}`,
40
+ kind: 'list',
41
+ title: 'Todos',
42
+ description: args.list.items.length === 0
43
+ ? 'No todos'
44
+ : `${args.list.items.filter((t) => t.status === 'completed').length}/${args.list.items.length} completed`,
45
+ items,
46
+ display: 'expanded',
47
+ state: 'open',
48
+ },
49
+ meta: {},
50
+ };
51
+ }
52
+ const todoItemSchema = z.object({
53
+ id: z.string().min(1).describe('Stable todo id (e.g. "1", "setup-repo").'),
54
+ content: z.string().min(1).describe('Short imperative description of the step.'),
55
+ status: z
56
+ .enum(['pending', 'in_progress', 'completed', 'cancelled'])
57
+ .describe('Todo status. At most one item may be in_progress.'),
58
+ });
3
59
  const todoToolDefinitions = {
4
60
  todo_write: {
5
- description: 'Manage the shared todo list (create, update, append, remove).',
61
+ description: 'Replace the current thread todo list with the provided items. Use for multi-step tasks: write the plan first, keep exactly one item in_progress while working, mark items completed immediately after finishing, and when done leave all items as completed (do not clear the list). Pass the full intended list each call (not a partial patch).',
6
62
  inputSchema: z.object({
7
- todos: z
8
- .array(z.object({
9
- id: z
10
- .string()
11
- .optional()
12
- .describe('Stable id. Reuse existing ids to update; omit to create.'),
13
- content: z.string().min(1).optional().describe('What needs to be done.'),
14
- status: todoStatus.optional().describe('Defaults to `pending`.'),
15
- assignee: z
16
- .string()
17
- .optional()
18
- .describe('Suggested agent id for this step (plain id, no @ prefix).'),
19
- deleted: z.boolean().optional().describe('If true, remove this item.'),
20
- }))
21
- .describe('List of todo items to write or patch.'),
22
- merge: z
23
- .boolean()
24
- .optional()
25
- .describe('If true (default), patches existing items by id and appends new ones. If false, replaces the entire list.'),
63
+ items: z
64
+ .array(todoItemSchema)
65
+ .max(20)
66
+ .describe('Full todo list for this thread (max 20). Replaces any previous list.'),
26
67
  }),
27
68
  },
28
- delegate_to_agent: {
29
- description: 'Run a worker agent on a self-contained task and return their output. ' +
30
- 'Call when a todo step should be executed by a participant; review the result and update todos before delegating again or replying to the user.',
31
- inputSchema: z.object({
32
- agentId: z
33
- .string()
34
- .min(1)
35
- .describe('Worker agent id from channel participants (plain id, no @ prefix).'),
36
- task: z
37
- .string()
38
- .min(1)
39
- .describe('Complete instruction for the worker — they do not see the full todo plan.'),
40
- todoId: z.string().optional().describe('Optional todo id this step relates to.'),
41
- }),
69
+ todo_read: {
70
+ description: 'Read the current thread todo list. Usually unnecessary the list is already injected into context each turn. Use only if you need an explicit refresh after an external change.',
71
+ inputSchema: z.object({}),
42
72
  },
43
73
  };
44
74
  export const todoPlugin = {
45
75
  id: 'todo',
46
76
  name: 'Todo',
47
- description: 'Shared todo list and worker delegation for multi-step orchestration.',
77
+ description: 'Thread-scoped todo checklist for multi-step task tracking (todo_write / todo_read).',
48
78
  toolDefinitions: todoToolDefinitions,
49
- factory: () => () => {
50
- // Handlers live in bus/services.ts.
79
+ factory: () => (builder) => {
80
+ builder.on('action:todo_write', async function* (event, context) {
81
+ const resultMeta = { ...(event.meta || {}), agentId: context.state.agentId };
82
+ try {
83
+ const channelId = context.state.channelId;
84
+ const threadId = context.state.threadId;
85
+ if (!channelId || !threadId) {
86
+ throw new Error('Missing channelId or threadId for todo_write');
87
+ }
88
+ const items = event.data.items;
89
+ const list = await todoService.writeTodos({ channelId, threadId, items });
90
+ const runId = context.state.runId;
91
+ if (!runId) {
92
+ throw new Error('Missing runId for todo_write widget');
93
+ }
94
+ const widget = todoListWidget({ runId, list });
95
+ widget.meta = { ...resultMeta, threadId, runId };
96
+ yield widget;
97
+ yield {
98
+ type: 'action:todo_write:result',
99
+ data: { success: true, list, output: formatTodoOutput(list) },
100
+ meta: resultMeta,
101
+ };
102
+ }
103
+ catch (error) {
104
+ const message = error instanceof Error ? error.message : 'Unknown error';
105
+ yield {
106
+ type: 'action:todo_write:result',
107
+ data: {
108
+ success: false,
109
+ error: message,
110
+ output: message,
111
+ },
112
+ meta: resultMeta,
113
+ };
114
+ }
115
+ });
116
+ builder.on('action:todo_read', async function* (event, context) {
117
+ const resultMeta = { ...(event.meta || {}), agentId: context.state.agentId };
118
+ try {
119
+ const channelId = context.state.channelId;
120
+ const threadId = context.state.threadId;
121
+ if (!channelId || !threadId) {
122
+ throw new Error('Missing channelId or threadId for todo_read');
123
+ }
124
+ const list = await todoService.getTodos({ channelId, threadId });
125
+ yield {
126
+ type: 'action:todo_read:result',
127
+ data: { success: true, list, output: formatTodoOutput(list) },
128
+ meta: resultMeta,
129
+ };
130
+ }
131
+ catch (error) {
132
+ const message = error instanceof Error ? error.message : 'Unknown error';
133
+ yield {
134
+ type: 'action:todo_read:result',
135
+ data: {
136
+ success: false,
137
+ error: message,
138
+ output: message,
139
+ },
140
+ meta: resultMeta,
141
+ };
142
+ }
143
+ });
51
144
  },
52
145
  };
53
146
  export default todoPlugin;
@@ -0,0 +1,93 @@
1
+ import fs from 'node:fs/promises';
2
+ import path from 'node:path';
3
+ import { DEFAULT_CHANNELS_DIR, getBaseDir, resolvePath } from '../../app/config.js';
4
+ export const MAX_TODO_ITEMS = 20;
5
+ const TODO_STATUSES = new Set([
6
+ 'pending',
7
+ 'in_progress',
8
+ 'completed',
9
+ 'cancelled',
10
+ ]);
11
+ const getThreadDir = (channelId, threadId) => {
12
+ const base = resolvePath(path.join(getBaseDir(), DEFAULT_CHANNELS_DIR, channelId));
13
+ return path.join(base, 'threads', threadId);
14
+ };
15
+ const getTodosPath = (channelId, threadId) => path.join(getThreadDir(channelId, threadId), 'todos.json');
16
+ const emptyList = () => ({
17
+ items: [],
18
+ updatedAt: new Date().toISOString(),
19
+ });
20
+ /**
21
+ * Validate and normalize a todo list write. Throws on invalid input.
22
+ * Enforces: non-empty content, known statuses, unique ids, max size,
23
+ * and at most one `in_progress` item.
24
+ */
25
+ export function validateTodoItems(items) {
26
+ if (!Array.isArray(items)) {
27
+ throw new Error('todos must be an array');
28
+ }
29
+ if (items.length > MAX_TODO_ITEMS) {
30
+ throw new Error(`At most ${MAX_TODO_ITEMS} todos allowed`);
31
+ }
32
+ const seen = new Set();
33
+ let inProgressCount = 0;
34
+ const normalized = [];
35
+ for (const raw of items) {
36
+ if (!raw || typeof raw !== 'object') {
37
+ throw new Error('Each todo must be an object');
38
+ }
39
+ const id = typeof raw.id === 'string' ? raw.id.trim() : '';
40
+ const content = typeof raw.content === 'string' ? raw.content.trim() : '';
41
+ const status = raw.status;
42
+ if (!id)
43
+ throw new Error('Each todo requires a non-empty id');
44
+ if (!content)
45
+ throw new Error(`Todo "${id}" requires non-empty content`);
46
+ if (!TODO_STATUSES.has(status)) {
47
+ throw new Error(`Todo "${id}" has invalid status "${String(status)}"; expected pending|in_progress|completed|cancelled`);
48
+ }
49
+ if (seen.has(id))
50
+ throw new Error(`Duplicate todo id "${id}"`);
51
+ seen.add(id);
52
+ if (status === 'in_progress')
53
+ inProgressCount += 1;
54
+ normalized.push({ id, content, status: status });
55
+ }
56
+ if (inProgressCount > 1) {
57
+ throw new Error('At most one todo may be in_progress');
58
+ }
59
+ return normalized;
60
+ }
61
+ export const todoService = {
62
+ getTodos: async (args) => {
63
+ const filePath = getTodosPath(args.channelId, args.threadId);
64
+ try {
65
+ const raw = await fs.readFile(filePath, 'utf-8');
66
+ const parsed = JSON.parse(raw);
67
+ const items = Array.isArray(parsed.items) ? parsed.items : [];
68
+ return {
69
+ items,
70
+ updatedAt: typeof parsed.updatedAt === 'string' ? parsed.updatedAt : new Date().toISOString(),
71
+ };
72
+ }
73
+ catch (e) {
74
+ if (e?.code === 'ENOENT')
75
+ return emptyList();
76
+ throw e;
77
+ }
78
+ },
79
+ writeTodos: async (args) => {
80
+ const items = validateTodoItems(args.items);
81
+ const list = {
82
+ items,
83
+ updatedAt: new Date().toISOString(),
84
+ };
85
+ const threadDir = getThreadDir(args.channelId, args.threadId);
86
+ await fs.mkdir(threadDir, { recursive: true });
87
+ const filePath = getTodosPath(args.channelId, args.threadId);
88
+ const tmp = `${filePath}.tmp`;
89
+ await fs.writeFile(tmp, `${JSON.stringify(list, null, 2)}\n`, 'utf-8');
90
+ await fs.rename(tmp, filePath);
91
+ return list;
92
+ },
93
+ };
@@ -36,7 +36,14 @@ export const uiPlugin = {
36
36
  id: z.string(),
37
37
  label: z.string(),
38
38
  description: z.string().optional(),
39
- status: z.enum(['pending', 'in_progress', 'done', 'error', 'cancelled']).optional(),
39
+ status: z
40
+ .string()
41
+ .optional()
42
+ .describe('Status label shown on the item (e.g. "Pending", "Shipped").'),
43
+ statusVariant: z
44
+ .enum(['default', 'success', 'warning', 'danger', 'info'])
45
+ .optional()
46
+ .describe('Semantic hint for status badge coloring in the client.'),
40
47
  metadata: z.record(z.string(), z.any()).optional()
41
48
  })).optional().describe('Required for kind="list". List of items to display.'),
42
49
  submitLabel: z.string().optional().describe('Label for the primary action button (e.g. "Submit", "Save").')
@@ -0,0 +1,101 @@
1
+ import { DEFAULT_MARKETPLACE_REGISTRY_URL, loadConfig, } from '../../app/config.js';
2
+ import { isCloudMode } from '../../app/cloud-mode.js';
3
+ let cachedRegistry = null;
4
+ let cacheUrl = null;
5
+ function getRegistryUrl() {
6
+ const { marketplaceRegistryUrl } = loadConfig();
7
+ return marketplaceRegistryUrl?.trim() || DEFAULT_MARKETPLACE_REGISTRY_URL;
8
+ }
9
+ export async function resolveModelRegistry() {
10
+ const url = getRegistryUrl();
11
+ if (cachedRegistry && cacheUrl === url)
12
+ return cachedRegistry;
13
+ try {
14
+ const res = await fetch(url, {
15
+ headers: { Accept: 'application/json' },
16
+ signal: AbortSignal.timeout(15000),
17
+ });
18
+ if (!res.ok) {
19
+ throw new Error(`Registry HTTP ${res.status} ${res.statusText}`);
20
+ }
21
+ cachedRegistry = (await res.json());
22
+ cacheUrl = url;
23
+ return cachedRegistry;
24
+ }
25
+ catch (err) {
26
+ console.warn('[model-registry] fetch failed:', err instanceof Error ? err.message : err);
27
+ return { providers: {} };
28
+ }
29
+ }
30
+ export function listModelOptionsFromRegistry(registry) {
31
+ const providers = registry.providers ?? {};
32
+ const out = [];
33
+ for (const [providerId, provider] of Object.entries(providers)) {
34
+ for (const model of provider.models ?? []) {
35
+ out.push({
36
+ value: `${providerId}/${model.id}`,
37
+ label: `${provider.label} — ${model.label}`,
38
+ description: model.description,
39
+ provider: providerId,
40
+ });
41
+ }
42
+ }
43
+ return out;
44
+ }
45
+ export async function listRegistryModelOptions() {
46
+ const registry = await resolveModelRegistry();
47
+ return listModelOptionsFromRegistry(registry);
48
+ }
49
+ export function listApiKeyProvidersFromRegistry(registry) {
50
+ const providers = registry.providers ?? {};
51
+ return Object.entries(providers).map(([id, provider]) => ({
52
+ id,
53
+ label: provider.label,
54
+ }));
55
+ }
56
+ function pickDefaultModelValue(options) {
57
+ if (options.length === 0)
58
+ return undefined;
59
+ const values = options.map((option) => option.value);
60
+ const preferred = isCloudMode()
61
+ ? values.find((value) => value.startsWith('openbot/'))
62
+ : values.find((value) => value.startsWith('openai/'));
63
+ return preferred ?? values[0];
64
+ }
65
+ export function enrichOpenbotPluginDescriptor(descriptor, modelOptions) {
66
+ if (descriptor.id !== 'openbot' || !descriptor.configSchema)
67
+ return descriptor;
68
+ const modelProperty = descriptor.configSchema.properties.model;
69
+ if (!modelProperty)
70
+ return descriptor;
71
+ const values = modelOptions.map((option) => option.value);
72
+ const staticDefault = typeof modelProperty.default === 'string' ? modelProperty.default : undefined;
73
+ const defaultModel = staticDefault && values.includes(staticDefault)
74
+ ? staticDefault
75
+ : pickDefaultModelValue(modelOptions) ?? staticDefault;
76
+ const nextModelProperty = {
77
+ ...modelProperty,
78
+ description: 'Model from the hosted marketplace registry.',
79
+ };
80
+ if (values.length > 0) {
81
+ nextModelProperty.enum = values;
82
+ nextModelProperty.options = modelOptions.map((option) => ({
83
+ label: option.label,
84
+ value: option.value,
85
+ description: option.description,
86
+ }));
87
+ }
88
+ if (defaultModel) {
89
+ nextModelProperty.default = defaultModel;
90
+ }
91
+ return {
92
+ ...descriptor,
93
+ configSchema: {
94
+ ...descriptor.configSchema,
95
+ properties: {
96
+ ...descriptor.configSchema.properties,
97
+ model: nextModelProperty,
98
+ },
99
+ },
100
+ };
101
+ }
@@ -6,10 +6,12 @@ import { bashPlugin } from '../../plugins/bash/index.js';
6
6
  import { storagePlugin } from '../../plugins/storage/index.js';
7
7
  import { approvalPlugin } from '../../plugins/approval/index.js';
8
8
  import { memoryPlugin } from '../../plugins/memory/index.js';
9
+ import { todoPlugin } from '../../plugins/todo/index.js';
9
10
  import { delegationPlugin } from '../../plugins/delegation/index.js';
10
11
  import { uiPlugin } from '../../plugins/ui/index.js';
11
12
  import { pluginManagerPlugin } from '../../plugins/plugin-manager/index.js';
12
- import { DEFAULT_PLUGINS_DIR, DEFAULT_BASE_DIR, loadConfig, resolvePath } from '../../app/config.js';
13
+ import { previewPlugin } from '../../plugins/preview/index.js';
14
+ import { DEFAULT_PLUGINS_DIR, getBaseDir } from '../../app/config.js';
13
15
  import { invalidatePlugin as clearResolvedPluginEntry, loadedCommunityPlugins, resolvedPluginCache, } from './plugin-cache.js';
14
16
  let pluginsDir = null;
15
17
  const BUILT_IN = {
@@ -18,9 +20,11 @@ const BUILT_IN = {
18
20
  [storagePlugin.id]: storagePlugin,
19
21
  [approvalPlugin.id]: approvalPlugin,
20
22
  [memoryPlugin.id]: memoryPlugin,
23
+ [todoPlugin.id]: todoPlugin,
21
24
  [delegationPlugin.id]: delegationPlugin,
22
25
  [uiPlugin.id]: uiPlugin,
23
26
  [pluginManagerPlugin.id]: pluginManagerPlugin,
27
+ [previewPlugin.id]: previewPlugin,
24
28
  };
25
29
  /** Normalize a dynamically imported plugin module. Supports `plugin`, `default`. */
26
30
  export function parsePluginModule(module) {
@@ -51,9 +55,7 @@ export function initPlugins(dir) {
51
55
  pluginsDir = dir;
52
56
  }
53
57
  else {
54
- const config = loadConfig();
55
- const baseDir = config.baseDir || DEFAULT_BASE_DIR;
56
- pluginsDir = path.join(resolvePath(baseDir), DEFAULT_PLUGINS_DIR);
58
+ pluginsDir = path.join(getBaseDir(), DEFAULT_PLUGINS_DIR);
57
59
  }
58
60
  }
59
61
  /**
@@ -3,7 +3,7 @@ import { existsSync } from 'node:fs';
3
3
  import path from 'node:path';
4
4
  import { exec } from 'node:child_process';
5
5
  import { promisify } from 'node:util';
6
- import { DEFAULT_PLUGINS_DIR, DEFAULT_BASE_DIR, DEFAULT_MARKETPLACE_REGISTRY_URL, loadConfig, resolvePath, } from '../../app/config.js';
6
+ import { DEFAULT_PLUGINS_DIR, DEFAULT_MARKETPLACE_REGISTRY_URL, getBaseDir, loadConfig, } from '../../app/config.js';
7
7
  import { invalidatePlugin } from './plugin-cache.js';
8
8
  const execAsync = promisify(exec);
9
9
  const DEFAULT_MARKETPLACE_AGENTS = [];
@@ -136,11 +136,7 @@ export async function resolveMarketplaceAgentList() {
136
136
  const registry = await resolveMarketplaceRegistry();
137
137
  return registry.agents;
138
138
  }
139
- const getPluginsDir = () => {
140
- const config = loadConfig();
141
- const baseDir = resolvePath(config.baseDir || DEFAULT_BASE_DIR);
142
- return path.join(baseDir, DEFAULT_PLUGINS_DIR);
143
- };
139
+ const getPluginsDir = () => path.join(getBaseDir(), DEFAULT_PLUGINS_DIR);
144
140
  /**
145
141
  * Lifecycle for community-built plugins distributed via npm.
146
142
  * Each plugin is installed to `<plugins>/<npm-name>/` and is identified
package/docs/agents.md CHANGED
@@ -36,8 +36,8 @@ A runtime plugin is one that handles `agent:invoke` (the LLM loop). Without
36
36
  one, the agent will not respond to user input. Built-in runtime plugins:
37
37
 
38
38
  - `openbot` — the standard, opinionated OpenBot agent runtime. It is
39
- **batteries-included** and provides inbuilt tools (bash, memory, storage,
40
- delegation, and approval).
39
+ **batteries-included** and provides inbuilt tools (bash, memory, todo,
40
+ storage, delegation, and approval).
41
41
  - `claude-code` — runs Claude inside the Claude Agent SDK with its own tools.
42
42
  - `gemini-cli` — spawns Google's `gemini` CLI in headless mode.
43
43
 
@@ -66,6 +66,24 @@ On every LLM turn the runtime injects matching memories into the system prompt
66
66
  via the `MemoryProvider` in the context engine, so the model treats remembered
67
67
  facts as ground truth without needing to call `recall` first.
68
68
 
69
+ ## Todos
70
+
71
+ The `todo` plugin gives agents `todo_write` and `todo_read` for thread-scoped
72
+ multi-step task tracking. The list is stored at
73
+ `~/.openbot/channels/<channelId>/threads/<threadId>/todos.json`.
74
+
75
+ Rules enforced by the runtime:
76
+
77
+ - At most 20 items
78
+ - At most one item may be `in_progress`
79
+ - Each `todo_write` replaces the full list
80
+
81
+ On every LLM turn the current list is injected into context as `## TODOS`, so
82
+ the model usually does not need `todo_read`. Each successful `todo_write` also
83
+ emits a `client:ui:widget` list (`widgetId` `todos:<runId>`, stable for the
84
+ agent run so multiple `todo_write` calls update one widget), and both tools return
85
+ `data.output` for model feedback.
86
+
69
87
  ## Installing community agents
70
88
 
71
89
  Marketplace entries reference plugin ids (built-in or npm package names).
@@ -5,7 +5,7 @@ OpenBot is an orchestration platform built on a modular, event-driven architectu
5
5
  ## Core Components
6
6
 
7
7
  ### 1. Orchestrator & routing
8
- The orchestrator is the execution entry point for agent work: it normalizes incoming events, runs the queue processor (todo-driven assignees), builds per-agent Melony runtimes, and streams emitted events back to callers (for example storage and SSE). Routing across the agent network uses:
8
+ The orchestrator is the execution entry point for agent work: it normalizes incoming events, builds per-agent Melony runtimes, and streams emitted events back to callers (for example storage and SSE). Routing across the agent network uses:
9
9
 
10
10
  1. **Command Prefix** — Explicit delegation to a specific agent (e.g., `/os list files`).
11
11
  2. **DM context** — Direct communication with a specific agent.