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.1.tar.gz (42.0 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.1-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mcp_server_obsidian-0.1.1.tar.gz
Algorithm Hash digest
SHA256 144156e635f067eae007060e1b5fb916a8f47c4968709910e5f7202bab708296
MD5 cc689e37e4d34cc0c939a3772f5876a3
BLAKE2b-256 9291a279c28a0082ffb16b32f0aadcb6e02052c75a0ac97c33c7db2750bda075

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mcp_server_obsidian-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 80610bcdabef8f8774dee4c187da03c853aa20b92e1d167a0668c02e8142ec75
MD5 d8bc2e4271882c51cf9b0b2dbb939895
BLAKE2b-256 5c642019500038e64f909b879941a206c88fd507b30ada9fab018f953c9209fb

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