This Obsidian MCP server, developed by cyanheads, enables AI models to interact with Obsidian vaults through a standardized interface. Built with TypeScript and leveraging the Model Context Protocol SDK, it provides tools for file operations, content search, and metadata management within Obsidian. The implementation features atomic operations, efficient query processing, and automatic timestamp handling. It's particularly useful for AI assistants and applications needing to manage knowledge bases in Obsidian, enabling use cases like note-taking, content organization, and information retrieval without dealing directly with Obsidian's API complexities.
List all files in the vault.
List all files in a specified directory. Parameters: dirpath (string) - Path relative to vault root.
Get the contents of a specified file. Parameters: filepath (string) - Path relative to vault root.
Perform a text search in a file with context. Parameters: query (string), contextLength (optional number) - Default is 10.
Execute an advanced search using JsonLogic. Parameters: query (JsonLogicQuery) - Define the search criteria.
Retrieve all tags in the vault or a specific directory. Parameters: path (optional string) - Limit to a specific directory.
Append content to a specified file. Parameters: filepath (string) - Path relative to vault root, content (string) - Content to append.
Update the content of a specified file. Parameters: filepath (string) - Path relative to vault root, content (string) - New content to replace existing.
Get the properties of a specified note. Parameters: filepath (string) - Path relative to vault root.
Update the properties of a specified note. Parameters: filepath (string) - Path relative to vault root, properties (object) - Properties to update.
No reviews yet. Be the first to review!
Sign in to join the conversation
Start the server with node to access it via any client or IDE.
node path/to/downloaded/file.mjs