@supermemory/eve 0.1.0

package/dist/tools/forget-matching.d.ts

@@ -0,0 +1,58 @@
+import type { SupermemoryDependencies } from "../lib/dependencies.js";
+export declare function createForgetMatchingTool(dependencies: SupermemoryDependencies): import("eve/tools").ToolDefinition<{
+    query?: string | undefined;
+    dryRun: boolean;
+    ids?: string[] | undefined;
+    threshold?: number | undefined;
+    maxForget?: number | undefined;
+    reason?: string | undefined;
+}, {
+    dryRun: true;
+    count: number;
+    forgetBatchId: null;
+    summary: string;
+    candidates: {
+        id: string;
+        memory: string;
+        score: number;
+    }[];
+} | {
+    dryRun: false;
+    count: number;
+    forgetBatchId: string | null;
+    summary: string;
+    forgotten: {
+        id: string;
+        memory: string;
+        score: number;
+    }[];
+}> & {
+    execute(input: {
+        query?: string | undefined;
+        dryRun: boolean;
+        ids?: string[] | undefined;
+        threshold?: number | undefined;
+        maxForget?: number | undefined;
+        reason?: string | undefined;
+    }, ctx: import("eve/tools").ToolContext): Promise<{
+        dryRun: true;
+        count: number;
+        forgetBatchId: null;
+        summary: string;
+        candidates: {
+            id: string;
+            memory: string;
+            score: number;
+        }[];
+    } | {
+        dryRun: false;
+        count: number;
+        forgetBatchId: string | null;
+        summary: string;
+        forgotten: {
+            id: string;
+            memory: string;
+            score: number;
+        }[];
+    }>;
+};

package/dist/tools/forget-matching.js

@@ -0,0 +1,47 @@
+import { defineTool } from "eve/tools";
+import { z } from "zod";
+import { forgetMatchingMemories } from "../lib/forget-matching.js";
+export function createForgetMatchingTool(dependencies) {
+    return defineTool({
+        description: "Forget every stored memory within a broad user-defined boundary. Use whenever the user wants to forget, delete, remove, or erase all, everything, or anything about a topic, person, project, or category. First call this tool with dryRun true and a precise query describing the complete boundary; this only previews the matching memories. Show the candidate count and enough candidate detail with ask_question so the user can choose whether to proceed. Their answer to ask_question is the confirmation boundary. When the user confirms, call this tool again with dryRun false and exactly the candidates[].id values returned by that preview, then report the finalized count. This removes derived memories; source documents remain available.",
+        inputSchema: z.object({
+            query: z
+                .string()
+                .trim()
+                .max(2_000)
+                .optional()
+                .describe("For dryRun true: a specific natural-language description of everything the user wants forgotten."),
+            dryRun: z
+                .boolean()
+                .default(true)
+                .describe("Use true to preview without changing anything. Use false only after the user confirms the exact IDs from that preview."),
+            ids: z
+                .array(z.string().trim().min(1).max(200))
+                .max(500)
+                .optional()
+                .describe("For dryRun false: the exact candidates[].id values returned by the preceding dry-run call."),
+            threshold: z
+                .number()
+                .min(0)
+                .max(1)
+                .optional()
+                .describe("Optional similarity floor from 0 to 1. Higher values narrow the preview."),
+            maxForget: z
+                .number()
+                .int()
+                .min(1)
+                .max(500)
+                .optional()
+                .describe("Optional maximum number of matching memories in the preview, up to 500."),
+            reason: z
+                .string()
+                .trim()
+                .max(500)
+                .optional()
+                .describe("An optional short reason recorded when memories are forgotten."),
+        }),
+        execute(input, ctx) {
+            return forgetMatchingMemories(input, ctx, dependencies);
+        },
+    });
+}

package/dist/tools/forget.d.ts

@@ -0,0 +1,10 @@
+import type { SupermemoryDependencies } from "../lib/dependencies.js";
+export declare function createForgetTool(dependencies: SupermemoryDependencies): import("eve/tools").ToolDefinition<{
+    memoryId: string;
+    reason?: string | undefined;
+}, import("supermemory/resources/memories.mjs").MemoryForgetResponse> & {
+    execute(input: {
+        memoryId: string;
+        reason?: string | undefined;
+    }, ctx: import("eve/tools").ToolContext): import("supermemory").APIPromise<import("supermemory/resources/memories.mjs").MemoryForgetResponse>;
+};

package/dist/tools/forget.js

