README file from
GithubCoDriver
Chat with your Obsidian vault without leaving Obsidian.
CoDriver puts your preferred language models in the right sidebar. Create, improve, and organize notes without giving up control over changes.
What you can do
- Create notes, append content, update text and properties, move files, and send notes to trash.
- Review note patches as a unified diff or side-by-side comparison, then accept, reject, or roll back an applied patch.
- Connect OpenAI-compatible providers, Gemini, or Anthropic and switch models from the chat composer.
- See every vault tool call and control automatic execution per tool.
Add your first provider
- Open Settings -> CoDriver Settings -> Providers.
- Click Add model under LLM providers.
- Choose the Provider type, enter a name, and check the endpoint.
- Select or create an API key entry. Keys stay in Obsidian secret storage.
- Click Test connection to load available models.
- Choose the Default model and click Save.
| Provider type | Endpoint | Notes |
|---|---|---|
| OpenAI | Your provider's OpenAI-compatible /v1 endpoint |
Hosted services and local servers are supported. |
| Gemini | https://generativelanguage.googleapis.com |
The API version defaults to v1beta. Tool mode selects Google Search or Custom tools; Google Search mode does not expose MCP tools to the model. |
| Anthropic | https://api.anthropic.com |
Uses the native Claude Messages API. The endpoint is fixed. |
If the test fails, check the endpoint, API key, account access, and local server status. OpenAI-compatible endpoints commonly end in /v1.
Work with your vault
CoDriver works with your vault through its built-in MCP server. Its configurable tools use the native Obsidian API to search, read, create, update, move, and trash vault files.

After applying a patch, Roll back can restore the previous version while its review state remains in the live session. If the note has changed again, CoDriver refuses an unsafe rollback.
More features
- Attachments and audio: Add supported files to the conversation and transcribe audio.
- Skills and commands: Reuse instructions, local references, and prompt templates.
- MCP: Connect external HTTP tools, or stdio tools on supported desktop runtimes.
- MCP limits: Max tools warns before an oversized catalog is sent to the model; Continue sends all available tools for that request. Max calls warns before another automatic tool call. Continue for session skips further Max calls warnings for the current request. Output chars lets you review a large tool result before sending it to the model. Earlier eligible results remain available during the live session; Maximum context size reviews the combined request.
- Local sessions: Keep chat history on your device without saving attachment contents, transcripts, or tool results in it.
Safety and privacy
- Active-note content is never injected automatically.
- Provider keys use Obsidian secret storage.
- Proposed edits are revalidated before application or rollback.
- MCP arguments are validated locally against each tool's discovered schema without coercion; invalid calls are returned to the model and are never executed.
- Diagnostics exclude note content, prompts, provider responses, tool data, transcripts, and secrets.
Your selected provider still receives the context required for the current request. Review that provider's privacy and retention terms before sending sensitive material.
Installation
- Open the latest CoDriver release.
- Download
main.js,manifest.json, andstyles.css. - Copy them into
.obsidian/plugins/codriver/inside your vault. - Open Settings -> Community plugins, turn off Restricted mode, and enable CoDriver.
To update CoDriver, download the latest versions of the same three files, replace the installed copies, and reload Obsidian.
The chat shows a compact release notes banner on first installation and after a newer version is installed. What's new opens the local notes window; Dismiss hides the banner. Either action remembers the version in local plugin settings, so the banner stays hidden after reopening the chat or restarting the plugin. The notes window never opens automatically and requires no network access.
The public GitHub repository contains the reviewed source snapshot and generated release artifacts for each public version. Its root build.mjs rebuilds main.js without registry dependencies, and the committed bundle must match that build exactly. Private release-control instructions, internal automation, and tests are not included in the public snapshot.
The build embeds only docs/releases/<manifest version>.md in main.js. Release authors update that file with the matching version metadata; the build rejects missing, empty, mismatched, oversized, or non-ASCII notes. Supported notes formatting is paragraphs, level-two/three headings, and dash lists; other markup is displayed as plain text. Links and images in these notes do not load external resources.
GitHub's automatically generated source archives are source snapshots, not installable CoDriver packages. Install CoDriver using the three assets attached to a matching GitHub release.
Requirements
- Obsidian
1.5.0or newer. - A supported provider account or server.
- Desktop Obsidian with Node subprocess support for stdio MCP servers.
CoDriver works inside Obsidian. It is not a background automation agent or a CLI coding tool.
[!WARNING] CoDriver is still evolving. For peace of mind, try it in a test vault first and keep regular backups of important notes.
License
CoDriver is available under the MIT License. See Third-Party Notices for vendored dependencies and their licenses.