Skip to content

docs(memory-search): document FTS5 query syntax #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Istar-Eldritch wants to merge 1 commit into from
+11 −2
Closed

docs(memory-search): document FTS5 query syntax #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions src/tools/memory-search-tool.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,24 @@ Use cases:
- Find user preferences: "What are the user's testing preferences?"
- Search for past failures: "memory_search('auth', category='failure')"

Query syntax (FTS5):
- Single word: auth
- Exact phrase: "database migration" (quotes required for phrase matching)
- Proximity: NEAR("deploy" "config", 10) (both terms within 10 words)
- Boolean: auth AND token, deploy OR release, auth NOT oauth
- Default (no operators): single terms only — use AND/NEAR for multi-word queries

Returns matching memory entries with project context and dates.`,
promptSnippet: 'Search extended memory store (unlimited capacity)',
promptGuidelines: [
'Use memory_search when you need context beyond what is in the system prompt.',
'Use memory_search at the START of every session and when starting a new task to load relevant context.',
'Use memory_search to find project-specific memories or user preferences.',
'Use memory_search with category filter to find specific types of memories (failure, correction, insight, etc.).',
'IMPORTANT: memory_search uses FTS5 — multi-word queries MUST use AND: auth AND token, not "auth token" (which is an exact phrase match and will return no results).',
'For proximity matching use NEAR: NEAR("deploy" "config", 10). For exact phrases wrap in quotes: "database migration".',
],
parameters: Type.Object({
query: Type.String({ description: 'Search query. Use natural language or specific terms.' }),
query: Type.String({ description: 'FTS5 search query. Single word: auth. Exact phrase: "database migration". Proximity: NEAR("deploy" "config", 10). Boolean: auth AND token. For multi-word natural language, use AND explicitly: auth AND token.' }),
project: Type.Optional(Type.String({ description: 'Filter by project name. Pass null for global memories only.' })),
target: Type.Optional(StringEnum(['memory', 'user', 'failure'] as const, { description: 'Filter by target type (memory, user, or failure).' })),
category: Type.Optional(StringEnum(['failure', 'correction', 'insight', 'preference', 'convention', 'tool-quirk'] as const, { description: 'Filter by memory category.' })),
Expand Down