| Name | mcp-server-obsidian JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | None |
| Summary | A Model Context Protocol server providing tools to interact with Obsidian vaults for LLMs |
| upload_time | 2024-12-01 15:38:35 |
| maintainer | None |
| docs_url | None |
| author | anpigon |
| requires_python | >=3.11 |
| license | MIT |
| keywords |
automation
llm
mcp
obsidian
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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`](https://docs.astral.sh/uv/) no specific installation is needed. We will
use [`uvx`](https://docs.astral.sh/uv/guides/tools/) 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "mcp-server-obsidian",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "automation, llm, mcp, obsidian",
"author": "anpigon",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/94/25/ee828f042ad958847f5f2870152eb40249e2098c031fb2fe7af1c3953831/mcp_server_obsidian-0.1.3.tar.gz",
"platform": null,
"description": "# MCP Server Obsidian\n\nA 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.\n\n### Available Tools\n\n- `search` - Searches your Obsidian vault for notes matching the query.\n - `query` (string, required): Search query to find relevant notes\n - Returns a list of matching notes with their content\n\n### Features\n\n- Search through your entire Obsidian vault\n- Secure access with path validation\n- Configurable search limits\n- Hidden files/directories are automatically ignored\n\n## Installation\n\n### Using uv (recommended)\n\nWhen using [`uv`](https://docs.astral.sh/uv/) no specific installation is needed. We will\nuse [`uvx`](https://docs.astral.sh/uv/guides/tools/) to directly run *mcp-server-obsidian*.\n\n### Using PIP\n\nAlternatively you can install `mcp-server-obsidian` via pip:\n\n```\npip install mcp-server-obsidian\n```\n\nAfter installation, you can run it as a script using:\n\n```\npython -m mcp_server_obsidian\n```\n\n## Configuration\n\nThe server needs to be configured with your Obsidian vault directory. By default, it will look for notes in the user's home directory.\n\n### Security\n\nThe server includes several security features:\n- Path validation to prevent unauthorized access\n- Hidden files and directories are automatically ignored\n- Access is restricted to configured vault directories only\n\n## Development\n\nTo contribute to this project:\n\n1. Clone the repository\n2. Install dependencies\n3. Run the server using `python -m mcp_server_obsidian`\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Model Context Protocol server providing tools to interact with Obsidian vaults for LLMs",
"version": "0.1.3",
"project_urls": null,
"split_keywords": [
"automation",
" llm",
" mcp",
" obsidian"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "386e3b53a9e28ab689739d469175f25867db0bec41045a23ee76b21e09e79ad9",
"md5": "55c6f1c4904870ebae9a264484e3fc4c",
"sha256": "a032fa2154ac04ed73a5790b44f55010836fda832f3a64c86688fdae928d6407"
},
"downloads": -1,
"filename": "mcp_server_obsidian-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "55c6f1c4904870ebae9a264484e3fc4c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 6588,
"upload_time": "2024-12-01T15:38:34",
"upload_time_iso_8601": "2024-12-01T15:38:34.063025Z",
"url": "https://files.pythonhosted.org/packages/38/6e/3b53a9e28ab689739d469175f25867db0bec41045a23ee76b21e09e79ad9/mcp_server_obsidian-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9425ee828f042ad958847f5f2870152eb40249e2098c031fb2fe7af1c3953831",
"md5": "036f9793d1fa6efa261a7709099f97d1",
"sha256": "d8e5baa1546caa375536501b664493ec5aa02f040d7e760a599b630b839f29de"
},
"downloads": -1,
"filename": "mcp_server_obsidian-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "036f9793d1fa6efa261a7709099f97d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 41756,
"upload_time": "2024-12-01T15:38:35",
"upload_time_iso_8601": "2024-12-01T15:38:35.716014Z",
"url": "https://files.pythonhosted.org/packages/94/25/ee828f042ad958847f5f2870152eb40249e2098c031fb2fe7af1c3953831/mcp_server_obsidian-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-01 15:38:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mcp-server-obsidian"
}
