an build artifacts and then rebuild the project npm run rebuild # Fetch the Obsidian API spec (requires Obsidian running with Local REST API) npm run fetch:spec http://127.0.0.1:27123/ docs/obsidian-api/obsidian_rest_api_spec # Generate API documentation using TypeDoc npm run docs:generate # 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

28:T4c81,# 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.12.1-green.svg)](https://modelcontextprotocol.io/) [![Version](https://img.shields.io/badge/Version-2.0.3-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_file`](./src/mcp-server/tools/obsidianReadFileTool/) | Retrieves the content and metadata of a specified file. | - Read in `markdown` or `json` format.
- Case-insensitive path fallback.
- Includes file stats (creation/modification time). | | [`obsidian_update_file`](./src/mcp-server/tools/obsidianUpdateFileTool/) | 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.