Skip to content
Docs/Agent Rules
Agent Rules

Agent Rules File

This is the exact file that context-vault setup installs on your system. You can review it here before running setup, or install it manually.

Transparency first

This is the only file context-vault installs outside of the MCP config. It is additive (never overwrites your existing rules), versioned, and you can edit or delete it at any time. Run context-vault uninstall to remove everything setup created.

Rules file content

agent-rules.mdv3.1.7
# Context Vault — Agent Rules

You have access to a persistent knowledge vault via MCP tools (`get_context`, `save_context`, `list_context`, `delete_context`). Use it to build lasting memory across sessions.

## When to Retrieve

Check the vault when you're about to invest effort that past knowledge could shortcut. Apply this test: "Might I or a previous session have encountered this before?" If yes, search first.

Retrieval triggers:
- **Starting a session**: call `session_start()` or `get_context(query: "<project or task context>")` to load relevant prior knowledge
- **Hitting an error**: search for the error message or root cause before debugging from scratch
- **Making a decision**: check if this architectural or design choice was already made and why
- **Integrating with an API, library, or service**: search for known quirks, gotchas, or working patterns
- **Entering an unfamiliar area of the codebase**: check for prior insights about that module or domain
- **Before saving**: search to avoid duplicates and to update existing entries instead

A vault search takes milliseconds. Debugging from scratch takes minutes. Always check first.

## When to Save

Save when you encounter something a future session would benefit from knowing. Apply this test: "Would I tell a colleague about this to save them time?" If yes, save it.

Save triggers:
- Solved a non-obvious bug (root cause was not apparent from the error)
- Discovered undocumented API/library/tool behavior
- Found a working integration pattern requiring non-obvious configuration
- Hit a framework limitation and found a workaround
- Made an architectural decision with tradeoffs worth preserving

## When NOT to Save

- Facts derivable from reading the current code or git history
- The fix itself (that belongs in the commit, not the vault)
- Generic programming knowledge you already know
- Session-specific state (files edited, commands run)

## How to Save

Every entry must have:
- `title`: clear, specific (not "auth fix" but "Express 5 raw body parser breaks Stripe webhook verification")
- `tags`: at minimum a `bucket:<project>` tag for scoping
- `kind`: insight, pattern, reference, decision, or event
- `tier`: `working` for active context, `durable` for long-term reference

Capture what was learned (the insight), why it matters (what problem it prevents), and when it applies (what context makes it relevant).

## Session Review

At the end of significant work sessions, review what you learned. If the session produced novel knowledge (not every session does), save 1-3 consolidated entries. Prefer one solid entry over multiple fragments.

Automatic install

The fastest way: run setup and it detects your AI client automatically.

npx context-vault setup

Prints every file path it creates or modifies. Use --dry-run to preview without writing anything, or --no-rules to install only the MCP config.

Manual install by client

Claude Code

Save as a rules file in ~/.claude/rules/

Install path:~/.claude/rules/context-vault.md
  1. 1.Create the directory if it does not exist: mkdir -p ~/.claude/rules
  2. 2.Save the rules file: copy the content above to ~/.claude/rules/context-vault.md
  3. 3.Claude Code automatically loads all .md files from ~/.claude/rules/ on startup.

Or run npx context-vault setup to install automatically.

Cursor

Append to .cursorrules in your project root

Install path:.cursorrules (project root)
  1. 1.Navigate to your project root.
  2. 2.Append the rules content to .cursorrules (create if it does not exist).
  3. 3.Cursor loads .cursorrules automatically for each project.

Or run npx context-vault setup to install automatically.

Windsurf

Append to .windsurfrules in your project root

Install path:.windsurfrules (project root)
  1. 1.Navigate to your project root.
  2. 2.Append the rules content to .windsurfrules (create if it does not exist).
  3. 3.Windsurf loads .windsurfrules automatically for each project.

Or run npx context-vault setup to install automatically.

Other MCP clients

Paste directly into system prompt or agent instructions

Install path:System prompt / agent instructions
  1. 1.Copy the rules content above.
  2. 2.Paste it into your client's system prompt, agent instructions, or rules configuration.
  3. 3.The rules work with any MCP-compatible client.

Agent-assisted setup

After installing the rules file, paste this prompt into your AI session for conflict detection, project-aware bucket setup, and rule merging:

Paste into your AI session
/vault setup

This runs the agent-assisted setup flow: verifies the MCP connection, detects active projects, proposes vault bucket configuration, and resolves conflicts with existing rules.