# Obsidian MCP Server [![TypeScript](https://img.shields.io/badge/TypeScript-^5.8.3-blue.svg)](https://www.typescriptlang.org/) [![Model Context Protocol](https://img.shields.io/badge/MCP%20SDK-^1.13.0-green.svg)](https://modelcontextprotocol.io/) [![Version](https://img.shields.io/badge/Version-2.0.7-blue.svg)](./CHANGELOG.md) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Status](https://img.shields.io/badge/Status-Production-brightgreen.svg)](https://github.com/cyanheads/obsidian-mcp-server/issues) [![GitHub](https://img.shields.io/github/stars/cyanheads/obsidian-mcp-server?style=social)](https://github.com/cyanheads/obsidian-mcp-server) **Empower your AI agents and development tools with seamless Obsidian integration!** An MCP (Model Context Protocol) server providing comprehensive access to your Obsidian vault. Enables LLMs and AI agents to read, write, search, and manage your notes and files through the [Obsidian Local REST API plugin](https://github.com/coddingtonbear/obsidian-local-rest-api). Built on the [`cyanheads/mcp-ts-template`](https://github.com/cyanheads/mcp-ts-template), this server follows a modular architecture with robust error handling, logging, and security features. ## 🚀 Core Capabilities: Obsidian Tools 🛠️ This server equips your AI with specialized tools to interact with your Obsidian vault: | Tool Name | Description | Key Features | | :------------------------------------------------------------------------------------- | :-------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | | [`obsidian_read_note`](./src/mcp-server/tools/obsidianReadNoteTool/) | Retrieves the content and metadata of a specified note. | - Read in `markdown` or `json` format.
- Case-insensitive path fallback.
- Includes file stats (creation/modification time). | | [`obsidian_update_note`](./src/mcp-server/tools/obsidianUpdateNoteTool/) | Modifies notes using whole-file operations. | - `append`, `prepend`, or `overwrite` content.
- Can create files if they don't exist.
- Targets files by path, active note, or periodic note. | | [`obsidian_search_replace`](./src/mcp-server/tools/obsidianSearchReplaceTool/) | Performs search-and-replace operations within a target note. | - Supports string or regex search.
- Options for case sensitivity, whole word, and replacing all occurrences. | | [`obsidian_global_search`](./src/mcp-server/tools/obsidianGlobalSearchTool/) | Performs a search across the entire vault. | - Text or regex search.
- Filter by path and modification date.
- Paginated results. | | [`obsidian_list_notes`](./src/mcp-server/tools/obsidianListNotesTool/) | Lists notes and subdirectories within a specified vault folder. | - Filter by file extension or name regex.
- Provides a formatted tree view of the directory. | | [`obsidian_manage_frontmatter`](./src/mcp-server/tools/obsidianManageFrontmatterTool/) | Atomically manages a note's YAML frontmatter. | - `get`, `set`, or `delete` frontmatter keys.
- Avoids rewriting the entire file for metadata changes. | | [`obsidian_manage_tags`](./src/mcp-server/tools/obsidianManageTagsTool/) | Adds, removes, or lists tags for a note. | - Manages tags in both YAML frontmatter and inline content. | | [`obsidian_delete_note`](./src/mcp-server/tools/obsidianDeleteNoteTool/) | Permanently deletes a specified note from the vault. | - Case-insensitive path fallback for safety. | --- ## Table of Contents | [Overview](#overview) | [Features](#features) | [Configuration](#configuration) | | [Project Structure](#project-structure) | [Vault Cache Service](#vault-cache-service) | | [Tools](#tools) | [Resources](#resources) | [Development](#development) | [License](#license) | ## Overview The Obsidian MCP Server acts as a bridge, allowing applications (MCP Clients) that understand the Model Context Protocol (MCP) – like advanced AI assistants (LLMs), IDE extensions, or custom scripts – to interact directly and safely with your Obsidian vault. Instead of complex scripting or manual interaction, your tools can leverage this server to: - **Automate vault management**: Read notes, update content, manage frontmatter and tags, search across files, list directories, and delete files programmatically. - **Integrate Obsidian into AI workflows**: Enable LLMs to access and modify your knowledge base as part of their research, writing, or coding tasks. - **Build custom Obsidian tools**: Create external applications that interact with your vault data in novel ways. Built on the robust `mcp-ts-template`, this server provides a standardized, secure, and efficient way to expose Obsidian functionality via the MCP standard. It achieves this by communicating with the powerful [Obsidian Local REST API plugin](https://github.com/coddingtonbear/obsidian-local-rest-api) running inside your vault. > **Developer Note**: This repository includes a [.clinerules](.clinerules) file that serves as a developer cheat sheet for your LLM coding agent with quick reference for the codebase patterns, file locations, and code snippets. ## Features ### Core Utilities Leverages the robust utilities provided by `cyanheads/mcp-ts-template`: - **Logging**: Structured, configurable logging (file rotation, console, MCP notifications) with sensitive data redaction. - **Error Handling**: Centralized error processing, standardized error types (`McpError`), and automatic logging. - **Configuration**: Environment variable loading (`dotenv`) with comprehensive validation. - **Input Validation/Sanitization**: Uses `zod` for schema validation and custom sanitization logic. - **Request Context**: Tracking and correlation of operations via unique request IDs. - **Type Safety**: Strong typing enforced by TypeScript and Zod schemas. - **HTTP Transport Option**: Built-in Hono server with SSE, session management, CORS support, and pluggable authentication strategies (JWT and OAuth 2.1). ### Obsidian Integration - **Obsidian Local REST API Integration**: Communicates directly with the Obsidian Local REST API plugin via HTTP requests managed by the `ObsidianRestApiService`. - **Comprehensive Command Coverage**: Exposes key vault operations as MCP tools (see [Tools](#tools) section). - **Vault Interaction**: Supports reading, updating (append, prepend, overwrite), searching (global text/regex, search/replace), listing, deleting, and managing frontmatter and tags. - **Targeting Flexibility**: Tools can target files by path, the currently active file in Obsidian, or periodic notes (daily, weekly, etc.). - **Vault Cache Service**: An intelligent in-memory cache that improves performance and resilience. It caches vault content, provides a fallback for the global search tool if the live API fails, and periodically refreshes to stay in sync. - **Safety Features**: Case-insensitive path fallbacks for file operations, clear distinction between modification types (append, overwrite, etc.). ## Installation ### Prerequisites 1. **Obsidian**: You need Obsidian installed. 2. **Obsidian Local REST API Plugin**: Install and enable the [Obsidian Local REST API plugin](https://github.com/coddingtonbear/obsidian-local-rest-api) within your Obsidian vault. 3. **API Key**: Configure an API key within the Local REST API plugin settings in Obsidian. You will need this key to configure the server. 4. **Node.js & npm**: Ensure you have Node.js (v18 or later recommended) and npm installed. ## Configuration ### MCP Client Settings Add the following to your MCP client's configuration file (e.g., `cline_mcp_settings.json`). This configuration uses `npx` to run the server, which will automatically download & install the package if not already present: ```json { "mcpServers": { "obsidian-mcp-server": { "command": "npx", "args": ["obsidian-mcp-server"], "env": { "OBSIDIAN_API_KEY": "YOUR_API_KEY_FROM_OBSIDIAN_PLUGIN", "OBSIDIAN_BASE_URL": "http://127.0.0.1:27123", "OBSIDIAN_VERIFY_SSL": "false", "OBSIDIAN_ENABLE_CACHE": "true" }, "disabled": false, "autoApprove": [] } } } ``` **Note**: Verify SSL is set to false here because the Obsidian Local REST API plugin uses a self-signed certificate by default. If you are deploying this in a production environment, consider using the encrypted HTTPS endpoint and set `OBSIDIAN_VERIFY_SSL` to `true` after configuring your server to trust the self-signed certificate. If you installed from source, change `command` and `args` to point to your local build: ```json { "mcpServers": { "obsidian-mcp-server": { "command": "node", "args": ["/path/to/your/obsidian-mcp-server/dist/index.js"], "env": { "OBSIDIAN_API_KEY": "YOUR_OBSIDIAN_API_KEY", "OBSIDIAN_BASE_URL": "http://127.0.0.1:27123", "OBSIDIAN_VERIFY_SSL": "false", "OBSIDIAN_ENABLE_CACHE": "true" } } } } ``` ### Environment Variables Configure the server using environment variables. These environmental variables are set within your MCP client config/settings (e.g. `cline_mcp_settings.json` for Cline, `claude_desktop_config.json` for Claude Desktop). | Variable | Description | Required | Default | | :------------------------------------ | :----------------------------------------------------------------------- | :------------------- | :----------------------- | | **`OBSIDIAN_API_KEY`** | API Key from the Obsidian Local REST API plugin. | **Yes** | `undefined` | | **`OBSIDIAN_BASE_URL`** | Base URL of your Obsidian Local REST API. | **Yes** | `http://127.0.0.1:27123` | | `MCP_TRANSPORT_TYPE` | Server transport: `stdio` or `http`. | No | `stdio` | | `MCP_HTTP_PORT` | Port for the HTTP server. | No | `3010` | | `MCP_HTTP_HOST` | Host for the HTTP server. | No | `127.0.0.1` | | `MCP_ALLOWED_ORIGINS` | Comma-separated origins for CORS. **Set for production.** | No | (none) | | `MCP_AUTH_MODE` | Authentication strategy: `jwt` or `oauth`. | No | (none) | | **`MCP_AUTH_SECRET_KEY`** | 32+ char secret for JWT. **Required for `jwt` mode.** | **Yes (if `jwt`)** | `undefined` | | `OAUTH_ISSUER_URL` | URL of the OAuth 2.1 issuer. | **Yes (if `oauth`)** | `undefined` | | `OAUTH_AUDIENCE` | Audience claim for OAuth tokens. | **Yes (if `oauth`)** | `undefined` | | `OAUTH_JWKS_URI` | URI for the JSON Web Key Set (optional, derived from issuer if omitted). | No | (derived) | | `MCP_LOG_LEVEL` | Logging level (`debug`, `info`, `error`, etc.). | No | `info` | | `OBSIDIAN_VERIFY_SSL` | Set to `false` to disable SSL verification. | No | `true` | | `OBSIDIAN_ENABLE_CACHE` | Set to `true` to enable the in-memory vault cache. | No | `true` | | `OBSIDIAN_CACHE_REFRESH_INTERVAL_MIN` | Refresh interval for the vault cache in minutes. | No | `10` | ### Connecting to the Obsidian API To connect the MCP server to your Obsidian vault, you need to configure the base URL (`OBSIDIAN_BASE_URL`) and API key (`OBSIDIAN_API_KEY`). The Obsidian Local REST API plugin offers two ways to connect: 1. **Encrypted (HTTPS) - Default**: - The plugin provides a secure `https://` endpoint (e.g., `https://127.0.0.1:27124`). - This uses a self-signed certificate, which will cause connection errors by default. - **To fix this**, you must set the `OBSIDIAN_VERIFY_SSL` environment variable to `"false"`. This tells the server to trust the self-signed certificate. 2. **Non-encrypted (HTTP) - Recommended for Simplicity**: - In the plugin's settings within Obsidian, you can enable the "Non-encrypted (HTTP) Server". - This provides a simpler `http://` endpoint (e.g., `http://127.0.0.1:27123`). - When using this URL, you do not need to worry about SSL verification. **Example `env` configuration for your MCP client:** _Using the non-encrypted HTTP URL (recommended):_ ```json "env": { "OBSIDIAN_API_KEY": "YOUR_API_KEY_FROM_OBSIDIAN_PLUGIN", "OBSIDIAN_BASE_URL": "http://127.0.0.1:27123" } ``` _Using the encrypted HTTPS URL:_ ```json "env": { "OBSIDIAN_API_KEY": "YOUR_API_KEY_FROM_OBSIDIAN_PLUGIN", "OBSIDIAN_BASE_URL": "https://127.0.0.1:27124", "OBSIDIAN_VERIFY_SSL": "false" } ``` ## Project Structure The codebase follows a modular structure within the `src/` directory: ``` src/ ├── index.ts # Entry point: Initializes and starts the server ├── config/ # Configuration loading (env vars, package info) │ └── index.ts ├── mcp-server/ # Core MCP server logic and capability registration │ ├── server.ts # Server setup, transport handling, tool/resource registration │ ├── resources/ # MCP Resource implementations (currently none) │ ├── tools/ # MCP Tool implementations (subdirs per tool) │ └── transports/ # Stdio and HTTP transport logic │ └── auth/ # Authentication strategies (JWT, OAuth) ├── services/ # Abstractions for external APIs or internal caching │ └── obsidianRestAPI/ # Typed client for Obsidian Local REST API ├── types-global/ # Shared TypeScript type definitions (errors, etc.) └── utils/ # Common utility functions (logger, error handler, security, etc.) ``` For a detailed file tree, run `npm run tree` or see [docs/tree.md](docs/tree.md). ## Vault Cache Service This server includes an intelligent **in-memory cache** designed to enhance performance and resilience when interacting with your vault. ### Purpose and Benefits - **Performance**: By caching file content and metadata, the server can perform search operations much faster, especially in large vaults. This reduces the number of direct requests to the Obsidian Local REST API, resulting in a snappier experience. - **Resilience**: The cache acts as a fallback for the `obsidian_global_search` tool. If the live API search fails or times out, the server seamlessly uses the cache to provide results, ensuring that search functionality remains available even if the Obsidian API is temporarily unresponsive. - **Efficiency**: The cache is designed to be efficient. It performs an initial build on startup and then periodically refreshes in the background by checking for file modifications, ensuring it stays reasonably up-to-date without constant, heavy API polling. ### How It Works 1. **Initialization**: When enabled, the `VaultCacheService` builds an in-memory map of all `.md` files in your vault, storing their content and modification times. 2. **Periodic Refresh**: The cache automatically refreshes at a configurable interval (defaulting to 10 minutes). During a refresh, it only fetches content for files that are new or have been modified since the last check. 3. **Proactive Updates**: After a file is modified through a tool like `obsidian_update_file`, the service proactively updates the cache for that specific file, ensuring immediate consistency. 4. **Search Fallback**: The `obsidian_global_search` tool first attempts a live API search. If this fails, it automatically falls back to searching the in-memory cache. ### Configuration The cache is enabled by default but can be configured via environment variables: - **`OBSIDIAN_ENABLE_CACHE`**: Set to `true` (default) or `false` to enable or disable the cache service. - **`OBSIDIAN_CACHE_REFRESH_INTERVAL_MIN`**: Defines the interval in minutes for the periodic background refresh. Defaults to `10`. ## Tools The Obsidian MCP Server provides a suite of tools for interacting with your vault, callable via the Model Context Protocol. | Tool Name | Description | Key Arguments | | :---------------------------- | :-------------------------------------------------------- | :------------------------------------------------------------ | | `obsidian_read_note` | Retrieves the content and metadata of a note. | `filePath`, `format?`, `includeStat?` | | `obsidian_update_note` | Modifies a file by appending, prepending, or overwriting. | `targetType`, `content`, `targetIdentifier?`, `wholeFileMode` | | `obsidian_search_replace` | Performs search-and-replace operations in a note. | `targetType`, `replacements`, `useRegex?`, `replaceAll?` | | `obsidian_global_search` | Searches the entire vault for content. | `query`, `searchInPath?`, `useRegex?`, `page?`, `pageSize?` | | `obsidian_list_notes` | Lists notes and subdirectories in a folder. | `dirPath`, `fileExtensionFilter?`, `nameRegexFilter?` | | `obsidian_manage_frontmatter` | Gets, sets, or deletes keys in a note's frontmatter. | `filePath`, `operation`, `key`, `value?` | | `obsidian_manage_tags` | Adds, removes, or lists tags in a note. | `filePath`, `operation`, `tags` | | `obsidian_delete_note` | Permanently deletes a note from the vault. | `filePath` | _Note: All tools support comprehensive error handling and return structured JSON responses._ ## Resources **MCP Resources are not implemented in this version.** This server currently focuses on providing interactive tools for vault manipulation. Future development may introduce resource capabilities (e.g., exposing notes or search results as readable resources). ## Development ### Build and Test To get started with development, clone the repository, install dependencies, and use the following scripts: ```bash # Install dependencies npm install # Build the project (compile TS to JS in dist/ and make executable) npm run rebuild # Start the server locally using stdio transport npm start:stdio # Start the server using http transport npm run start:http # Format code using Prettier npm run format # Inspect the server's capabilities using the MCP Inspector tool npm run inspect:stdio # or for the http transport: npm run inspect:http ``` ## License This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details. ---

Built with the Model Context Protocol

Obsidian Vault

by cyanheads

Cursor

Setting up with Cursor

커뮤니티 리뷰

문서

언어

카테고리

태그