Imported from zhangyao23/research-vault (AGENTS.md). Install upstream with npx skills add zhangyao23/research-vault. Copyright stays with the author.

AGENTS.md

Project Goal And Stage

Project: research-vault
Goal: deliver a durable local research knowledge base CLI
Stage: third round, focused on explicit review sync from study-ops

Default Outputs

docs/notes/*.md: readable notes and managed synced reviews
data/processed/research-vault.db: local SQLite index and sync metadata
artifacts/outputs/: exports and query snapshots

Directory Responsibilities

src/commands/: CLI entry commands
src/store/: SQLite access, indexing, links, and managed review sync
docs/notes/: note Markdown managed by the project
data/raw/ and data/external/: read-only inputs by default
data/processed/: SQLite database and derived local data
.tmp/: disposable local scratch files

Allowed Modifications

Normal work may edit src/, tests/, docs/, docs/notes/, artifacts/outputs/, data/processed/, and .tmp/
Managed review refresh is allowed only for docs/notes/study-review-YYYY-MM-DD.md

High-Risk Confirmation Rules

Confirm before:

deleting notes, database files, or exports
overwriting data/raw/ or data/external/
writing outside this project root
changing shared templates or sibling projects

Run And Logging Rules

Long-running jobs should stay project-local and write outputs into artifacts/outputs/ or artifacts/logs/
sync-reviews only reads the explicitly provided study-ops project root
Conflicts from locally edited managed notes must be reported, not overwritten

Key Files

src/cli.js
src/store/notes.js
src/store/reviewSync.js
src/commands/syncReviews.js
tests/run-tests.js

Update Log

2026-04-10: added explicit study-ops review sync, managed metadata, and conflict-aware refresh behavior

Install research-vault and it becomes one more candidate the router can pick - when it fits.

A listing is a routing target with a manifest: what it does, which domains it covers, what it costs and who publishes it. Once installed it sits beside your own models and tools, is scored like any other candidate for each request, and shows up in the trace when it wins. Ratings come from workspaces that installed it, one per account.

research-vault

About