getmnemo-vercel-ai 0.1.0 → 0.1.2

package/README.md

@@ -1,28 +1,28 @@
-# @ledgermem/vercel-ai
+# getmnemo-vercel-ai
 
-LedgerMem adapter for the [Vercel AI SDK](https://sdk.vercel.dev). Drop-in
+[Mnemo](https://mnemohq.com) adapter for the [Vercel AI SDK](https://sdk.vercel.dev). Drop-in
 `tool()` definitions that let any model search and write persistent memory,
 plus a small React hook for client-side memory views.
 
 ## Install
 
 ```bash
-npm install @ledgermem/vercel-ai @ledgermem/memory ai
+npm install getmnemo-vercel-ai ai
 ```
 
-Set `LEDGERMEM_API_KEY` and `LEDGERMEM_WORKSPACE_ID` in your environment, or
-pass them explicitly.
+`getmnemo` (the core SDK) is bundled as a dependency. Set `GETMNEMO_API_KEY`
+and `GETMNEMO_WORKSPACE_ID` in your environment, or pass them explicitly.
 
 ## Quickstart (30 seconds)
 
 ```ts
 import { streamText } from "ai";
 import { openai } from "@ai-sdk/openai";
-import { ledgermemTools } from "@ledgermem/vercel-ai";
+import { getmnemoTools } from "getmnemo-vercel-ai";
 
 const result = await streamText({
   model: openai("gpt-4o"),
-  tools: ledgermemTools, // memorySearch + memoryAdd
+  tools: getmnemoTools, // memorySearch + memoryAdd
   maxSteps: 5,
   messages: [{ role: "user", content: "What did I tell you about my coffee?" }],
 });
@@ -30,34 +30,129 @@ const result = await streamText({
 for await (const chunk of result.textStream) process.stdout.write(chunk);
 ```
 
+`getmnemoTools` is lazy — it reads `GETMNEMO_API_KEY` and
+`GETMNEMO_WORKSPACE_ID` from `process.env` the first time a tool runs.
+
 ## Per-user memory (route handler)
 
+Use `createMnemoTools` when you need per-request scoping. The `metadata` you
+pass is merged into every `memoryAdd` call (and cannot be overwritten by the
+model), so it's the right place for a `userId`:
+
 ```ts
-import { createLedgerMemTools } from "@ledgermem/vercel-ai";
+import { streamText } from "ai";
+import { openai } from "@ai-sdk/openai";
+import { createMnemoTools } from "getmnemo-vercel-ai";
 
 export async function POST(req: Request) {
   const { messages, userId } = await req.json();
-  const tools = createLedgerMemTools({ metadata: { userId } });
-  return streamText({ model: openai("gpt-4o"), tools, messages }).toDataStreamResponse();
+  const tools = createMnemoTools({ metadata: { userId } });
+
+  const result = streamText({
+    model: openai("gpt-4o"),
+    tools,
+    maxSteps: 5,
+    messages,
+  });
+
+  return result.toDataStreamResponse();
 }
 ```
 
+`createMnemoTools` also accepts `apiKey` / `workspaceId` (instead of env vars),
+a pre-built `client`, and a `defaultLimit` for searches the model doesn't size:
+
+```ts
+const tools = createMnemoTools({
+  apiKey: process.env.GETMNEMO_API_KEY,
+  workspaceId: process.env.GETMNEMO_WORKSPACE_ID,
+  defaultLimit: 8,
+});
+```
+
+## One-shot generation
+
+The same tools work with `generateText`:
+
+```ts
+import { generateText } from "ai";
+import { openai } from "@ai-sdk/openai";
+import { getmnemoTools } from "getmnemo-vercel-ai";
+
+const { text } = await generateText({
+  model: openai("gpt-4o"),
+  tools: getmnemoTools,
+  maxSteps: 5,
+  prompt: "Remember that I'm vegetarian, then suggest a dinner.",
+});
+```
+
+## Direct SDK access
+
+Need to read or write memory outside a model loop? Use the core client
+directly:
+
+```ts
+import { Mnemo } from "getmnemo";
+
+const memory = new Mnemo({
+  apiKey: process.env.GETMNEMO_API_KEY!,
+  workspaceId: process.env.GETMNEMO_WORKSPACE_ID!,
+});
+
+await memory.add({ content: "User prefers oat milk." });
+const { hits } = await memory.search({ query: "what milk does the user like?" });
+```
+
 ## React hook
 
+For client-side memory views (sidebars, inspectors), use `useMnemo`.
+
+> **⚠️ Security: the Mnemo `apiKey` is a full-access credential.**
+> There is exactly **one** API key, and it grants **read, write, and delete**
+> rights over your entire workspace. There is **no** public, scoped, or
+> read-only key. **NEVER** ship it in a browser bundle or any `NEXT_PUBLIC_`
+> variable — anything with that prefix is inlined into client-side JavaScript
+> and exposed to every visitor, handing them a delete-capable credential.
+>
+> `useMnemo` is intended for **trusted internal/admin dashboards only**.
+> Production, public-facing apps must **never** expose the key to the browser:
+> proxy all memory reads/writes through a server route (a Server Action or
+> Route Handler) that holds the key server-side.
+
+The hook reads `NEXT_PUBLIC_GETMNEMO_API_KEY` /
+`NEXT_PUBLIC_GETMNEMO_WORKSPACE_ID` by default and returns `SearchHit` objects,
+keyed by `memoryId`. The example below is **internal/admin only — not for
+public-facing apps**:
+
 ```tsx
 "use client";
-import { useLedgerMem } from "@ledgermem/vercel-ai/react";
+import { useMnemo } from "getmnemo-vercel-ai/react";
+import type { SearchHit } from "getmnemo";
 
 export function MemorySidebar() {
-  const { results, search, loading } = useLedgerMem({ initialQuery: "preferences" });
+  const { results, search, loading } = useMnemo<SearchHit>({
+    initialQuery: "preferences",
+  });
+
+  if (loading) return <p>Loading…</p>;
+
   return (
     <ul>
-      {results.map((m: any) => <li key={m.id}>{m.content}</li>)}
+      {results.map((m) => (
+        <li key={m.memoryId}>{m.content}</li>
+      ))}
     </ul>
   );
 }
 ```
 
+`useMnemo` also exposes `add(content, metadata?)`, `remove(id)`, and `error`.
+
+## Docs
+
+Full documentation at [mnemohq.com](https://mnemohq.com).
+
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "getmnemo-vercel-ai",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Mnemo adapter for the Vercel AI SDK — drop-in tools for streamText / generateText / useChat.",
   "type": "module",
   "main": "./dist/index.js",
@@ -34,7 +34,10 @@
     "rag",
     "tools"
   ],
-  "author": "Mnemo <founders@getmnemo.xyz>",
+  "author": {
+    "name": "Mnemo",
+    "url": "https://mnemohq.com"
+  },
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -67,5 +70,5 @@
   "engines": {
     "node": ">=18.17.0"
   },
-  "homepage": "https://getmnemo.xyz"
+  "homepage": "https://mnemohq.com"
 }