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.2.tar.gz (41.7 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.2-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mcp_server_obsidian-0.1.2.tar.gz
Algorithm Hash digest
SHA256 8d84d4acfd538ec95190a8294605abcfe880d4f8c12274ebb3ce95b26c2a85b6
MD5 dda0695e6f8e6087b2afb76ac380c478
BLAKE2b-256 f30a1af70c3750a8cc3086cbcb1847423ffe63e17c21728c2cadbfc2a7db9a6a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mcp_server_obsidian-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9750184a15c89172668e112a8789c32f76681bbc5be37aff24133e07b2125161
MD5 7dab2959b15dfe094d01b7d818695e94
BLAKE2b-256 66f68f14b1de171e47a7ef355613643b88d97963e3e0b486182ce691d9429461

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