No description
Find a file
Aaron Bockelie 0ef8eec8a0 feat: Add API key authentication for enhanced security
- Generate secure API key on first plugin load
- Implement HTTP Basic Auth middleware for all endpoints
- Add authentication settings UI with copy/regenerate functionality
- Update configuration examples to include auth credentials
- Maintain backward compatibility (auth optional if no key set)
- Closes #9

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-07-15 18:11:57 -05:00
.github docs: Add comprehensive project documentation and security audit 2025-07-12 00:14:45 -05:00
docs docs: Add comprehensive project documentation and security audit 2025-07-12 00:14:45 -05:00
github-issues docs: Add comprehensive project documentation and security audit 2025-07-12 00:14:45 -05:00
src feat: Add API key authentication for enhanced security 2025-07-15 18:11:57 -05:00
tests feat: Implement structured patch targeting for headings, blocks, and frontmatter 2025-07-06 22:47:02 -05:00
.eslintrc.json feat: Implement DOM-based image processing for v0.3.1 2025-06-27 13:08:47 -05:00
.gitignore feat: Add concurrent sessions support for agent swarms (v0.5.8a) 2025-07-05 17:20:21 -05:00
ARCHITECTURE.md fix: Remove Node.js dependencies causing plugin load failures 2025-06-27 11:34:55 -05:00
build-worker.js feat: Add worker threads for true concurrent processing (v0.5.8b) 2025-07-05 17:54:49 -05:00
CHANGELOG.md docs: Add comprehensive project documentation and security audit 2025-07-12 00:14:45 -05:00
CLAUDE.md docs: Add pre-push quality check reminder to CLAUDE.md 2025-07-06 23:01:07 -05:00
CONTRIBUTING.md docs: Add comprehensive project documentation and security audit 2025-07-12 00:14:45 -05:00
DEVELOPMENT.md docs: Update documentation with v0.3.3 testing results and roadmap 2025-06-27 13:38:34 -05:00
esbuild.config.mjs feat: Implement proper MCP SDK with StreamableHTTPServerTransport 2025-06-27 11:59:25 -05:00
jest.config.js feat: Add linting, testing, and development documentation 2025-06-27 11:18:36 -05:00
LICENSE chore: Prepare for v0.5.3 release and community plugin submission 2025-07-04 16:28:01 -05:00
manifest.json fix: Correct MCP configuration command display in settings panel 2025-07-13 21:39:04 -05:00
package-lock.json feat: Implement DOM-based image processing for v0.3.1 2025-06-27 13:08:47 -05:00
package.json feat: Add API key authentication for enhanced security 2025-07-15 18:11:57 -05:00
PROJECT-PLAN.md Initial working plugin for BRAT testing 2025-06-27 11:00:05 -05:00
README.md docs: Improve README formatting and add semantic tools explanation 2025-07-11 21:27:32 -05:00
REQUIREMENTS.md Initial working plugin for BRAT testing 2025-06-27 11:00:05 -05:00
SECURITY.md docs: Add comprehensive project documentation and security audit 2025-07-12 00:14:45 -05:00
styles.css feat: Add API key authentication for enhanced security 2025-07-15 18:11:57 -05:00
SUBMISSION-CHECKLIST.md chore: Prepare for v0.5.3 release and community plugin submission 2025-07-04 16:28:01 -05:00
sync-version.mjs fix: Resolve version display issues in Obsidian (v0.3.2) 2025-06-27 13:11:40 -05:00
test-concurrent.js feat: Add worker threads for true concurrent processing (v0.5.8b) 2025-07-05 17:54:49 -05:00
tsconfig.json feat: Add linting, testing, and development documentation 2025-06-27 11:18:36 -05:00
version-bump.mjs Initial working plugin for BRAT testing 2025-06-27 11:00:05 -05:00
versions.json fix: Correct author name to Aaron Bockelie 2025-06-27 11:19:25 -05:00

Obsidian MCP Plugin

📋 Community Plugin Status: This plugin is currently under review for inclusion in the Obsidian Community Plugins directory. Submitted on July 10, 2025 - PR #6991

A high-performance Model Context Protocol (MCP) server implemented as an Obsidian plugin, providing AI tools with direct vault access through HTTP transport.

Overview

This plugin brings MCP capabilities directly into Obsidian, eliminating the need for external servers or the REST API plugin. It provides semantic, AI-optimized operations that consolidate multiple tools into intelligent workflows with contextual hints.

What are "Semantic Tools"?

Unlike basic tools that just return data, semantic tools are self-guiding. When an AI agent uses a semantic tool, it doesn't just get the requested information—it also receives smart suggestions about what to do next. This creates a natural workflow where each action leads intelligently to the next, helping AI agents complete complex tasks without getting stuck or needing constant human guidance.

