@dxos/assistant-toolkit 0.8.4-main.bc674ce → 0.8.4-main.bcb3aa67d6

package/src/blueprints/project/functions/qualifier.ts

@@ -0,0 +1,90 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import * as LanguageModel from '@effect/ai/LanguageModel';
+import * as Prompt from '@effect/ai/Prompt';
+import * as Effect from 'effect/Effect';
+import * as Schema from 'effect/Schema';
+
+import { AiService } from '@dxos/ai';
+import { Database, Obj, Ref } from '@dxos/echo';
+import { invariant } from '@dxos/invariant';
+import { Operation } from '@dxos/operation';
+import { trim } from '@dxos/util';
+
+import { Qualifier } from './definitions';
+import { Plan, Project } from '../../../types';
+
+export default Qualifier.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(
+      function* ({ project: projectRef, event }) {
+        const project = yield* Database.load(projectRef);
+        invariant(Obj.instanceOf(Project.Project, project));
+        invariant(project.chat, 'Project has no chat.');
+
+        const { id, name, queue } = project;
+        if (!queue) {
+          throw new Error('Project has no queue.');
+        }
+
+        const plan = yield* Database.load(project.plan);
+        const spec = yield* Database.load(project.spec);
+
+        const { value } = yield* Effect.scoped(
+          LanguageModel.generateObject({
+            schema: Schema.Struct({
+              isRelevant: Schema.Boolean,
+            }),
+            prompt: Prompt.fromMessages([
+              Prompt.systemMessage({
+                content: trim`
+                  You are a qualifying agent that determines if the event is relevant to the project.
+                  Respond with true if the event is relevant to the project, false otherwise.
+                  If you are not sure, return true.
+                  The qualified events will be forwarded to the larger agent that will process them.
+                  <project id="${id}" name="${name}">
+                    <spec>
+                    ${spec.content}
+                    </spec>
+                    <plan>
+                      ${Plan.formatPlan(plan)}
+                    </plan>
+                  </project>
+                `,
+              }),
+              Prompt.userMessage({
+                content: [
+                  Prompt.makePart('text', {
+                    text: trim`
+                      <event>
+                        ${JSON.stringify(event, null, 2)}
+                      </event>
+                    `,
+                  }),
+                ],
+              }),
+            ]),
+          }),
+        );
+
+        const { isRelevant } = value as { isRelevant: boolean };
+
+        if (isRelevant) {
+          const queueTarget = yield* Database.load(queue);
+          if ('queue' in event && event.item) {
+            const obj = event.item;
+            yield* Effect.promise(() => queueTarget.append([obj]));
+          } else if ('subject' in event && Ref.isRef(event.subject)) {
+            const obj = yield* Database.load(event.subject);
+            yield* Effect.promise(() => queueTarget.append([obj]));
+          } else {
+            throw new Error('Invalid event.');
+          }
+        }
+      },
+      Effect.provide(AiService.model('@anthropic/claude-sonnet-4-5')),
+    ),
+  ),
+);

package/src/blueprints/project/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export { default as ProjectBlueprint } from './blueprint';
+export { Agent, Qualifier, GetContext, AddArtifact, ProjectHandlers } from './functions';
+export { syncProjectTriggers } from './sync-triggers';

package/src/blueprints/project/sync-triggers.ts

@@ -0,0 +1,149 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+import * as Option from 'effect/Option';
+
+import { Database, Feed, Filter, Obj, Ref } from '@dxos/echo';
+import { Trigger } from '@dxos/functions';
+import { Operation } from '@dxos/operation';
+import { FeedAnnotation } from '@dxos/schema';
+
+import { Agent, Qualifier } from './functions/definitions';
+import { Project } from '../../types';
+
+/**
+ * Foreign key {@link PROJECT_TRIGGER_EXTENSION_KEY} => <project id : ObjectId>.
+ */
+const PROJECT_TRIGGER_EXTENSION_KEY = 'org.dxos.extension.ProjectTrigger';
+
+/**
+ * Foreign key {@link PROJECT_TRIGGER_TARGET_EXTENSION_KEY} => <dxn string of subscription target>.
+ */
+const PROJECT_TRIGGER_TARGET_EXTENSION_KEY = 'org.dxos.extension.ProjectTriggerTarget';
+
+/** Checks if an object's schema has the FeedAnnotation. */
+const hasFeedAnnotation = (obj: Obj.Unknown): boolean => {
+  const schema = Obj.getSchema(obj);
+  if (!schema) {
+    return false;
+  }
+  const annotation = FeedAnnotation.get(schema);
+  return Option.isSome(annotation) && annotation.value === true;
+};
+
+/**
+ * Syncs triggers in the database with the project subscriptions.
+ *
+ * @param project - The project whose triggers should be synced.
+ * @returns An Effect that syncs triggers.
+ */
+export const syncProjectTriggers = (project: Project.Project): Effect.Effect<void, never, Database.Service> =>
+  Effect.gen(function* () {
+    const triggers = yield* Database.runQuery(
+      Filter.foreignKeys(Trigger.Trigger, [{ source: PROJECT_TRIGGER_EXTENSION_KEY, id: project.id }]),
+    );
+
+    for (const trigger of triggers) {
+      const target = Obj.getKeys(trigger, PROJECT_TRIGGER_TARGET_EXTENSION_KEY).at(0)?.id;
+
+      const exists = project.subscriptions.find((subscription) => subscription.dxn.toString() === target);
+      if (!exists && !(project.useQualifyingAgent && target === Obj.getDXN(project)?.toString())) {
+        yield* Database.remove(trigger);
+      }
+    }
+
+    for (const subscription of project.subscriptions) {
+      const relevantTrigger = triggers.find((trigger) =>
+        Obj.getKeys(trigger, PROJECT_TRIGGER_TARGET_EXTENSION_KEY).some(
+          (key) => key.id === subscription.dxn.toString(),
+        ),
+      );
+      if (relevantTrigger) {
+        continue;
+      }
+
+      const targetOption = yield* Database.loadOption(subscription);
+      if (Option.isNone(targetOption)) {
+        continue;
+      }
+      const target = targetOption.value;
+
+      let feedObj: Feed.Feed | undefined;
+      if (Obj.instanceOf(Feed.Feed, target)) {
+        feedObj = target;
+      } else if (hasFeedAnnotation(target)) {
+        const feedRef = (target as Obj.Unknown & { feed?: Ref.Ref<Feed.Feed> }).feed;
+        feedObj = feedRef ? Option.getOrUndefined(yield* Database.loadOption(feedRef)) : undefined;
+      }
+
+      const queueDxn = Option.fromNullable(feedObj).pipe(
+        Option.filter(Obj.instanceOf(Feed.Feed)),
+        Option.map(Feed.getQueueDxn),
+        Option.getOrUndefined,
+      );
+      if (!queueDxn) {
+        continue;
+      }
+
+      yield* Database.add(
+        Trigger.make({
+          [Obj.Parent]: project,
+          [Obj.Meta]: {
+            keys: [
+              { source: PROJECT_TRIGGER_EXTENSION_KEY, id: project.id },
+              { source: PROJECT_TRIGGER_TARGET_EXTENSION_KEY, id: subscription.dxn.toString() },
+            ],
+          },
+          enabled: true,
+          spec: {
+            kind: 'queue',
+            queue: queueDxn.toString(),
+          },
+          function: Ref.make(Operation.serialize(project.useQualifyingAgent ? Qualifier : Agent)),
+          input: {
+            project: Ref.make(project),
+            event: '{{event}}',
+          },
+          concurrency: project.useQualifyingAgent ? 5 : undefined,
+        }),
+      );
+    }
+
+    if (project.useQualifyingAgent) {
+      const qualifierTrigger = triggers.find((trigger) =>
+        Obj.getKeys(trigger, PROJECT_TRIGGER_TARGET_EXTENSION_KEY).some(
+          (key) => key.id === Obj.getDXN(project)?.toString(),
+        ),
+      );
+      if (!qualifierTrigger && project.queue) {
+        yield* Database.add(
+          Trigger.make({
+            [Obj.Parent]: project,
+            [Obj.Meta]: {
+              keys: [
+                { source: PROJECT_TRIGGER_EXTENSION_KEY, id: project.id },
+                {
+                  source: PROJECT_TRIGGER_TARGET_EXTENSION_KEY,
+                  id: Obj.getDXN(project)?.toString() ?? '',
+                },
+              ],
+            },
+            function: Ref.make(Operation.serialize(Agent)),
+            enabled: true,
+            spec: {
+              kind: 'queue',
+              queue: project.queue.dxn.toString(),
+            },
+            input: {
+              project: Ref.make(project),
+              event: '{{event}}',
+            },
+          }),
+        );
+      }
+    }
+
+    yield* Database.flush();
+  });

package/src/blueprints/project-wizard/blueprint.ts

