Diagnose and configure MemSearch memory behavior. Use when the user asks about MemSearch configuration, plugin summarization, PROJECT.md/USER.md maintenance, memory directories, index health, provider routing, prompt files, or migration/compatibility questions.
64
75%
Does it follow best practices?
Run evals on this skill
Adds up to 20 points to the overall score
View guide
Passed
No findings from the security scan
Fix and improve this skill with Tessl
tessl review fix ./plugins/_shared/skills/memory-config/SKILL.mdThe canonical home for this skill is memory-config in zilliztech/memsearch
You are a MemSearch configuration assistant. This skill manages MemSearch settings only. It is not the host agent's built-in memory/config system.
In diagnostic summaries or final answers, state once that this is MemSearch memory configuration, not the host agent's own memory/config system. Do not prepend that sentence to every progress update or every paragraph.
When this skill is triggered, inspect the user's request text. If there is no concrete request, run a diagnostic. If they ask for a specific setting or change, route the request using the flows below.
This skill is shared by five agent platforms, but platform-specific details
(version-check commands, plugins.<platform>.* keys, native model defaults,
restart guidance) live in per-platform reference files. Read ONLY the one file
matching your current environment:
references/claude-code.mdreferences/codex.mdreferences/openclaw.mdreferences/opencode.mdreferences/dsh.mdIf you are unsure which agent you are, check these environment markers:
DSH_HOME/~/.dsh → DeepSeek Harness; CODEX_HOME/~/.codex → Codex;
~/.openclaw → OpenClaw; ~/.config/opencode → OpenCode;
CLAUDE_PLUGIN_ROOT → Claude Code.
Read that platform file before performing platform-specific diagnosis or configuration. Do not read the other platform files.
memory-to-skill skill to review and install candidates.Ask the user before enabling external or paid providers, changing output paths, re-indexing, deleting state, or broadening what gets indexed.
memsearch config list --resolved
memsearch config list --global
memsearch config list --projectCheck the shared CLI version before calling the setup healthy:
memsearch --version
uv tool list --show-paths | rg -n 'memsearch|Package|Installed|path'
curl -fsSL https://pypi.org/pypi/memsearch/json \
| python3 -c 'import json,sys; print(json.load(sys.stdin)["info"]["version"])'If memsearch is unavailable, try uvx --from memsearch[onnx] memsearch --version.
The MemSearch CLI comes from the PyPI package memsearch. Update with
uv tool install -U "memsearch[onnx]" or uv tool upgrade memsearch.
For the host platform's plugin version, update commands, and documentation link, see your platform reference file.
Check memory files:
MDIR="${MEMSEARCH_DIR:-$(git rev-parse --show-toplevel 2>/dev/null || pwd)/.memsearch}/memory"
ls -la "$MDIR"
find "$MDIR" -maxdepth 1 -type f -name '*.md' | sort | tail -10
tail -120 "$MDIR/$(date +%Y-%m-%d).md"Check index health:
memsearch stats
STATE_DIR="${MEMSEARCH_DIR:-$(git rev-parse --show-toplevel 2>/dev/null || pwd)/.memsearch}"
test -f "$STATE_DIR/.index-state.json" && cat "$STATE_DIR/.index-state.json"Some plugin config fields may be missing or empty. That is usually normal:
summarize.enabled, advanced maintenance, and task-specific provider/model fields are newer settings.memsearch config list --resolved, not by reading raw TOML alone.memsearch config init may see more fields than old users because the template includes newer options.Config is resolved from built-in defaults, global config, project config, env refs like env:OPENAI_API_KEY, and runtime env such as MEMSEARCH_DIR.
Use memsearch config list --resolved for effective behavior, --global for global overrides, and --project for repository-specific overrides.
Since v0.4.11, project-local .memsearch.toml is restricted before it is merged.
Only these low-risk local indexing keys are honored from project config:
milvus.collectionembedding.batch_sizechunking.max_chunk_sizechunking.overlap_linesindexing.ignore_filesindexing.excludewatch.debounce_msIndex exclusions are opt-in for compatibility. Missing or empty
indexing.ignore_files and indexing.exclude keep the old scan-all behavior;
new files created by memsearch config init explicitly write
ignore_files = [".gitignore"]. Each directory passed to index/watch is its own
root, and ignore discovery never walks into parent directories.
Trusted settings are ignored or rejected in project config. Put these in global
config (~/.memsearch/config.toml) or pass explicit CLI flags instead:
[llm] and [llm.providers.*][prompts]plugins.<platform>.project_review.enabled,
plugins.<platform>.user_profile.enabled, and
plugins.<platform>.memory_to_skill.enabled (see your platform reference file
for the exact key prefix).Default recommendation:
input_dir / output_file values still resolve inside each current project.Maintenance input_dir and output_file may be relative even when configured globally. They are resolved from the current project directory at runtime, so a global output_file = ".memsearch/PROJECT.md" writes to each project's own .memsearch/PROJECT.md. For custom prompt paths, prefer absolute paths in global config; project prompt paths are not trusted.
The plugin-specific TOML keys (plugins.<platform>.summarize,
plugins.<platform>.project_review, plugins.<platform>.user_profile,
plugins.<platform>.memory_to_skill) and the native summarizer/maintenance
model defaults are in your platform reference file.
provider = "" or native uses the host agent's non-interactive native path (see your platform reference file).[llm.providers.<name>].plugins.<platform>.<task>.model, then named provider model, then built-in default.Common provider examples:
[llm.providers.openai]
type = "openai"
model = "gpt-5-mini"
api_key = "env:OPENAI_API_KEY"
[llm.providers.anthropic]
type = "anthropic"
model = "claude-sonnet-4-6"
api_key = "env:ANTHROPIC_API_KEY"
[llm.providers.gemini]
type = "gemini"
model = "gemini-3-flash-preview"
api_key = "env:GEMINI_API_KEY"Model guidance:
openai -> gpt-5-mini, anthropic -> claude-sonnet-4-6, and gemini -> gemini-3-flash-preview.plugins.<platform>.project_review.model and plugins.<platform>.user_profile.model explicitly.Advanced maintenance runs after the plugin wakes it, only when enabled, journal input changed, and min_interval_hours elapsed. PROJECT.md and USER.md are maintenance artifacts by default and are not automatically indexed.
If indexing seems silent or search looks stale, check .memsearch/.index-state.json
for status, last_error, and failed_files. status: degraded means the
scan completed but one or more files failed; status: error means the index run
did not complete.
If advanced maintenance or memory_to_skill seems silent, check
.memsearch/.maintenance-state.json for <plugin>.<task>.last_error and
last_failed_at; background hook errors may not surface in the chat.
Before enabling advanced maintenance, ask which provider to use, whether the default 24-hour interval is acceptable, whether .memsearch/PROJECT.md / .memsearch/USER.md are acceptable output files, and whether the user wants the enablement global. Do not write plugin automation keys with --project; v0.4.11+ project config ignores or rejects them.
[prompts]
summarize = ""
project_review = ""
user_profile = ""
memory_to_skill = ""Empty prompt paths mean use the built-in MemSearch prompts. Custom prompt files may use {{AGENT_NAME}}, {{TASK_NAME}}, {{PROJECT_DIR}}, {{INPUT_DIR}}, and {{OUTPUT_FILE}}; the runner appends existing output, recent journals, and digest automatically.
Use memsearch config set for changes. For trusted keys such as plugins.*, [llm.providers.*], [prompts], embedding.provider, or milvus.uri, set global config by omitting --project. Use --project only for allowlisted local indexing keys. After changing anything, show the command, the resolved value, and whether a new session is needed.
MemSearch TOML changes are read lazily by the CLI and the plugin's capture/maintenance paths, so values such as plugins.<platform>.summarize.*, plugins.<platform>.project_review.*, plugins.<platform>.user_profile.*, [llm.providers.*], [prompts], milvus.*, and embedding.* usually apply on the next capture, recall, index, or maintenance invocation. See your platform reference file for whether a restart is required after plugin/skill/config file changes. In final diagnostic/change summaries, make clear that this is MemSearch memory configuration, not the host agent's own memory/config system.
When useful, remind the user that they can either continue using this memory-config skill for guided configuration, or manually run memsearch config init for global interactive setup, memsearch config init --project for allowlisted project indexing setup, and memsearch config set/get/list for direct CLI changes.
3e98e4a
Canonical home
since Jul 27, 2026
Also appears in
since Sep 1, 2026
since Sep 1, 2026
since Sep 1, 2026
If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.