@jcyamacho/agent-memory 0.0.1 → 0.0.2

package/README.md

@@ -2,34 +2,81 @@
 
 Persistent memory for MCP-powered coding agents.
 
-`agent-memory` gives your LLM a durable memory layer backed by SQLite. It is a
-small MCP server with two focused tools:
+`agent-memory` is a stdio MCP server that gives your LLM durable memory backed
+by SQLite. It exposes two tools:
 
 - `remember` -> save facts, decisions, preferences, and project context
 - `recall` -> retrieve the most relevant memories later
 
-It is designed for agent workflows where context should survive across turns,
-sessions, and even different clients.
+Use it when your agent should remember preferences, project facts, and prior
+decisions across sessions.
 
-## Why Use It
+## Quick Start
 
-Most agents lose useful context between runs. This server lets them keep things
-that actually matter:
+Example MCP server config:
 
-- User preferences like tone, formatting, and workflow habits
-- Project facts like architecture choices, paths, and constraints
-- Ongoing decisions like naming, scope, and tradeoffs
-- Session-specific notes that should still be discoverable later
+```json
+{
+  "mcpServers": {
+    "memory": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "@jcyamacho/agent-memory"
+      ]
+    }
+  }
+}
+```
+
+With a custom database path:
+
+```json
+{
+  "mcpServers": {
+    "memory": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "@jcyamacho/agent-memory"
+      ],
+      "env": {
+        "AGENT_MEMORY_DB_PATH": "/absolute/path/to/memory.db"
+      }
+    }
+  }
+}
+```
+
+Recommended LLM instructions to pair with this MCP:
+
+```text
+Use `memory_recall` at the start of a task, when the user refers to previous
+context, or whenever prior preferences, project facts, or decisions may help.
+
+Use `memory_remember` to save durable context that will matter later, such as
+user preferences, project conventions, architecture decisions, constraints, and
+stable workflow habits.
+
+Store concise, self-contained facts or short notes. Include `source`,
+`workspace`, and `session` when available so future retrieval is better scoped.
+
+Do not store secrets, credentials, API keys, tokens, or temporary noise.
+
+When recalling, use short factual queries and keep `limit` small unless you
+need broader recall. Use `preferred_workspace` or `preferred_source` to bias
+ranking, and `filter_workspace` or `filter_source` only when exact scoping is
+required.
+```
 
-The result is an agent that feels less stateless and less repetitive.
+## What It Stores
 
-## Features
+This MCP is useful for context that should survive across turns and sessions:
 
-- SQLite-backed persistence with automatic database creation
-- Full-text recall with ranking, filters, and date bounds
-- Compact write acknowledgments to avoid wasting tokens
-- Durable memory scoped by `source`, `workspace`, and `session`
-- MCP-native tool descriptions optimized for LLM use
+- User preferences like response style, formatting, and workflow habits
+- Project facts like paths, architecture choices, and conventions
+- Important decisions and constraints that should not be rediscovered
+- Session-linked notes that still matter later
 
 ## Tools
 
@@ -39,9 +86,9 @@ Save durable context for later recall.
 
 Inputs:
 
-- `content` -> the fact, preference, decision, or context to remember
-- `source` -> where the memory came from, such as a client, tool, or agent
-- `workspace` -> repository or workspace path for project scoping
+- `content` -> fact, preference, decision, or context to store
+- `source` -> client, tool, or agent name
+- `workspace` -> repository or workspace path
 - `session` -> conversation or execution session identifier
 
 Output:
@@ -58,12 +105,12 @@ Retrieve relevant memories for the current task.
 
 Inputs:
 
-- `query` -> keywords, facts, names, or phrases to search for
-- `limit` -> max results to return
-- `preferred_source` -> rank memories from this source higher
-- `preferred_workspace` -> rank memories from this workspace higher
-- `filter_source` -> only return memories from this exact source
-- `filter_workspace` -> only return memories from this exact workspace
+- `query` -> keywords, names, facts, or phrases to search for
+- `limit` -> maximum results to return
+- `preferred_source` -> ranking hint for a source
+- `preferred_workspace` -> ranking hint for a workspace
+- `filter_source` -> exact source filter
+- `filter_workspace` -> exact workspace filter
 - `created_after` -> ISO 8601 lower bound
 - `created_before` -> ISO 8601 upper bound
 
@@ -72,36 +119,18 @@ Output:
 - `results[]` with `id`, `content`, `score`, `source`, `workspace`, `session`,
   and `created_at`
 
