docs/public/platform-integration.mdx
// Resolve the worker port at runtime. The default is per-user (37700 + uid % 100),
// or whatever the user set via CLAUDE_MEM_WORKER_PORT / settings.json. Read it from
// process.env.CLAUDE_MEM_WORKER_PORT, then ~/.claude-mem/settings.json
// (CLAUDE_MEM_WORKER_PORT key), then fall back to the deterministic default.
const WORKER_BASE_URL = `http://127.0.0.1:${workerPort}`;
// Health check
GET /api/health
// Create/get session and queue observation
POST /api/sessions/observations
Body: { claudeSessionId, tool_name, tool_input, tool_response, cwd }
// Queue summary
POST /api/sessions/summarize
Body: { claudeSessionId, last_user_message, last_assistant_message }
// Complete session
POST /api/sessions/complete
Body: { claudeSessionId }
// Search observations
GET /api/search?query=authentication&type=observations&format=index&limit=20
// Get recent context for project
GET /api/context/recent?project=my-project&limit=3
CLAUDE_MEM_MODEL=claude-haiku-4-5-20251001 # Default Claude model for observations/summaries
CLAUDE_MEM_CONTEXT_OBSERVATIONS=50 # Observations injected at SessionStart
CLAUDE_MEM_WORKER_PORT= # Optional override; default = 37700 + (uid % 100)
CLAUDE_MEM_DATA_DIR= # Optional override for the data directory
CLAUDE_MEM_PYTHON_VERSION=3.13 # Python version for chroma-mcp
npm run build # Compile TypeScript (hooks + worker)
npm run sync-marketplace # Copy to ~/.claude/plugins
npm run worker:restart # Restart worker
npm run worker:logs # View worker logs
npm run worker:status # Check worker status
Platform Hook/Extension
→ HTTP Request to Worker (`${WORKER_BASE_URL}` — per-user, default 37700+uid%100)
→ Route Handler (SessionRoutes/DataRoutes/SearchRoutes/etc.)
→ Domain Service (SessionManager/SearchManager/DatabaseManager)
→ Database (SQLite3 + Chroma vector DB)
→ SSE Broadcast (real-time UI updates)
{ "claudeSessionId": "abc123", // Claude session identifier (string) "tool_name": "Bash", "tool_input": { "command": "ls" }, "tool_response": { "stdout": "..." }, "cwd": "/path/to/project" }
```json Response
{ "status": "queued" }
// or
{ "status": "skipped", "reason": "private" }
{ "claudeSessionId": "abc123", "last_user_message": "User's message", "last_assistant_message": "Assistant's response" }
```json Response
{ "status": "queued" }
// or
{ "status": "skipped", "reason": "private" }
{ "claudeSessionId": "abc123" }
```json Response
{ "success": true }
// or
{ "success": true, "message": "No active session found" }
{
"items": [...],
"hasMore": boolean,
"offset": number,
"limit": number
}
GET /api/stats
{
"worker": {
"version": "7.0.0",
"uptime": 12345,
"activeSessions": 2,
"sseClients": 1,
"port": 37742
},
"database": {
"path": "~/.claude-mem/claude-mem.db",
"size": 1048576,
"observations": 500,
"sessions": 50,
"summaries": 25
}
}
GET /api/projects
{
"projects": ["claude-mem", "other-project", ...]
}
GET /api/processing-status
{
"isProcessing": boolean,
"queueDepth": number
}
GET /api/search?query=authentication&type=observations&format=index&limit=20
{
"observations": [...],
"sessions": [...],
"prompts": [...]
}
GET /api/timeline?anchor=123&depth_before=10&depth_after=10&project=my-project
[
{ "type": "observation", "id": 120, "created_at_epoch": ..., ... },
{ "type": "session", "id": 5, "created_at_epoch": ..., ... },
{ "type": "observation", "id": 123, "created_at_epoch": ..., ... }
]
GET /api/search/by-concept?concept=discovery&format=index&limit=10&project=my-project
GET /api/search/by-file?filePath=src/services/worker-service.ts&format=index&limit=10
GET /api/search/by-type?type=bugfix&format=index&limit=10
GET /api/context/recent?project=my-project&limit=3
{
"summaries": [...],
"observations": [...]
}
GET /api/context/preview?project=my-project
GET /api/context/inject?project=my-project&colors=true
{
"sidebarOpen": boolean,
"selectedProject": string | null
}
POST /api/settings
Body: { "sidebarOpen": true, "selectedProject": "my-project" }
{ "success": true }
{ "enabled": boolean }
POST /api/mcp/toggle
Body: { "enabled": true }
{ "success": true, "enabled": boolean }
GET /api/health
{ "status": "ok" }
GET /
GET /stream
Event Types:
processing_status: { type, isProcessing, queueDepth }session_started: { type, sessionDbId, project }observation_queued: { type, sessionDbId }summarize_queued: { type }observation_created: { type, observation }summary_created: { type, summary }new_prompt: { type, id, claude_session_id, project, prompt_number, prompt_text, created_at_epoch }
</Info>
interface ActiveSession {
sessionDbId: number; // Database ID (numeric)
claudeSessionId: string; // Claude session identifier (string)
sdkSessionId: string | null; // SDK session ID
project: string; // Project name
userPrompt: string; // Current user prompt text
pendingMessages: PendingMessage[]; // Queue of pending operations
abortController: AbortController; // For cancellation
generatorPromise: Promise<void> | null; // SDK agent promise
lastPromptNumber: number; // Last processed prompt number
startTime: number; // Session start timestamp
cumulativeInputTokens: number; // Total input tokens
cumulativeOutputTokens: number; // Total output tokens
}
interface PendingMessage {
type: 'observation' | 'summarize';
tool_name?: string;
tool_input?: any;
tool_response?: any;
prompt_number?: number;
cwd?: string;
last_user_message?: string;
last_assistant_message?: string;
}
interface ObservationSearchResult {
id: number;
title: string;
subtitle?: string;
summary: string;
facts: string[]; // Parsed from JSON
concepts: string[]; // Parsed from JSON
files_touched: string[]; // Parsed from JSON
obs_type: string;
project: string;
created_at_epoch: number;
prompt_number: number;
rank?: number; // FTS5 rank score
}
interface SessionSummarySearchResult {
id: number;
summary_text: string;
facts: string[];
concepts: string[];
files_touched: string[];
project: string;
created_at_epoch: number;
rank?: number;
}
interface UserPromptSearchResult {
id: number;
claude_session_id: string;
project: string;
prompt_number: number;
prompt_text: string;
created_at_epoch: number;
rank?: number;
}
interface TimelineItem {
type: 'observation' | 'session' | 'prompt';
id: number;
created_at_epoch: number;
// Entity-specific fields based on type
}
const response = await fetch(`${WORKER_BASE_URL}/api/sessions/observations`, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
claudeSessionId: session_id,
tool_name,
tool_input,
tool_response: tool_result,
cwd
})
});
const result = await response.json();
// result.status === 'queued' | 'skipped'
}
```
await fetch(`${WORKER_BASE_URL}/api/sessions/summarize`, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
claudeSessionId: session_id,
last_user_message,
last_assistant_message
})
});
}
```
await fetch(`${WORKER_BASE_URL}/api/sessions/complete`, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
claudeSessionId: session_id
})
});
}
```
import * as vscode from 'vscode';
interface SearchTool extends vscode.LanguageModelChatTool {
invoke(
options: vscode.LanguageModelToolInvocationOptions<{ query: string }>,
token: vscode.CancellationToken
): vscode.ProviderResult<vscode.LanguageModelToolResult>;
}
const searchTool: SearchTool = {
invoke: async (options, token) => {
const { query } = options.input;
try {
const response = await fetch(
`${WORKER_BASE_URL}/api/search?query=${encodeURIComponent(query)}&format=index&limit=10`
);
if (!response.ok) {
throw new Error(`Search failed: ${response.statusText}`);
}
const results = await response.json();
// Format results for language model
return new vscode.LanguageModelToolResult([
new vscode.LanguageModelTextPart(JSON.stringify(results, null, 2))
]);
} catch (error) {
return new vscode.LanguageModelToolResult([
new vscode.LanguageModelTextPart(`Error: ${error.message}`)
]);
}
}
};
// Register tool
vscode.lm.registerTool('claude-mem-search', searchTool);
const participant = vscode.chat.createChatParticipant('claude-mem', async (request, context, stream, token) => {
const claudeSessionId = context.session.id;
// First message in conversation - no initialization needed
// Session is auto-created on first observation
// Process user message
stream.markdown(`Searching memory for: ${request.prompt}\n\n`);
const response = await fetch(
`${WORKER_BASE_URL}/api/search?query=${encodeURIComponent(request.prompt)}&format=index&limit=5`
);
const results = await response.json();
if (results.observations?.length > 0) {
stream.markdown('**Found observations:**\n');
for (const obs of results.observations) {
stream.markdown(`- ${obs.title} (${obs.project})\n`);
}
}
return { metadata: { command: 'search' } };
});
async function callWorkerWithFallback<T>(
endpoint: string,
options?: RequestInit
): Promise<T | null> {
try {
const response = await fetch(`${WORKER_BASE_URL}${endpoint}`, {
...options,
signal: AbortSignal.timeout(5000) // 5s timeout
});
if (!response.ok) {
throw new Error(`HTTP ${response.status}: ${response.statusText}`);
}
return await response.json();
} catch (error) {
console.error(`Worker unavailable (${endpoint}):`, error);
return null; // Graceful degradation
}
}
async function retryWithBackoff<T>(
fn: () => Promise<T>,
maxRetries = 3,
baseDelay = 100
): Promise<T> {
for (let attempt = 0; attempt < maxRetries; attempt++) {
try {
return await fn();
} catch (error) {
if (attempt === maxRetries - 1) throw error;
const delay = baseDelay * Math.pow(2, attempt);
await new Promise(resolve => setTimeout(resolve, delay));
}
}
throw new Error('Max retries exceeded');
}
async function isWorkerHealthy(): Promise<boolean> {
try {
const response = await fetch(`${WORKER_BASE_URL}/api/health`, {
signal: AbortSignal.timeout(2000)
});
return response.ok;
} catch {
return false;
}
}
Privacy Check: Observations/summaries are skipped if the entire user prompt was wrapped in <private> tags.
</Info>
class WorkerUnavailableError extends Error {
constructor() {
super('Claude-mem worker is not running or unreachable');
this.name = 'WorkerUnavailableError';
}
}
class WorkerTimeoutError extends Error {
constructor(endpoint: string) {
super(`Worker request timed out: ${endpoint}`);
this.name = 'WorkerTimeoutError';
}
}
function connectToSSE(onEvent: (event: any) => void) {
const eventSource = new EventSource(`${WORKER_BASE_URL}/stream`);
eventSource.onmessage = (event) => {
try {
const data = JSON.parse(event.data);
onEvent(data);
} catch (error) {
console.error('SSE parse error:', error);
}
};
eventSource.onerror = (error) => {
console.error('SSE connection error:', error);
eventSource.close();
// Reconnect after 5 seconds
setTimeout(() => connectToSSE(onEvent), 5000);
};
return eventSource;
}
vscode-extension/
├── src/
│ ├── extension.ts # Extension entry point
│ ├── services/
│ │ ├── WorkerClient.ts # HTTP client for worker
│ │ └── MemoryManager.ts # High-level memory operations
│ ├── chat/
│ │ └── participant.ts # Chat participant implementation
│ └── tools/
│ ├── search.ts # Search language model tool
│ └── context.ts # Context injection tool
├── package.json
├── tsconfig.json
└── README.md
// build.js
const esbuild = require('esbuild');
esbuild.build({
entryPoints: ['src/extension.ts'],
bundle: true,
outfile: 'dist/extension.js',
external: ['vscode'],
format: 'cjs',
platform: 'node',
target: 'node18',
sourcemap: true
}).catch(() => process.exit(1));
{
"name": "claude-mem-vscode",
"displayName": "Claude-Mem",
"version": "1.0.0",
"engines": {
"vscode": "^1.95.0"
},
"activationEvents": [
"onStartupFinished"
],
"main": "./dist/extension.js",
"contributes": {
"chatParticipants": [
{
"id": "claude-mem",
"name": "memory",
"description": "Search your persistent memory"
}
],
"languageModelTools": [
{
"name": "claude-mem-search",
"displayName": "Search Memory",
"description": "Search persistent memory for observations, sessions, and prompts"
}
]
},
"scripts": {
"build": "node build.js",
"watch": "node build.js --watch",
"package": "vsce package"
},
"devDependencies": {
"@types/vscode": "^1.95.0",
"esbuild": "^0.19.0",
"typescript": "^5.3.0"
}
}
{
"version": "0.2.0",
"configurations": [
{
"name": "Run Extension",
"type": "extensionHost",
"request": "launch",
"args": [
"--extensionDevelopmentPath=${workspaceFolder}"
],
"outFiles": [
"${workspaceFolder}/dist/**/*.js"
],
"preLaunchTask": "npm: build"
}
]
}
import { describe, it, expect } from 'vitest';
import { WorkerClient } from '../src/services/WorkerClient';
describe('WorkerClient', () => {
it('should check worker health', async () => {
const client = new WorkerClient();
const healthy = await client.isHealthy();
expect(healthy).toBe(true);
});
it('should queue observation', async () => {
const client = new WorkerClient();
const result = await client.queueObservation({
claudeSessionId: 'test-123',
tool_name: 'Bash',
tool_input: { command: 'ls' },
tool_response: { stdout: 'file1.txt' },
cwd: '/tmp'
});
expect(result.status).toBe('queued');
});
it('should search observations', async () => {
const client = new WorkerClient();
const results = await client.search({ query: 'test', limit: 5 });
expect(results).toHaveProperty('observations');
});
});
import { spawn } from 'child_process';
import { describe, it, expect, beforeAll, afterAll } from 'vitest';
describe('Worker Integration', () => {
let workerProcess: ReturnType<typeof spawn>;
beforeAll(async () => {
// Start worker process
workerProcess = spawn('node', ['dist/worker-service.js'], {
env: { ...process.env, CLAUDE_MEM_WORKER_PORT: '37778' }
});
// Wait for worker to be ready
await new Promise(resolve => setTimeout(resolve, 2000));
});
afterAll(() => {
workerProcess.kill();
});
it('should respond to health check', async () => {
const response = await fetch('http://localhost:37778/api/health');
expect(response.ok).toBe(true);
});
});
// Resolve the active worker port via env / settings.json, falling back
// to the deterministic per-user default. See parseWorkerPort() for an
// example helper; never hardcode a single value.
constructor(port: number = resolveWorkerPort()) {
this.baseUrl = http://127.0.0.1:${port};
}
async isHealthy(): Promise<boolean> {
try {
const response = await fetch(${this.baseUrl}/api/health, {
signal: AbortSignal.timeout(2000)
});
return response.ok;
} catch {
return false;
}
}
async queueObservation(data: {
claudeSessionId: string;
tool_name: string;
tool_input: any;
tool_response: any;
cwd?: string;
}): Promise<{ status: string; reason?: string }> {
const response = await fetch(${this.baseUrl}/api/sessions/observations, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(data),
signal: AbortSignal.timeout(5000)
});
if (!response.ok) {
throw new Error(`Failed to queue observation: ${response.statusText}`);
}
return await response.json();
}
async queueSummarize(data: {
claudeSessionId: string;
last_user_message?: string;
last_assistant_message?: string;
}): Promise<{ status: string; reason?: string }> {
const response = await fetch(${this.baseUrl}/api/sessions/summarize, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(data),
signal: AbortSignal.timeout(5000)
});
if (!response.ok) {
throw new Error(`Failed to queue summary: ${response.statusText}`);
}
return await response.json();
}
async completeSession(claudeSessionId: string): Promise<void> {
const response = await fetch(${this.baseUrl}/api/sessions/complete, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ claudeSessionId }),
signal: AbortSignal.timeout(5000)
});
if (!response.ok) {
throw new Error(`Failed to complete session: ${response.statusText}`);
}
}
async search(params: { query?: string; type?: 'observations' | 'sessions' | 'prompts'; format?: 'index' | 'full'; limit?: number; project?: string; }): Promise<any> { const queryString = new URLSearchParams( Object.entries(params) .filter(([_, v]) => v !== undefined) .map(([k, v]) => [k, String(v)]) ).toString();
const response = await fetch(
`${this.baseUrl}/api/search?${queryString}`,
{ signal: AbortSignal.timeout(10000) }
);
if (!response.ok) {
throw new Error(`Search failed: ${response.statusText}`);
}
return await response.json();
}
connectSSE(onEvent: (event: any) => void): EventSource {
const eventSource = new EventSource(${this.baseUrl}/stream);
eventSource.onmessage = (event) => {
try {
const data = JSON.parse(event.data);
onEvent(data);
} catch (error) {
console.error('SSE parse error:', error);
}
};
eventSource.onerror = (error) => {
console.error('SSE connection error:', error);
};
return eventSource;
} }
</CodeGroup>
### Search Language Model Tool
```typescript
import * as vscode from 'vscode';
import { WorkerClient } from './WorkerClient';
export function registerSearchTool(context: vscode.ExtensionContext) {
const client = new WorkerClient();
const searchTool = vscode.lm.registerTool('claude-mem-search', {
description: 'Search persistent memory for observations, sessions, and prompts',
inputSchema: {
type: 'object',
properties: {
query: {
type: 'string',
description: 'Search query text'
},
type: {
type: 'string',
enum: ['observations', 'sessions', 'prompts'],
description: 'Type of results to return'
},
limit: {
type: 'number',
description: 'Maximum number of results',
default: 10
}
},
required: ['query']
},
invoke: async (options, token) => {
const { query, type, limit = 10 } = options.input;
try {
const results = await client.search({
query,
type,
format: 'index',
limit
});
// Format results for language model
let formatted = '';
if (results.observations?.length > 0) {
formatted += '## Observations\n\n';
for (const obs of results.observations) {
formatted += `- **${obs.title}** (${obs.project})\n`;
formatted += ` ${obs.summary}\n`;
if (obs.concepts?.length > 0) {
formatted += ` Concepts: ${obs.concepts.join(', ')}\n`;
}
formatted += '\n';
}
}
return new vscode.LanguageModelToolResult([
new vscode.LanguageModelTextPart(formatted)
]);
} catch (error) {
return new vscode.LanguageModelToolResult([
new vscode.LanguageModelTextPart(`Error: ${error.message}`)
]);
}
}
});
context.subscriptions.push(searchTool);
}
IMPORTANT: Use claudeSessionId (string) for new API endpoints, not sessionDbId (number).
sessionDbId - Numeric database ID (legacy endpoints only)claudeSessionId - String identifier from Claude platform (new endpoints)
</Warning>
Fields like facts, concepts, and files_touched are stored as JSON strings and require parsing:
const observation = await client.getObservationById(123);
const facts = JSON.parse(observation.facts); // string[] array
const concepts = JSON.parse(observation.concepts); // string[] array
All created_at_epoch fields are in milliseconds, not seconds:
const date = new Date(observation.created_at_epoch); // ✅ Correct
const date = new Date(observation.created_at_epoch * 1000); // ❌ Wrong (already in ms)
Workers process observations/summaries asynchronously. Results appear in the database 1-2 seconds after queuing. Use SSE events for real-time notifications. </Info>
<Info> ### Privacy TagsAlways wrap sensitive content in <private> tags to prevent storage:
const userMessage = '<private>API key: sk-1234567890</private>';
// This observation will be skipped (entire prompt is private)