@@ -0,0 +1,25 @@
+import { defineTool } from "eve/tools";
+import { z } from "zod";
+import { forgetMemory } from "../lib/forget-memory.js";
+export function createForgetTool(dependencies) {
+    return defineTool({
+        description: "Forget one specific stored memory. Use when the user says forget that, delete this from memory, remove what you know about this, do not retain this, or corrects a fact whose old version must be removed, and one unambiguous stored memory represents what they want deleted. First call search with scope memories unless the exact memory result is already available. Identify the result containing the memory field and pass its exact results[].id as memoryId. When the user identifies several specific memories, call this tool once for each exact ID. Use forget_matching when the request covers all, everything, anything about, or another broad topic, person, project, or category.",
+        inputSchema: z.object({
+            memoryId: z
+                .string()
+                .trim()
+                .min(1)
+                .max(200)
+                .describe("The exact results[].id from a search result containing a memory field."),
+            reason: z
+                .string()
+                .trim()
+                .max(500)
+                .optional()
+                .describe("An optional short reason recorded with the forgotten memory."),
+        }),
+        execute(input, ctx) {
+            return forgetMemory(input, ctx, dependencies);
+        },
+    });
+}

package/dist/tools/index.d.ts

@@ -0,0 +1,302 @@
+import type { SupermemoryDependencies } from "../lib/dependencies.js";
+export declare function createSupermemoryTools(dependencies: SupermemoryDependencies): {
+    search: import("eve/tools").ToolDefinition<{
+        query: string;
+        scope: "all" | "conversations" | "documents" | "memories";
+        customId?: string | undefined;
+    }, import("supermemory/resources/search.mjs").SearchMemoriesResponse> & {
+        execute(input: {
+            query: string;
+            scope: "all" | "conversations" | "documents" | "memories";
+            customId?: string | undefined;
+        }, ctx: import("eve/tools").ToolContext): Promise<import("supermemory/resources/search.mjs").SearchMemoriesResponse>;
+    };
+    read_session: import("eve/tools").ToolDefinition<{
+        documentId: string;
+        offset: number;
+    }, {
+        id: string;
+        customId: string | null;
+        connectionId: string | null;
+        title: string | null;
+        type: "audio" | "github_markdown" | "google_doc" | "google_sheet" | "google_slide" | "image" | "notion_doc" | "onedrive" | "pdf" | "text" | "tweet" | "video" | "webpage";
+        status: "chunking" | "done" | "embedding" | "extracting" | "failed" | "indexing" | "queued" | "unknown";
+        taskType: "memory" | "superrag";
+        metadata: string | number | boolean | unknown[] | {
+            [key: string]: unknown;
+        } | null;
+        summary: string | null;
+        source: string | null;
+        url: string | null | undefined;
+        filepath: string | null;
+        createdAt: string;
+        updatedAt: string;
+        content: null;
+        offset: number;
+        nextOffset: null;
+        totalCharacters: number | null;
+    } | {
+        content: string;
+        offset: number;
+        nextOffset: number | null;
+        totalCharacters: number;
+        id: string;
+        customId: string | null;
+        connectionId: string | null;
+        title: string | null;
+        type: "audio" | "github_markdown" | "google_doc" | "google_sheet" | "google_slide" | "image" | "notion_doc" | "onedrive" | "pdf" | "text" | "tweet" | "video" | "webpage";
+        status: "chunking" | "done" | "embedding" | "extracting" | "failed" | "indexing" | "queued" | "unknown";
+        taskType: "memory" | "superrag";
+        metadata: string | number | boolean | unknown[] | {
+            [key: string]: unknown;
+        } | null;
+        summary: string | null;
+        source: string | null;
+        url: string | null | undefined;
+        filepath: string | null;
+        createdAt: string;
+        updatedAt: string;
+    }> & {
+        execute(input: {
+            documentId: string;
+            offset: number;
+        }, ctx: import("eve/tools").ToolContext): Promise<{
+            id: string;
+            customId: string | null;
+            connectionId: string | null;
+            title: string | null;
+            type: "audio" | "github_markdown" | "google_doc" | "google_sheet" | "google_slide" | "image" | "notion_doc" | "onedrive" | "pdf" | "text" | "tweet" | "video" | "webpage";
+            status: "chunking" | "done" | "embedding" | "extracting" | "failed" | "indexing" | "queued" | "unknown";
+            taskType: "memory" | "superrag";
+            metadata: string | number | boolean | unknown[] | {
+                [key: string]: unknown;
+            } | null;
+            summary: string | null;
+            source: string | null;
+            url: string | null | undefined;
+            filepath: string | null;
+            createdAt: string;
+            updatedAt: string;
+            content: null;
+            offset: number;
+            nextOffset: null;
+            totalCharacters: number | null;
+        } | {
+            content: string;
+            offset: number;
+            nextOffset: number | null;
+            totalCharacters: number;
+            id: string;
+            customId: string | null;
+            connectionId: string | null;
+            title: string | null;
+            type: "audio" | "github_markdown" | "google_doc" | "google_sheet" | "google_slide" | "image" | "notion_doc" | "onedrive" | "pdf" | "text" | "tweet" | "video" | "webpage";
+            status: "chunking" | "done" | "embedding" | "extracting" | "failed" | "indexing" | "queued" | "unknown";
+            taskType: "memory" | "superrag";
+            metadata: string | number | boolean | unknown[] | {
+                [key: string]: unknown;
+            } | null;
+            summary: string | null;
+            source: string | null;
+            url: string | null | undefined;
+            filepath: string | null;
+            createdAt: string;
+            updatedAt: string;
+        }>;
+    };
+    read_document: import("eve/tools").ToolDefinition<{
+        container: "agent_context" | "agent_extraction";
+        documentId: string;
+        offset: number;
+    }, {
+        id: string;
+        customId: string | null;
+        connectionId: string | null;
+        title: string | null;
+        type: "audio" | "github_markdown" | "google_doc" | "google_sheet" | "google_slide" | "image" | "notion_doc" | "onedrive" | "pdf" | "text" | "tweet" | "video" | "webpage";
+        status: "chunking" | "done" | "embedding" | "extracting" | "failed" | "indexing" | "queued" | "unknown";
+        taskType: "memory" | "superrag";
+        metadata: string | number | boolean | unknown[] | {
+            [key: string]: unknown;
+        } | null;
+        summary: string | null;
+        source: string | null;
+        url: string | null | undefined;
+        filepath: string | null;
+        createdAt: string;
+        updatedAt: string;
+        content: null;
+        offset: number;
+        nextOffset: null;
+        totalCharacters: number | null;
+    } | {
+        content: string;
+        offset: number;
+        nextOffset: number | null;
+        totalCharacters: number;
+        id: string;
+        customId: string | null;
+        connectionId: string | null;
+        title: string | null;
+        type: "audio" | "github_markdown" | "google_doc" | "google_sheet" | "google_slide" | "image" | "notion_doc" | "onedrive" | "pdf" | "text" | "tweet" | "video" | "webpage";
+        status: "chunking" | "done" | "embedding" | "extracting" | "failed" | "indexing" | "queued" | "unknown";
+        taskType: "memory" | "superrag";
+        metadata: string | number | boolean | unknown[] | {
+            [key: string]: unknown;
+        } | null;
+        summary: string | null;
+        source: string | null;
+        url: string | null | undefined;
+        filepath: string | null;
+        createdAt: string;
+        updatedAt: string;
+    }> & {
+        execute(input: {
+            container: "agent_context" | "agent_extraction";
+            documentId: string;
+            offset: number;
+        }, ctx: import("eve/tools").ToolContext): Promise<{
+            id: string;
+            customId: string | null;
+            connectionId: string | null;
+            title: string | null;
+            type: "audio" | "github_markdown" | "google_doc" | "google_sheet" | "google_slide" | "image" | "notion_doc" | "onedrive" | "pdf" | "text" | "tweet" | "video" | "webpage";
+            status: "chunking" | "done" | "embedding" | "extracting" | "failed" | "indexing" | "queued" | "unknown";
+            taskType: "memory" | "superrag";
+            metadata: string | number | boolean | unknown[] | {
+                [key: string]: unknown;
+            } | null;
+            summary: string | null;
+            source: string | null;
+            url: string | null | undefined;
+            filepath: string | null;
+            createdAt: string;
+            updatedAt: string;
+            content: null;
+            offset: number;
+            nextOffset: null;
+            totalCharacters: number | null;
+        } | {
+            content: string;
+            offset: number;
+            nextOffset: number | null;
+            totalCharacters: number;
+            id: string;
+            customId: string | null;
+            connectionId: string | null;
+            title: string | null;
+            type: "audio" | "github_markdown" | "google_doc" | "google_sheet" | "google_slide" | "image" | "notion_doc" | "onedrive" | "pdf" | "text" | "tweet" | "video" | "webpage";
+            status: "chunking" | "done" | "embedding" | "extracting" | "failed" | "indexing" | "queued" | "unknown";
+            taskType: "memory" | "superrag";
+            metadata: string | number | boolean | unknown[] | {
+                [key: string]: unknown;
+            } | null;
+            summary: string | null;
+            source: string | null;
+            url: string | null | undefined;
+            filepath: string | null;
+            createdAt: string;
+            updatedAt: string;
+        }>;
+    };
+    remember: import("eve/tools").ToolDefinition<{
+        memory: string;
+        sourceDocumentId?: string | undefined;
+    }, {
+        documentId: string;
+        status: string;
+        sourceDocumentId: string | null;
+    }> & {
+        execute(input: {
+            memory: string;
+            sourceDocumentId?: string | undefined;
+        }, ctx: import("eve/tools").ToolContext): Promise<{
+            documentId: string;
+            status: string;
+            sourceDocumentId: string | null;
+        }>;
+    };
+    extract: import("eve/tools").ToolDefinition<{
+        kind: "file" | "text" | "url";
+        value: string;
+        title?: string | undefined;
+    }, {
+        documentId: string;
+        status: string;
+    }> & {
+        execute(input: {
+            kind: "file" | "text" | "url";
+            value: string;
+            title?: string | undefined;
+        }, ctx: import("eve/tools").ToolContext): Promise<{
+            documentId: string;
+            status: string;
+        }>;
+    };
+    forget: import("eve/tools").ToolDefinition<{
+        memoryId: string;
+        reason?: string | undefined;
+    }, import("supermemory/resources/memories.mjs").MemoryForgetResponse> & {
+        execute(input: {
+            memoryId: string;
+            reason?: string | undefined;
+        }, ctx: import("eve/tools").ToolContext): import("supermemory").APIPromise<import("supermemory/resources/memories.mjs").MemoryForgetResponse>;
+    };
+    forget_matching: import("eve/tools").ToolDefinition<{
+        query?: string | undefined;
+        dryRun: boolean;
+        ids?: string[] | undefined;
+        threshold?: number | undefined;
+        maxForget?: number | undefined;
+        reason?: string | undefined;
+    }, {
+        dryRun: true;
+        count: number;
+        forgetBatchId: null;
+        summary: string;
+        candidates: {
+            id: string;
+            memory: string;
+            score: number;
+        }[];
+    } | {
+        dryRun: false;
+        count: number;
+        forgetBatchId: string | null;
+        summary: string;
+        forgotten: {
+            id: string;
+            memory: string;
+            score: number;
+        }[];
+    }> & {
+        execute(input: {
+            query?: string | undefined;
+            dryRun: boolean;
+            ids?: string[] | undefined;
+            threshold?: number | undefined;
+            maxForget?: number | undefined;
+            reason?: string | undefined;
+        }, ctx: import("eve/tools").ToolContext): Promise<{
+            dryRun: true;
+            count: number;
+            forgetBatchId: null;
+            summary: string;
+            candidates: {
+                id: string;
+                memory: string;
+                score: number;
+            }[];
+        } | {
+            dryRun: false;
+            count: number;
+            forgetBatchId: string | null;
+            summary: string;
+            forgotten: {
+                id: string;
+                memory: string;
+                score: number;
+            }[];
+        }>;
+    };
+};

package/dist/tools/index.js

@@ -0,0 +1,18 @@
+import { createExtractTool } from "./extract.js";
+import { createForgetTool } from "./forget.js";
+import { createForgetMatchingTool } from "./forget-matching.js";
+import { createReadDocumentTool } from "./read-document.js";
+import { createReadSessionTool } from "./read-session.js";
+import { createRememberTool } from "./remember.js";
+import { createSearchTool } from "./search.js";
+export function createSupermemoryTools(dependencies) {
+    return {
+        search: createSearchTool(dependencies),
+        read_session: createReadSessionTool(dependencies),
+        read_document: createReadDocumentTool(dependencies),
+        remember: createRememberTool(dependencies),
+        extract: createExtractTool(dependencies),
+        forget: createForgetTool(dependencies),
+        forget_matching: createForgetMatchingTool(dependencies),
+    };
+}

package/dist/tools/read-document.d.ts

@@ -0,0 +1,96 @@
+import type { SupermemoryDependencies } from "../lib/dependencies.js";
+export declare function createReadDocumentTool(dependencies: SupermemoryDependencies): import("eve/tools").ToolDefinition<{
+    container: "agent_context" | "agent_extraction";
+    documentId: string;
+    offset: number;
+}, {
+    id: string;
+    customId: string | null;
+    connectionId: string | null;
+    title: string | null;
+    type: "audio" | "github_markdown" | "google_doc" | "google_sheet" | "google_slide" | "image" | "notion_doc" | "onedrive" | "pdf" | "text" | "tweet" | "video" | "webpage";
+    status: "chunking" | "done" | "embedding" | "extracting" | "failed" | "indexing" | "queued" | "unknown";
+    taskType: "memory" | "superrag";
+    metadata: string | number | boolean | unknown[] | {
+        [key: string]: unknown;
+    } | null;
+    summary: string | null;
+    source: string | null;
+    url: string | null | undefined;
+    filepath: string | null;
+    createdAt: string;
+    updatedAt: string;
+    content: null;
+    offset: number;
+    nextOffset: null;
+    totalCharacters: number | null;
+} | {
+    content: string;
+    offset: number;
+    nextOffset: number | null;
+    totalCharacters: number;
+    id: string;
+    customId: string | null;
+    connectionId: string | null;
+    title: string | null;
+    type: "audio" | "github_markdown" | "google_doc" | "google_sheet" | "google_slide" | "image" | "notion_doc" | "onedrive" | "pdf" | "text" | "tweet" | "video" | "webpage";
+    status: "chunking" | "done" | "embedding" | "extracting" | "failed" | "indexing" | "queued" | "unknown";
+    taskType: "memory" | "superrag";
+    metadata: string | number | boolean | unknown[] | {
+        [key: string]: unknown;
+    } | null;
+    summary: string | null;
+    source: string | null;
+    url: string | null | undefined;
+    filepath: string | null;
+    createdAt: string;
+    updatedAt: string;
+}> & {
+    execute(input: {
+        container: "agent_context" | "agent_extraction";
+        documentId: string;
+        offset: number;
+    }, ctx: import("eve/tools").ToolContext): Promise<{
+        id: string;
+        customId: string | null;
+        connectionId: string | null;
+        title: string | null;
+        type: "audio" | "github_markdown" | "google_doc" | "google_sheet" | "google_slide" | "image" | "notion_doc" | "onedrive" | "pdf" | "text" | "tweet" | "video" | "webpage";
+        status: "chunking" | "done" | "embedding" | "extracting" | "failed" | "indexing" | "queued" | "unknown";
+        taskType: "memory" | "superrag";
+        metadata: string | number | boolean | unknown[] | {
+            [key: string]: unknown;
+        } | null;
+        summary: string | null;
+        source: string | null;
+        url: string | null | undefined;
+        filepath: string | null;
+        createdAt: string;
+        updatedAt: string;
+        content: null;
+        offset: number;
+        nextOffset: null;
+        totalCharacters: number | null;
+    } | {
+        content: string;
+        offset: number;
+        nextOffset: number | null;
+        totalCharacters: number;
+        id: string;
+        customId: string | null;
+        connectionId: string | null;
+        title: string | null;
+        type: "audio" | "github_markdown" | "google_doc" | "google_sheet" | "google_slide" | "image" | "notion_doc" | "onedrive" | "pdf" | "text" | "tweet" | "video" | "webpage";
+        status: "chunking" | "done" | "embedding" | "extracting" | "failed" | "indexing" | "queued" | "unknown";
+        taskType: "memory" | "superrag";
+        metadata: string | number | boolean | unknown[] | {
+            [key: string]: unknown;
+        } | null;
+        summary: string | null;
+        source: string | null;
+        url: string | null | undefined;
+        filepath: string | null;
+        createdAt: string;
+        updatedAt: string;
+    }>;
+};

package/dist/tools/read-document.js

@@ -0,0 +1,28 @@
+import { defineTool } from "eve/tools";
+import { z } from "zod";
+import { DOCUMENT_CONTAINERS, readStoredDocument } from "../lib/documents.js";
+export function createReadDocumentTool(dependencies) {
+    return defineTool({
+        description: "Read a stored or extracted source document. Use after search identifies a document whenever answering the user requires its original wording, evidence, surrounding content, or details beyond the search result. Also use after extract to inspect the processed source before relying on it. For a search result, pass its exact results[].documents[].id with container agent_context. For an extracted source, pass the returned documentId with container agent_extraction. Start with offset 0 and continue with the returned nextOffset whenever more content is needed.",
+        inputSchema: z.object({
+            container: z
+                .enum(DOCUMENT_CONTAINERS)
+                .describe("Use agent_context for persistent context and indexed documents. Use agent_extraction for a file, URL, or text source created by extraction."),
+            documentId: z
+                .string()
+                .trim()
+                .min(1)
+                .max(200)
+                .describe("The exact results[].documents[].id returned by search, or the documentId returned by extraction."),
+            offset: z
+                .number()
+                .int()
+                .nonnegative()
+                .default(0)
+                .describe("The exact nextOffset returned by the previous read, or zero."),
+        }),
+        execute({ container, documentId, offset }, ctx) {
+            return readStoredDocument(documentId, offset, container, ctx, dependencies);
+        },
+    });
+}