-## Installation
-
-### From npm
-
-```bash
-npm install -g @jcyamacho/agent-memory
-```
-
-### From source
+## Setup
 
-```bash
-bun install
-bun run build
-```
+For normal usage:
 
-The CLI entrypoint is:
-
-```bash
-agent-memory
-```
+- Node.js
 
-## Requirements
+For local development or running from source:
 
+- Bun
 - Node.js
-- A normal package install with `node_modules`
-
-Important: the build keeps `better-sqlite3` external on purpose. That is
-required for its native binding to load correctly at runtime.
 
-## Configuration
+### Database location
 
 By default, the SQLite database is created at:
 
@@ -115,48 +144,15 @@ Override it with:
 AGENT_MEMORY_DB_PATH=/absolute/path/to/memory.db
 ```
 
-Example:
-
-```bash
-AGENT_MEMORY_DB_PATH="$HOME/.local/share/agent-memory/memory.db" agent-memory
-```
-
-## Running It
-
-### Development
-
-```bash
-bun install
-bun run build
-node dist/index.js
-```
-
-### Local validation
+Set `AGENT_MEMORY_DB_PATH` when you want to:
 
-```bash
-bun lint
-bun test
-bun run build
-```
+- keep memory in a project-specific location
+- share a memory DB across multiple clients
+- store the DB somewhere easier to back up or inspect
 
-## MCP Client Configuration
+## Run from source
 
-Example MCP server entry:
-
-```json
-{
-  "mcpServers": {
-    "memory": {
-      "command": "agent-memory",
-      "env": {
-        "AGENT_MEMORY_DB_PATH": "/absolute/path/to/memory.db"
-      }
-    }
-  }
-}
-```
-
-If you are running from source instead of a global install, use:
+If you are developing locally instead of using the published package:
 
 ```json
 {
@@ -174,36 +170,29 @@ If you are running from source instead of a global install, use:
 }
 ```
 
-## Recommended LLM Instructions
-
-Copy and paste this into your system prompt, `AGENTS.md`, `CLAUDE.md`, or
-similar instruction file.
-
-```text
-Use `memory_recall` at the start of a task, when the user refers to previous
-context, or whenever prior preferences, project facts, or decisions may help.
+Build first:
 
-Use `memory_remember` to save durable context that will matter later, such as
-user preferences, project conventions, architecture decisions, constraints, and
-stable workflow habits.
+```bash
+bun install
+bun run build
+```
 
-Store concise, self-contained facts or short notes. Include `source`,
-`workspace`, and `session` when available so future retrieval is better scoped.
+## Local Development
 
-Do not store secrets, credentials, API keys, tokens, or temporary noise.
+Only needed if you want to work on the project itself.
 
-When recalling, use short factual queries and keep `limit` small unless you
-need broader recall. Use `preferred_workspace` or `preferred_source` to bias
-ranking, and `filter_workspace` or `filter_source` only when exact scoping is
-required.
+```bash
+bun install
+bun lint
+bun test
+bun run build
 ```
 
-## Development Notes
+## Notes
 
-- Runtime target is Node-compatible output at `dist/index.js`
-- Local workflows use Bun
-- Tests use `bun:test`
-- Runtime code avoids Bun-only APIs
+- `better-sqlite3` stays external in the build so its native binding loads
+  correctly at runtime.
+- Runtime output is Node-compatible and built to `dist/index.js`.
 
 ## License
 

package/dist/index.js

@@ -12464,7 +12464,7 @@ class StdioServerTransport {
   }
 }
 // package.json
-var version2 = "0.0.1";
+var version2 = "0.0.2";
 
 // src/config.ts
 import { homedir } from "node:os";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jcyamacho/agent-memory",
   "main": "dist/index.js",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "bin": {
     "agent-memory": "dist/index.js"
   },
@@ -23,7 +23,10 @@
     "build": "bun build src/index.ts --target=node --external better-sqlite3 --outfile dist/index.js --banner \"#!/usr/bin/env node\"",
     "start": "node dist/index.js",
     "test": "bun test",
-    "lint": "biome check --write"
+    "lint": "biome check --write",
+    "release:patch": "npm version patch && git push origin main --follow-tags",
+    "release:minor": "npm version minor && git push origin main --follow-tags",
+    "release:major": "npm version major && git push origin main --follow-tags"
   },
   "devDependencies": {
     "@biomejs/biome": "2.4.6",