Skip to main content

A Model Context Protocol server providing tools to interact with Obsidian vaults for LLMs

Project description

MCP Server Obsidian

A Model Context Protocol server that provides Obsidian vault search capabilities. This server enables LLMs to search and retrieve content from your Obsidian vault, making it easier to find and process your notes.

Available Tools

  • search - Searches your Obsidian vault for notes matching the query.
    • query (string, required): Search query to find relevant notes
    • Returns a list of matching notes with their content

Features

  • Search through your entire Obsidian vault
  • Secure access with path validation
  • Configurable search limits
  • Hidden files/directories are automatically ignored

Installation

Using uv (recommended)

When using uv no specific installation is needed. We will use uvx to directly run mcp-server-obsidian.

Using PIP

Alternatively you can install mcp-server-obsidian via pip:

pip install mcp-server-obsidian

After installation, you can run it as a script using:

python -m mcp_server_obsidian

Configuration

The server needs to be configured with your Obsidian vault directory. By default, it will look for notes in the user's home directory.

Security

The server includes several security features:

  • Path validation to prevent unauthorized access
  • Hidden files and directories are automatically ignored
  • Access is restricted to configured vault directories only

Development

To contribute to this project:

  1. Clone the repository
  2. Install dependencies
  3. Run the server using python -m mcp_server_obsidian

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_server_obsidian-0.1.3.tar.gz (41.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_server_obsidian-0.1.3-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file mcp_server_obsidian-0.1.3.tar.gz.

File metadata

  • Download URL: mcp_server_obsidian-0.1.3.tar.gz
  • Upload date:
  • Size: 41.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.5

File hashes

Hashes for mcp_server_obsidian-0.1.3.tar.gz
Algorithm Hash digest
SHA256 d8e5baa1546caa375536501b664493ec5aa02f040d7e760a599b630b839f29de
MD5 036f9793d1fa6efa261a7709099f97d1
BLAKE2b-256 9425ee828f042ad958847f5f2870152eb40249e2098c031fb2fe7af1c3953831

See more details on using hashes here.

File details

Details for the file mcp_server_obsidian-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_server_obsidian-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a032fa2154ac04ed73a5790b44f55010836fda832f3a64c86688fdae928d6407
MD5 55c6f1c4904870ebae9a264484e3fc4c
BLAKE2b-256 386e3b53a9e28ab689739d469175f25867db0bec41045a23ee76b21e09e79ad9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page