Skip to content

bearcatat/obsidian-agent

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

217 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Obsidian Agent

Version License Obsidian

A powerful Obsidian plugin that brings AI assistant capabilities directly into your note-taking workflow. Chat with AI, manage tools, and enhance your productivity without leaving Obsidian.

δΈ­ζ–‡ζ–‡ζ‘£

πŸ“‘ Table of Contents

✨ Features

AI Chat

  • Natural Conversations - Chat with AI using state-of-the-art language models
  • Context Aware - Automatically includes current note and related notes in conversations
  • Multi-Model Support - DeepSeek, OpenAI, Anthropic, Moonshot, Google Gemini, and more
  • Image Support - Paste images from clipboard into conversations

πŸ› οΈ Extensible Tools

  • Built-in Tools - Time, note reading/writing, file editing, web search, local search, command execution, and more
  • MCP Servers - Extend with Model Context Protocol servers
  • SubAgents - Create specialized AI assistants for specific tasks
  • Tool Management - Enable/disable tools with granular permissions

βš™οΈ Flexible Configuration

  • Customizable API endpoints, temperature, max tokens
  • Persistent settings across sessions
  • Per-model configuration support

πŸ“¦ Installation

Install using BRAT (Recommended)

  1. Install and enable the BRAT plugin from the Obsidian Community Plugins.
  2. Open BRAT settings, click "Add Beta plugin".
  3. Enter the repository address: https://github.com/bearcatat/obsidian-agent
  4. Click "Add Plugin".
  5. Once installed, go to Obsidian Settings -> Community Plugins and enable "Obsidian Agent".

Manual Installation

  1. Download the latest release from GitHub Releases
  2. Extract to .obsidian/plugins/obsidian-agent/
  3. Reload Obsidian and enable the plugin

πŸš€ Quick Start

  1. Open the Plugin - Click the icon in the left sidebar or use the command palette
  2. Configure a Model - Add your API key in Settings β†’ Obsidian Agent β†’ Models
  3. Start Chatting - Type your question and press Enter
  4. Add Context - Drag notes or paste images to include them in the conversation

πŸ“– Usage Guide

Basic Chat

Simply type your question and press Enter. The AI will automatically analyze your current note and respond intelligently.

Using Context

  • Notes - Drag and drop notes or click "Add Context" to include them
  • Images - Paste images (Ctrl+V) to add visual context
  • Active Note - The currently open note is automatically included

Tool Examples

Ask naturally and the AI will use appropriate tools:

  • "Find all notes mentioning 'project plan'"
  • "Help me improve this note's structure"
  • "Search for TODO items in my journal"

SubAgents

Create specialized assistants for specific workflows:

  1. Go to Settings β†’ Obsidian Agent β†’ SubAgents
  2. Click "Add SubAgent"
  3. Define the system prompt and select tools

πŸ”§ Configuration

Supported Models

Provider Direct API Notes
DeepSeek βœ… Full support
OpenAI βœ… Including compatible APIs
Anthropic βœ… No thinking mode
Moonshot ⚠️ Enable "Use CORS Proxy" in model settings
Google Gemini βœ… Full support
OpenAI Compatible βœ… Support for OpenAI-compatible APIs

MCP Servers

Extend functionality with external tools:

  1. Settings β†’ Obsidian Agent β†’ MCP Servers
  2. Add server configuration (stdio/http/sse)
  3. Enable desired tools from each server

πŸ“„ License

This project is licensed under the AGPL-3.0 license.

πŸ™ Acknowledgments


Made with ❀️ for the Obsidian community

About

πŸ€– An intelligent AI assistant for Obsidian featuring multi-model support, context awareness, and built-in tools to enhance your note management experience.

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages