Skip to content

@tekmemo/ai-sdk

Vercel AI SDK helpers for TekMemo memory tools.

Install

bash
npm install @tekmemo/ai-sdk ai tekmemo @tekmemo/fs

Purpose

Use this package to expose TekMemo memory as AI SDK tools in generateText, streamText, and agent workflows.

The package provides:

  • buildRuntimeMemoryToolDefinition() for a ready-to-use AI SDK tool with memory operations
  • runRuntimeMemoryTool() for executing memory tool commands with scope enforcement
  • createLocalAiSdkRuntime() for local file-backed memory runtime
  • buildRuntimeMemoryContext() for building memory-aware context (system prompt)
  • buildMemoryToolDefinition() for a standard memory tool definition (legacy API)
  • buildAgentSessionInstructions() for agent session instruction blocks
  • Scope enforcement for project, user, conversation, and participant memory

Minimal usage

ts
import { generateText } from "ai";
import { openai } from "@ai-sdk/openai";
import {
	buildRuntimeMemoryContext,
	buildRuntimeMemoryToolDefinition,
	createLocalAiSdkRuntime,
} from "@tekmemo/ai-sdk";
import { createNodeFsMemoryStore } from "@tekmemo/fs";

const store = createNodeFsMemoryStore({ rootDir: "./.tekmemo" });
const runtime = createLocalAiSdkRuntime({ workspace: store });
const access = { projectId: "demo", userId: "user_123" };
const { text: system } = await buildRuntimeMemoryContext({
	runtime,
	access,
	query: prompt,
	baseInstructions: "You are a helpful assistant.",
});

await generateText({
	model: openai("gpt-4.1-mini"),
	system,
	prompt,
	tools: {
		memory: buildRuntimeMemoryToolDefinition({ runtime, access, allowWrites: true }),
	},
});

Cloud-backed tools

For cloud-backed memory tools, use a runtime from @tekmemo/cloud-client instead of the local runtime:

ts
import { createTekMemoCloudClient } from "@tekmemo/cloud-client";

const client = createTekMemoCloudClient({
	baseUrl: "https://memo.tekbreed.com/api/v1",
	apiKey: process.env.TEKMEMO_API_KEY!,
	defaultProjectId: "proj_123",
});

Released under the MIT License.