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.0.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.0-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mcp_server_obsidian-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 9660220c056c576e6d89afb7216ddc15a9a9c7d279db53da61f2dd9954b60a29
MD5 9609d342713be51bee2ed7871cd820e2
BLAKE2b-256 cb1e89df789fd5ed829b2118d8d29ba2184e8904afe48780fdfd5cabcc2e03ff

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mcp_server_obsidian-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4e578f4aa612bf47f7f35b30e4f3214757c336a5847302aa59075cfcb90e4eab
MD5 acfa00b4eaa040189f01718870aacdbc
BLAKE2b-256 4b3d61f16e9ea20f4eaffe2903e47aa6a09676c6678c3ffa217c27abe8bb659d

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