mirror of
https://github.com/rait-09/obsidian-agent-client.git
synced 2026-07-22 16:30:32 +00:00
1.5 KiB
1.5 KiB
Context Files
Provide additional context to your AI agent using context files.
What are Context Files?
Context files are special Markdown files that contain instructions, preferences, or information that the agent should know about. These files are automatically read by the agent at the start of a session.
::: tip Context files are an agent feature, not a plugin feature. Refer to your agent's documentation for details. :::
Supported Context Files
Each agent uses its own context file:
| Agent | Context File |
|---|---|
| Claude Code | CLAUDE.md |
| Codex | AGENTS.md |
| Gemini CLI | GEMINI.md |
| Mistral Vibe | AGENTS.md |
| OpenCode | AGENTS.md (falls back to CLAUDE.md) |
| Kiro | AGENTS.md (also .kiro/steering/*.md) |
Place the context file in your vault root to have the agent read it automatically.
Example
# Vault Context
## Overview
This vault contains my personal notes and research.
## Preferences
- Write in a concise, clear style
- Use bullet points for lists
- Prefer Markdown formatting
## Important Notes
- `Templates/` - Note templates
- `Daily/` - Daily notes
## Conventions
- Use YYYY-MM-DD format for dates
- Tag notes with relevant topics
Best Practices
- Keep it focused: Include only relevant information
- Update regularly: Keep context current with your vault
- Be specific: Provide concrete examples and preferences
What to Avoid
- Sensitive information (API keys, passwords)
- Very long files (agents have context limits)
- Outdated information