Example: When searching for a file, a semantic tool doesn't just return search results. It also suggests: "Found 3 files matching 'meeting notes'. Consider using view to read the most recent one, or graph traverse to explore related documents."

Obsidian MCP Plugin Settings

Key Features

  • Direct Obsidian Integration: Runs natively within Obsidian for maximum performance
  • HTTP MCP Transport: Compatible with Claude Desktop, Claude Code, Cline, and other MCP clients
  • Semantic Operations: Enhanced search with Obsidian operators, intelligent fragment retrieval, and workflow guidance
  • No External Dependencies: No need for the REST API plugin or external servers
  • High Performance: Sub-100ms response times with direct vault access
  • Concurrent Sessions: Support for multiple AI agents working simultaneously (v0.5.8+)
  • Worker Thread Processing: CPU-intensive operations run in parallel threads for non-blocking performance

Installation

Note

: This plugin is currently pending review for the Obsidian Community Plugins directory. Until approved, please use the BRAT installation method below.

Current Installation: Via BRAT (Beta Reviewer's Auto-update Tool)

Since this plugin is not yet in the Community Plugins directory, you'll need to use BRAT to install it:

  1. Install BRAT:

    • Open Obsidian Settings → Community Plugins
    • Browse and search for "BRAT"
    • Install and enable the BRAT plugin
  2. Add This Plugin:

    • In Obsidian settings, go to BRAT settings
    • Click "Add Beta Plugin"
    • Enter: https://github.com/aaronsb/obsidian-mcp-plugin
    • Click "Add Plugin"
  3. Enable the Plugin:

    • Go to Settings → Community Plugins
    • Find "Obsidian MCP Plugin" and enable it
    • The plugin will auto-update through BRAT

Future Installation: Via Community Plugins (After Approval)

Once this plugin is approved and available in the Obsidian Community Plugins directory:

  1. Open Obsidian Settings → Community Plugins
  2. Click "Browse" and search for "MCP"
  3. Find "Obsidian MCP Plugin" by Aaron Bockelie
  4. Click "Install" then "Enable"

For BRAT Users: After the plugin is approved, you can remove it from BRAT and install it normally through Community Plugins to receive standard updates.

Configuration

  1. Enable the Server:

    • Go to plugin settings
    • Toggle "Enable HTTP Server"
    • Default port is 3001 (configurable)
  2. Connect Your MCP Client:

    Claude Code

    claude mcp add obsidian http://localhost:3001/mcp --transport http
    

    Claude Desktop / Other Clients

    Option 1: Direct HTTP Transport (if your client supports it)

    {
      "mcpServers": {
        "obsidian": {
          "transport": {
            "type": "http",
            "url": "http://localhost:3001/mcp"
          }
        }
      }
    }
    

    Option 2: Via mcp-remote (recommended for Claude Desktop)

    Since Claude Desktop might not support streaming HTTP transport yet, use mcp-remote:

    {
      "mcpServers": {
        "obsidian-vault-name": {
          "command": "npx",
          "args": [
            "mcp-remote",
            "http://localhost:3001/mcp"
          ]
        }
      }
    }
    

    Configuration file locations:

    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: %APPDATA%\Claude\claude_desktop_config.json
    • Linux: ~/.config/Claude/claude_desktop_config.json

Concurrent Sessions for Agent Swarms (v0.5.8+)

Enable multiple AI agents to work with your vault simultaneously without blocking each other:

  1. Enable in Settings:

    • Go to plugin settings
    • Find "Concurrent Sessions" section
    • Toggle "Enable Concurrent Sessions for Agent Swarms"
    • Adjust max connections if needed (default: 32)
  2. Architecture:

    • Each AI session gets its own isolated MCP server instance
    • True parallel processing - no blocking between sessions
    • Automatic session management with 1-hour timeout
    • Session reuse for reconnecting clients
  3. Monitor Active Sessions:

    • Use the obsidian://session-info resource to view:
      • Active sessions with "This is you!" indicator
      • Session age, idle time, and request counts
      • Server pool utilization statistics
  4. Use Cases:

    • Multiple Claude instances working on different parts of your vault
    • AI agent teams collaborating on research or writing projects
    • Parallel processing of large knowledge bases
    • Non-blocking operation for time-sensitive workflows

Available Tools

🗂️ vault - File and Folder Operations

  • list - List files and directories
  • read - Read file content with fragments for large files
  • create - Create new files and directories
  • update - Update existing files
  • delete - Delete files and folders
  • search - Enhanced search with Obsidian operators
  • fragments - Get relevant excerpts from files
  • move - Move files to new locations (preserves links)
  • rename - Rename files in place (preserves links)
  • copy - Create copies of files
  • split - Split files by headings, delimiter, lines, or size
  • combine - Merge multiple files with sorting options
  • concatenate - Simple two-file joining

🔍 Search Operators:

  • file: - Search by filename or extension (e.g., file:.png)
  • path: - Search in file paths
  • content: - Search only in file content
  • tag: - Search for tags
  • "exact phrase" - Search for exact phrases
  • term1 OR term2 - Search for either term
  • /regex/flags - Regular expression search

✏️ edit - Smart Editing Operations

  • window - Edit with automatic content buffering
  • append - Append content to files
  • patch - Intelligent patching with fuzzy matching
  • at_line - Edit at specific line numbers
  • from_buffer - Recover content from edit buffers

👁️ view - Content Viewing and Navigation

  • file - View complete files with metadata
  • window - View content windows with context
  • active - Get currently active file
  • open_in_obsidian - Open files in Obsidian

🔄 workflow - AI Workflow Guidance

  • suggest - Get contextual suggestions based on current operations
  • traverse - Explore connected nodes from a starting point
  • neighbors - Get immediate connections of a file
  • path - Find paths between two nodes
  • statistics - Get link counts and statistics for files
  • backlinks - Find all incoming links to a file
  • forwardlinks - Find all outgoing links from a file
  • search-traverse - Search-based graph traversal with snippet chains
  • advanced-traverse - Multi-query traversal with strategies (breadth-first, best-first, beam-search)

Graph Features:

  • links/backlinks/tags - Follow connections during traversal
  • pattern/folder/tag filters - Filter by file patterns, folders, or tags
  • depth/max_nodes - Control traversal depth and maximum nodes
  • relevance_scores - Get relevance scores and snippet chains
  • orphaned/unresolved - Support for orphaned notes and unresolved links

⚙️ system - System Operations

  • info - Get vault and plugin information
  • commands - List and execute Obsidian commands
  • fetch_web - Fetch and convert web content to markdown

Configuration

Plugin Settings

Access plugin settings via Obsidian Settings → Community Plugins → Obsidian MCP Plugin → Settings

  • HTTP Port: Port for MCP server (default: 3001)
  • Enable Concurrent Sessions: Allow multiple AI agents to work simultaneously (default: enabled)
  • Max Concurrent Connections: Maximum number of parallel operations (default: 32)
  • Debug Logging: Enable detailed console logging for troubleshooting

Concurrent Sessions (v0.5.8+)

The plugin supports multiple AI agents working simultaneously through session-based connection pooling:

  • Each MCP client gets a unique session ID
  • Sessions are isolated and tracked independently
  • CPU-intensive operations (search, graph traversal) can run in parallel
  • Worker threads prevent blocking the main Obsidian UI
  • Sessions automatically expire after 1 hour of inactivity

Performance with Concurrent Sessions:

  • Up to 32 simultaneous operations (configurable)
  • Worker threads for CPU-intensive tasks
  • Non-blocking UI during heavy operations
  • Automatic session cleanup and resource management

MCP Resources

  • obsidian://vault-info - Real-time vault metadata including file counts, active file, and plugin status
  • obsidian://session-info - Active sessions and connection pool statistics (when concurrent sessions enabled)

Key Improvements Over External MCP Servers

  1. Performance: Direct vault access eliminates HTTP overhead
  2. Search: Uses Obsidian's native search with advanced operators
  3. Integration: Access to full Obsidian API and plugin ecosystem
  4. Simplicity: Single plugin installation, no external dependencies
  5. Reliability: No separate processes to manage or crash

Architecture

This plugin implements the same semantic operations as obsidian-semantic-mcp but runs directly within Obsidian:

Before: AI Tool → MCP Server → REST API Plugin → Obsidian
Now:    AI Tool → MCP Plugin (within Obsidian)

The critical ObsidianAPI abstraction layer is preserved, allowing all semantic operations to work identically while gaining the performance benefits of direct integration.

Testing Status

Working Features:

  • All 6 semantic tools with all actions
  • Enhanced search with Obsidian operators
  • Graph traversal and link analysis
  • Image viewing and file operations
  • Fragment retrieval for large files
  • Workflow hints and guidance
  • Multi-vault support
  • Port collision detection
  • Cross-platform tested (Linux, Windows, macOS)

Performance Results:

  • File operations: <10ms (vs ~50-100ms with REST API)
  • Search operations: <50ms (vs ~100-300ms)
  • Zero network overhead

Development

# Clone to your vault's plugins folder
git clone https://github.com/aaronsb/obsidian-mcp-plugin .obsidian/plugins/obsidian-mcp-plugin

# Install dependencies
npm install

# Build for development
npm run dev

# Build for production
npm run build

Support

License

MIT


This plugin brings the power of semantic MCP directly into Obsidian, providing AI tools with intelligent, high-performance vault access.