@@ -0,0 +1,43 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { type AppCapabilities } from '@dxos/app-toolkit';
+import { Blueprint, Template } from '@dxos/blueprints';
+import { trim } from '@dxos/util';
+
+import { ProjectRules, CreateProject } from './functions';
+
+const BLUEPRINT_KEY = 'org.dxos.blueprint.project-wizard';
+
+/**
+ * Creates the Project blueprint. This is a function to avoid circular dependency issues.
+ */
+const make = () =>
+  Blueprint.make({
+    key: BLUEPRINT_KEY,
+    name: 'Project Wizard',
+    description: 'Help the user create a new project.',
+    agentCanEnable: true,
+    instructions: Template.make({
+      source: trim`
+        You are a wizard that helps the user create a new project.
+
+        Projects are goal oriented and autonomously driven by the agent.
+        Each project has a spec - the goal of the project.
+        The spec also typically describes what actions to perform in reaction to events (emails).
+        The project has a number of associated artifacts to work with. 
+        Projects can subscribe to emails.
+
+        IMPORTANT: Before attempting to create a project call the [project-rules] tool to get the rules for creating a project.
+      `,
+    }),
+    tools: Blueprint.toolDefinitions({ operations: [ProjectRules, CreateProject] }),
+  });
+
+const blueprint: AppCapabilities.BlueprintDefinition = {
+  key: BLUEPRINT_KEY,
+  make,
+};
+
+export default blueprint;

package/src/blueprints/project-wizard/functions/create-project.ts

@@ -0,0 +1,33 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Blueprint } from '@dxos/blueprints';
+import { Obj, Ref } from '@dxos/echo';
+import { Operation } from '@dxos/operation';
+
+import { CreateProject } from './definitions';
+import { Project } from '../../../types';
+import { ProjectBlueprint, syncProjectTriggers } from '../../project';
+
+export default CreateProject.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* ({ name, spec, blueprints, subscriptions }) {
+      const project = yield* Project.makeInitialized(
+        {
+          name,
+          spec,
+          blueprints: yield* Effect.forEach(blueprints, (key) =>
+            Blueprint.upsert(key).pipe(Effect.map(Ref.make), Effect.orDie),
+          ),
+          subscriptions,
+        },
+        Obj.clone(ProjectBlueprint.make()),
+      );
+      yield* syncProjectTriggers(project);
+      return project;
+    }),
+  ),
+);

package/src/blueprints/project-wizard/functions/definitions.ts

@@ -0,0 +1,48 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { Blueprint } from '@dxos/blueprints';
+import { Database, Obj, Ref } from '@dxos/echo';
+import { QueueService } from '@dxos/functions';
+import { Operation } from '@dxos/operation';
+
+import { Project } from '../../../types';
+
+export const ProjectRules = Operation.make({
+  meta: {
+    key: 'org.dxos.function.project-wizard.project-rules',
+    name: 'Project rules',
+    description: 'Gets the rules for creating a project.',
+  },
+  input: Schema.Struct({}),
+  output: Schema.String,
+});
+
+export const CreateProject = Operation.make({
+  meta: {
+    key: 'org.dxos.function.project-wizard.create-project',
+    name: 'Create project',
+    description: 'Creates a new project.',
+  },
+  input: Schema.Struct({
+    name: Schema.String.annotations({
+      description: 'The name of the project to create.',
+    }),
+    spec: Schema.String.annotations({
+      description:
+        'The goal of the project. Be specic but not to verbose. The agent will use this as a core objective and set of rules to follow.',
+    }),
+    blueprints: Schema.Array(Schema.String).annotations({
+      description: 'The keys blueprints to use for the project.',
+      examples: [['org.dxos.blueprint.markdown', 'org.dxos.blueprint.database']],
+    }),
+    subscriptions: Schema.Array(Ref.Ref(Obj.Unknown)).annotations({
+      description: 'The objects to subscribe to for the project. Can be references to mailboxes.',
+    }),
+  }),
+  output: Project.Project,
+  services: [Blueprint.RegistryService, Database.Service, QueueService],
+});

package/src/blueprints/project-wizard/functions/index.ts

@@ -0,0 +1,12 @@
+//
+// Copyright 2026 DXOS.org
+//
+
+import { OperationHandlerSet } from '@dxos/operation';
+
+export * from './definitions';
+
+export const ProjectWizardHandlers = OperationHandlerSet.lazy(
+  () => import('./create-project'),
+  () => import('./project-rules'),
+);

package/src/blueprints/project-wizard/functions/project-rules.ts

@@ -0,0 +1,76 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Operation } from '@dxos/operation';
+import { trim } from '@dxos/util';
+
+import { ProjectRules } from './definitions';
+
+export default ProjectRules.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* () {
+      return trim`
+        You can ask the user for qualifying questions about the projects.
+        If projects should actively read incoming emails, query for mailboxes and add a subscription to them.
+        Use [query-blueprints] from the Blueprint Manager to query for available blueprints and their keys.
+        Use [create-project] function to create a new project.
+        After creating a project, explicitly remind the user to enable local triggers so the project can be driven autonomously.
+
+        Notable blueprints (query to get their keys):
+
+        - Database -- CRUD on objects in the ECHO database.
+        - Markdown -- Create and edit markdown documents.
+        - Websearch -- Search the web for information.
+        - Browser -- Virtual browser via playwright when simple WebSearch is not enough.
+        - Memory -- Memory to store and retrieve information.
+
+        Experimental blueprints that are discoraged:
+
+        - Research
+        - Design
+        - Project (not wizard) -- those are project internals, they are auto-added to every new project.
+
+        <example_project>
+          ## CRM from your inbox
+
+          Blueprints: database, websearch, browser
+
+          Subscribe to your inboxes.
+          Spec says that on every email we should extract People and Organizations and save them to the database, but first query the database for existing people and organizations to avoid duplicates.
+          Also run a quick research on the web to find more information about the person or organization and save it to the database.
+        </example_project>
+
+        <example_project>
+          ## Parcel tracking
+
+          Blueprints: database
+
+          Based on emails from vendors (amazon, fedex, etc.) track the status of the parcels ordered online and keep a table of orders.
+
+          Before creating a project, use the Database blueprint to create an Order schema:
+            - seller
+            - name
+            - price
+            - status (enum of: pending, shipped, waiting for pickup, delivered, cancelled, returned)
+            - tracking numbers/notes
+            - date of delivery
+            - shipping address
+        </example_project>
+
+        <example_project>
+          ## Comms assistant
+
+          Blueprints: database, markdown, inbox
+
+          Helps user maintain comms with external parites via email.
+          Ask user specifically who they want to communicate with and on what topic.
+          Project should keep a markdown document in artifacts outlining the current state of the comms.
+          Project should propose drafts to follow up on the comms. Only propose sensible drafts, do not propose drafts that are not relevant or actionable.
+        </example_project>
+      `;
+    }),
+  ),
+);

package/src/blueprints/project-wizard/index.ts

@@ -0,0 +1,6 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export { default as ProjectWizardBlueprint } from './blueprint';
+export { ProjectRules, CreateProject, ProjectWizardHandlers } from './functions';

package/src/blueprints/research/{research-blueprint.ts → blueprint.ts}

@@ -2,13 +2,15 @@
 // Copyright 2025 DXOS.org
 //
 
-import { ToolId } from '@dxos/ai';
+import { type AppCapabilities } from '@dxos/app-toolkit';
 import { Blueprint } from '@dxos/blueprints';
 import { Ref } from '@dxos/echo';
 import { Text } from '@dxos/schema';
 import { trim } from '@dxos/util';
 
-import { Research } from '../../functions';
+import { Research, DocumentCreate } from './functions';
+
+const BLUEPRINT_KEY = 'org.dxos.blueprint.research';
 
 /**
  * Agent prompt instructions for managing hierarchical task lists.
@@ -20,7 +22,7 @@ const instructions = trim`
   Structured data extraction is an experimental feature -- only enable it if the user explicitly requests it in the prompt.
   Prefer updating existing notes instead of creating new ones.
 
-  <strcutured_mode>
+  <structured_mode>
     When you are done, reply with the created objects.
     Do not print the data, instead reply with inline references to the created objects.
     Those will be later substituted with the pills representing the created objects.
@@ -40,12 +42,20 @@ const instructions = trim`
   </unstructured_mode>
 `;
 
-export const blueprint = Blueprint.make({
-  key: 'dxos.org/blueprint/research',
-  name: 'Research',
-  description: 'Researches the web and creates structured data.',
-  instructions: {
-    source: Ref.make(Text.make(instructions)),
-  },
-  tools: [Research.create, Research.research].map((fn) => ToolId.make(fn.key)),
-});
+const make = () =>
+  Blueprint.make({
+    key: BLUEPRINT_KEY,
+    name: 'Research',
+    description: 'Researches the web and creates structured data.',
+    instructions: {
+      source: Ref.make(Text.make(instructions)),
+    },
+    tools: Blueprint.toolDefinitions({ operations: [DocumentCreate, Research] }),
+  });
+
+const blueprint: AppCapabilities.BlueprintDefinition = {
+  key: BLUEPRINT_KEY,
+  make,
+};
+
+export default blueprint;

package/src/blueprints/research/functions/definitions.ts

@@ -0,0 +1,87 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Schema from 'effect/Schema';
+
+import { AiService } from '@dxos/ai';
+import { Database, Obj, Ref } from '@dxos/echo';
+import { FunctionInvocationService, TracingService } from '@dxos/functions';
+import { Operation } from '@dxos/operation';
+import { trim } from '@dxos/util';
+
+export const Research = Operation.make({
+  meta: {
+    key: 'org.dxos.function.research',
+    name: 'Research',
+    description: trim`
+      Search the web to research information about the given subject.
+      Inserts structured data into the research graph. 
+      Creates a research summary and returns the objects created.
+    `,
+  },
+  input: Schema.Struct({
+    query: Schema.String.annotations({
+      description: trim`
+        The search query.
+        If doing research on an object then load it first and pass it as JSON.
+      `,
+    }),
+    instructions: Schema.optional(Schema.String).annotations({
+      description: trim`
+        The instructions for the research agent. 
+      `,
+    }),
+    // TOOD(burdon): Move to context.
+    mockSearch: Schema.optional(Schema.Boolean).annotations({
+      description: 'Whether to use the mock search tool.',
+      default: false,
+    }),
+    entityExtraction: Schema.optional(Schema.Boolean).annotations({
+      description: trim`
+        Whether to extract structured entities from the research. 
+        Experimental feature only enable if user explicitly requests it.
+      `,
+      default: false,
+    }),
+  }),
+  output: Schema.Struct({
+    document: Schema.optional(Schema.String).annotations({
+      description: 'The generated research document.',
+    }),
+    objects: Schema.Array(Schema.Unknown).annotations({
+      description: 'Structured objects created during the research process.',
+    }),
+  }),
+  services: [AiService.AiService, Database.Service, TracingService, FunctionInvocationService],
+});
+
+export const DocumentCreate = Operation.make({
+  meta: {
+    key: 'org.dxos.function.research.document-create',
+    name: 'Create research document',
+    description: 'Creates a note summarizing the research.',
+  },
+  input: Schema.Struct({
+    subject: Ref.Ref(Obj.Unknown).annotations({
+      description: trim`
+        ID of the object (organization, contact, etc.) for which the research was performed. 
+      `,
+    }),
+    name: Schema.String.annotations({
+      description: 'Name of the document.',
+    }),
+    content: Schema.String.annotations({
+      description: trim`
+        Content of the note. 
+        Supports (and are prefered) references to research objects using @ syntax and <object> tags (refer to research blueprint instructions).
+      `,
+    }),
+  }),
+  output: Schema.Struct({
+    document: Schema.String.annotations({
+      description: 'DXN of the created document.',
+    }),
+  }),
+  services: [Database.Service, TracingService],
+});

package/src/blueprints/research/functions/document-create.ts

@@ -0,0 +1,50 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Effect from 'effect/Effect';
+
+import { Database, Obj, Relation } from '@dxos/echo';
+import { TracingService } from '@dxos/functions';
+import { log } from '@dxos/log';
+import { Operation } from '@dxos/operation';
+import { Markdown } from '@dxos/plugin-markdown/types';
+import { HasSubject } from '@dxos/types';
+
+import { DocumentCreate } from './definitions';
+
+export default DocumentCreate.pipe(
+  Operation.withHandler(
+    Effect.fnUntraced(function* ({ subject, name, content }) {
+      log.info('Creating research document', { subject, name, content });
+
+      // TODO(burdon): Auto flush before and after calling function?
+      yield* Database.flush();
+      yield* TracingService.emitStatus({ message: 'Creating research document...' });
+
+      const target = yield* Database.load(subject);
+
+      const object = yield* Database.add(
+        Markdown.make({
+          name,
+          content,
+        }),
+      );
+
+      yield* Database.add(
+        Relation.make(HasSubject.HasSubject, {
+          [Relation.Source]: object,
+          [Relation.Target]: target,
+          completedAt: new Date().toISOString(),
+        }),
+      );
+
+      yield* Database.flush();
+      log.info('Created research document', { subject, object });
+
+      return {
+        document: Obj.getDXN(object).toString(),
+      };
+    }),
+  ),
+);

package/src/blueprints/research/functions/index.ts

@@ -0,0 +1,12 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { OperationHandlerSet } from '@dxos/operation';
+
+export * from './definitions';
+
+export const ResearchHandlers = OperationHandlerSet.lazy(
+  () => import('./document-create'),
+  () => import('./research'),
+);