MCPcopy
hub / github.com/logancyang/obsidian-copilot

github.com/logancyang/obsidian-copilot @3.3.3 sqlite

repository ↗ · DeepWiki ↗ · release 3.3.3 ↗
3,866 symbols 10,907 edges 537 files 1,101 documented · 28%
README

Copilot for Obsidian

The Ultimate AI Assistant for Your Second Brain

GitHub release (latest SemVer) Obsidian Downloads

Documentation | Youtube | Report Bug | Request Feature

Reward Banner

The What

Copilot for Obsidian is your in‑vault AI assistant with chat-based vault search, web and YouTube support, powerful context processing, and ever-expanding agentic capabilities within Obsidian's highly customizable workspace - all while keeping your data under your control.

The Why

Today's AI giants want you trapped: your data on their servers, prompts locked to their models, and switching costs that keep you paying. When they change pricing, shut down features, or terminate your account, you lose everything you built.

We are building the opposite. Our goal is to create a portable agentic experience with no provider lock-in. Data is always yours. Use whatever LLM you like. Imagine that a brand new model drops, you run it on your own hardware, and it already knows about you (long-term memory), knows how to run the same commands and tools you have defined over time (as just markdown files), and becomes the thought partner and assistant that you own. This is AI that grows with you, not a subscription you're hostage to.

This is the future we believe in. If you share this vision, please support this project!

Key Features

  • 🔒 Your data is 100% yours: Local search and storage, and full control of your data if you use self-hosted models.
  • 🧠 Bring Your Own Model: Tap any OpenAI-compatible or local model to uncover insights, spark connections, and create content.
  • 🖼️ Multimedia understanding: Drop in webpages, YouTube videos, images, PDFs, EPUBS, or real-time web search for quick insights.
  • 🔍 Smart Vault Search: Search your vault with chat, no setup required. Embeddings are optional. Copilot delivers results right away.
  • ✍️ Composer and Quick Commands: Interact with your writing with chat, apply changes with 1 click.
  • 🗂️ Project Mode: Create AI-ready context based on folders and tags. Think NotebookLM but inside your vault!
  • 🤖 Agent Mode (Plus): Unlock an autonomous agent with built-in tool calling. No commands needed. Copilot automatically triggers vault, web searches or any other relevant tool when relevant.

Copilot's Agent can call the proper tools on its own upon your request.

Product UI screenshot

Table of Contents

Copilot V3 is a New Era 🔥

After months of hard work, we have revamped the codebase and adopted a new paradigm for our agentic infrastructure. It opens the door for easier addition of agentic tools (MCP support coming). We will provide a new version of the documentation soon. Here is a couple of new things that you cannot miss!

  • FOR ALL USERS: You can do vault search out-of-the-box without building an index first (Indexing is still available but optional behind the "Semantic Search" toggle in QA settings).
  • FOR FREE USERS: Image support and chat context menu are available to all users starting from v3.0.0!
  • FOR PLUS USERS: Autonomous agent is available with vault search, web search, youtube, composer and soon a lot other tools! Long-term memory is also a tool the agent can use by itself starting from 3.1.0!

Read the Changelog.

Why People Love It ❤️

  • "Copilot is the missing link that turns Obsidian into a true second brain. I use it to draft investment memos with text, code, and visuals—all in one place. It’s the first tool that truly unifies how I search, process, organize, and retrieve knowledge without ever leaving Obsidian. With AI-powered search, organization, and reasoning built into my notes, it unlocks insights I’d otherwise miss. My workflow is faster, deeper, and more connected than ever—I can’t imagine working without it." - @jasonzhangb, Investor & Research Analyst
  • "Since discovering Copilot, my writing process has been completely transformed. Conversing with my own articles and thoughts is the most refreshing experience I’ve had in decades.” - Mat QV, Writer
  • "Copilot has transformed our family—not just as a productivity assistant, but as a therapist. I introduced it to my non‑technical wife, Mania, who was stressed about our daughter’s upcoming exam; within an hour, she gained clarity on her mindset and next steps, finding calm and confidence." - @screenfluent, A Loving Husband

Get Started

Install Obsidian Copilot

  1. Open Obsidian → Settings → Community plugins.
  2. Turn off Safe mode (if enabled).
  3. Click Browse, search for “Copilot for Obsidian”.
  4. Click Install, then Enable.

Set API Keys

Free User

  1. Go to Obsidian → Settings → Copilot → Basic and click Set Keys.
  2. Choose your AI provider(s) (e.g., OpenRouter, Gemini, OpenAI, Anthropic, Cohere) and paste your API key(s). OpenRouter is recommended.

Copilot Plus/Believer

  1. Copy your license key at your dashboard. Don’t forget to join our wonderful Discord community!
  2. Go to Obsidian → Settings → Copilot → Basic and paste the key into in the Copilot Plus card.

Usage

Free User

Chat Mode: reference notes and discuss ideas with Copilot

Use @ to add context and chat with your note.

<img src="https://github.com/logancyang/obsidian-copilot/raw/3.3.3/images/Add-Context.png" alt="Chat Mode" width="700">

Ask Copilot:

Summarize [[Q3 Retrospective]] and identify the top 3 action items for Q4 based on the notes in {01-Projects}.

<img src="https://github.com/logancyang/obsidian-copilot/raw/3.3.3/images/Chat-Mode.png" alt="Chat Mode" width="700">

Vault QA Mode: chat with your entire vault

Ask Copilot:

What are the recurring themes in my research regarding the intersection of AI and SaaS?

<img src="https://github.com/logancyang/obsidian-copilot/raw/3.3.3/images/Vault-Mode.png" alt="Vault Mode" width="700">

Copilot's Command Palette

Copilot's Command Palette puts powerful AI capabilities at your fingertips. Access all commands in chat window via / or via right-click menu on selected text.

Add selection to chat context

Select text and add it to context. Recommend shortcut: ctrl/cmd + L

<img src="https://github.com/logancyang/obsidian-copilot/raw/3.3.3/images/Add-Selection-to-Context.png" alt="Add Selection to Context" width="700">

Quick Command

Select text and apply action without opening chat. Recommend shortcut: ctrl/cmd + K

<img src="https://github.com/logancyang/obsidian-copilot/raw/3.3.3/images/Quick-Command.png" alt="Quick Command" width="700">

Edit and Apply with One Click

Select text and edit with one RIGHT click.

<img src="https://github.com/logancyang/obsidian-copilot/raw/3.3.3/images/One-Click-Commands.png" alt="One-Click Commands" width="700">

Create your Command

Create commands and workflows in Settings → Copilot → Command → Add Cmd.

<img src="https://github.com/logancyang/obsidian-copilot/raw/3.3.3/images/Create-Command.png" alt="Create Command" width="700">

Command Palette in Chat

Type / to use Command Palette in chat window.

<img src="https://github.com/logancyang/obsidian-copilot/raw/3.3.3/images/Prompt-Palette.png" alt="Prompt Palette" width="700">

Relevant Notes: notes suggestions based on semantic similarity and links

Appears automatically when there's useful related content and links.

Use it to quickly reference past research, ideas, or decisions—no need to search or switch tabs.

<img src="https://github.com/logancyang/obsidian-copilot/raw/3.3.3/images/Relevant-Notes.png" alt="Relevant Notes" width="700">

Copilot Plus/Believer

Copilot Plus brings powerful AI agentic capabilities, context-aware actions and seamless tool integration—built to elevate your knowledge work in Obsidian.

Get Precision Insights From a Specific Time Window

In agent mode, ask copilot:

What did I do last week?

<img src="https://github.com/logancyang/obsidian-copilot/raw/3.3.3/images/Time-Based-Queries.png" alt="Time-Based Queries" width="700">

Agent Mode: Autonomous Tool Calling

Copilot's agent automatically calls the right tools—no manual commands needed. Just ask, and it searches the web, queries your vault, and combines insights seamlessly.

Ask Copilot in agent mode:

Research web and my vault and draft a note on AI SaaS onboarding best practices.

<img src="https://github.com/logancyang/obsidian-copilot/raw/3.3.3/images/Agent-Mode.png" alt="Agent Mode" width="700">

Understand Images in Your Notes

Copilot can analyze images embedded in your notes—from wireframes and diagrams to screenshots and photos. Get detailed feedback, suggestions, and insights based on visual content.

Ask Copilot to analyze your wireframes:

Analyze the wireframe in [[UX Design - Mobile App Wireframes]] and suggest improvements for the navigation flow.

<img src="https://github.com/logancyang/obsidian-copilot/raw/3.3.3/images/Note-Image.png" alt="Image Understanding" width="700">

One Prompt, Every Source—Instant Summaries from PDFs, Videos, and Web

In agent mode, ask Copilot

*Compare the information about [Agent Memory] from this youtube video: [URL], this PDF [file], and @web[search results]. Start with your

 conclusion in bullet points in your response*




