* docs: add user-facing documentation (closes #2253) - 13 docs covering all major features: getting started, chat interface, LLM providers, models/parameters, context/mentions, custom commands, vault search/indexing, agent mode/tools, projects, system prompts, Copilot Plus/self-host, troubleshooting/FAQ, and index - Written for non-technical Obsidian users - Each doc is standalone with cross-references to related docs - All values verified against source code (defaults, model names, etc.) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs: improve user docs with website reference material - getting-started: add glossary (LLM, API, Token, Context Window, Embeddings, RAG, Vector Store) and API key billing note - chat-interface: add user/AI message buttons (edit, copy, delete, insert/replace at cursor, regenerate), [[Note Title]] inline reference syntax, Relevant Notes feature, manual Save Chat button, and auto-compact user experience note - context-and-mentions: add PDF context (+ Add context button) and image context (drag/drop or image button) methods - custom-commands: fix placeholder syntax ({} not {selected text}), add {FolderPath} variable, note tags must be in note properties, add richer example prompts - llm-providers: add LM Studio CORS requirement, 3rd-party CORS warning - vault-search-and-indexing: add cost estimation tip (Count total tokens command), RangeError/partitioning note, tag property note - agent-mode-and-tools: add Revert option, note @composer works in both Plus and Projects modes - projects: add 50+ file type support detail - copilot-plus-and-self-host: add dashboard URL - troubleshooting-and-faq: add first-steps section, RangeError fix, response cut-off fix, notes-not-found checklist, note referencing FAQ, English response FAQ, image/PDF FAQ, privacy note Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * chore: remove UI_RENDERING_PERFORMANCE.md from docs (already in designdocs) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs: add doc maintenance rule to CLAUDE.md Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs: fix custom command variable syntax and project deletion claim Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs: clarify 16 built-in providers + unlimited OpenAI-compatible models Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs: fix semantic search default and partitioning claims Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs: fix self-host status and remaining partitioning claim Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs: fix self-host setup steps, tool count, and memory tool availability Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
4.4 KiB
System Prompts
A system prompt is a set of instructions you give the AI that shapes how it behaves in all conversations. Think of it as a persistent briefing: "You are an assistant that helps me with academic writing. Always cite sources. Respond in formal English."
Overview
Copilot has two layers of system prompts:
- Built-in system prompt — Always active. Defines core behaviors specific to Obsidian (how to format Obsidian links, how to handle note references, etc.)
- Custom system prompt — Optional. You can write your own instructions that are appended to the built-in prompt.
Built-In System Prompt
The built-in prompt is always active and cannot be edited. It tells the AI:
- It is "Obsidian Copilot" — an AI integrated into Obsidian
- How to format Obsidian internal links:
[[Note Title]] - How to format Obsidian image links:
![[image.png]] - How to format LaTeX math: use
$...$not\[...\] - How to handle @vault and @tool mentions
- To use
-for bullet points (not*) - To respond in the language of the user's query
- To treat "note" as referring to an Obsidian note
This prompt ensures Copilot's output is correctly formatted for Obsidian and aware of its context.
Warning
: Disabling the built-in prompt can break features like Vault QA, memory, and agent tools. Avoid disabling it unless you have a specific reason.
Custom System Prompts
Custom system prompts let you add your own instructions on top of the built-in prompt.
Where They're Stored
Custom system prompts are stored as markdown files in your vault, in the folder:
copilot/system-prompts/
You can change this folder in Settings → Copilot → Advanced → System Prompts Folder Name.
Creating a System Prompt
From Settings
- Go to Settings → Copilot → Advanced
- Under User System Prompt, click the
+button - Enter a title for the prompt (e.g., "Academic Writing")
- A new markdown file is created in your system prompts folder
- Open the file and write your instructions
From the System Prompts Folder
Create any .md file in the copilot/system-prompts/ folder. Its filename (without .md) becomes the prompt's title.
Writing Good System Prompts
Tips for effective system prompts:
- Be specific: "Always respond in bullet points with no more than 5 bullets" is better than "be concise"
- Set a persona: "You are an expert in cognitive science helping me build a Zettelkasten"
- Define output format: Specify if you want headers, lists, prose, or code blocks
- Set language: "Always respond in French" if you want non-English output
- Limit scope: "Only answer questions related to my research notes on climate science"
Example system prompt:
You are a Zettelkasten assistant helping me build a knowledge base.
- Always connect new ideas to existing notes when possible
- Suggest up to 3 related concepts per response
- Format all note suggestions as [[Note Title]]
- Keep responses concise — under 200 words
Setting a Global Default
You can set one of your custom prompts as the global default — it will be used for all new chat sessions:
- Go to Settings → Copilot → Advanced
- Under Default System Prompt, select your prompt from the dropdown
- Any new conversation will start with this prompt active
To stop using a custom default, select None (use built-in prompt) from the dropdown.
Per-Session Override (Gear Icon)
You can override the system prompt for just the current conversation:
- Click the gear icon in the chat panel toolbar
- Select a different system prompt (or type a one-off prompt directly)
- This applies to the current session only and resets when you start a new chat
How Prompts Combine
When you have a custom prompt active:
- The built-in Copilot prompt runs first
- Your custom prompt is appended after it
Both sets of instructions are active simultaneously. Your custom instructions can refine, restrict, or extend the default behavior, but they don't replace it.
Per-Project System Prompts
Each Project can have its own system prompt, independent of the global default. Configure this in the project settings under System Prompt.
Related
- Chat Interface — Per-session gear settings
- Projects — Per-project system prompts
- Getting Started — Initial setup