<img src="https://github.com/logancyang/obsidian-copilot/raw/3.3.3/images/One-Prompt-Every-Source.png" alt="One Prompt, Every Source" width="700">

Need Help?

  • Check the documentation for setup guides, how-tos, and advanced features.
  • Watch Youtube for walkthroughs.
  • If you're experiencing a bug or have a feature idea, please follow the steps below to help us help you faster:
  • 🐛 Bug Report Checklist
    • ☑️Use the bug report template when reporting an issue
    • ☑️Enable Debug Mode in Copilot Settings → Advanced for more detailed logs
    • ☑️Open the dev console to collect error messages:
    • Mac: Cmd + Option + I
    • Windows: Ctrl + Shift + I
    • ☑️Turn off all other plugins, keeping only Copilot enabled
    • ☑️Attach relevant console logs to your report
    • ☑️Submit your bug report here
  • 💡 Feature Request Checklist
    • ☑️Use the feature request template for requesting a new feature
    • ☑️Clearly describe the feature, why it matters, and how it would help
    • ☑️Submit your feature request here

FAQ

Why isn’t Vault search finding my notes?

If you're using the Vault QA mode (or the tool @vault in Plus), try the following:

  • Ensure you have a working embedding model from your AI model's provider (e.g. OpenAI). Watch this video: AI Model Setup (API Key)
  • Ensure your Copilot indexing is up-to-date. Watch this video: Vault Mode
  • If issues persist, run Force Re-Index or use List Indexed Files from the Command Palette to inspect what's included in the index.
  • ⚠️ Don’t switch embedding models after indexing—it can break the results.

Why is my AI model returning error code 429: ‘Insufficient Quota’?<

Extension points exported contracts — how you extend this code

DocumentRetriever (Interface)
(no doc) [6 implementers]
src/search/RetrieverFactory.ts
FileParser (Interface)
(no doc) [4 implementers]
src/tools/FileParserManager.ts
ChainRunner (Interface)
(no doc) [4 implementers]
src/LLMProviders/chainRunner/BaseChainRunner.ts
DataviewApi (Interface)
Minimal typing for the Dataview plugin API (third-party plugin, no official types).
src/contextProcessor.ts
StripFrontmatterOptions (Interface)
* Options for stripFrontmatter.
src/utils.ts
BaseSelectedTextContext (Interface)
* Base interface for selected text context
src/types/message.ts
DiffRow (Interface)
Represents a row in the diff view with original and modified content
src/components/composer/ApplyView.tsx
VariableProcessingResult (Interface)
* Represents the result of processing a custom prompt variable.
src/commands/customCommandUtils.ts

Core symbols most depended-on inside this repo

logInfo
called by 479
src/logger.ts
replace
called by 274
src/editor/replaceGuard.ts
logError
called by 273
src/logger.ts
getSettings
called by 231
src/settings/model.ts
set
called by 170
src/cache/pdfCache.ts
logWarn
called by 154
src/logger.ts
get
called by 154
src/cache/pdfCache.ts
cn
called by 134
src/lib/utils.ts

Shape

Function 1,502
Method 1,493
Interface 497
Class 361
Enum 13

Languages

TypeScript100%

Modules by API surface

src/utils.ts73 symbols
src/LLMProviders/chainRunner/utils/modelAdapter.ts43 symbols
src/main.ts41 symbols
src/cache/projectContextCache.ts41 symbols
src/LLMProviders/BedrockChatModel.ts40 symbols
src/services/webViewerService/webViewerServiceTypes.ts38 symbols
src/search/dbOperations.ts37 symbols
src/contextProcessor.ts37 symbols
src/components/modals/project/context-manage-modal.tsx37 symbols
src/aiParams.ts36 symbols
src/LLMProviders/projectManager.ts33 symbols
src/tools/FileParserManager.ts32 symbols

Dependencies from manifests, versioned

@codemirror/state6.5.2 · 1×
@codemirror/view6.36.4 · 1×
@dnd-kit/core6.3.1 · 1×
@dnd-kit/sortable10.0.0 · 1×
@dnd-kit/utilities3.2.2 · 1×
@eslint-react/eslint-plugin1.38.4 · 1×
@google/generative-ai0.24.0 · 1×
@jest/globals29.7.0 · 1×
@langchain/anthropic1.3.29 · 1×
@langchain/classic1.0.9 · 1×
@langchain/core1.1.29 · 1×

For agents

$ claude mcp add obsidian-copilot \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact