# MCP Server Obsidian Omnisearch
A FastMCP-based server that provides Obsidian vault search functionality through a REST API interface.
## Overview
This project implements a search service that allows you to search through Obsidian vault notes programmatically. It uses FastMCP to expose the search functionality as a tool that can be integrated with other services.
## Features
- Search through Obsidian vault notes
- REST API integration
- Returns absolute paths to matching notes
- Easy integration with FastMCP tools
## Prerequisites
- Python 3.x
- Obsidian with Omnisearch plugin installed and running
- FastMCP library
- Active Obsidian vault
## Installation
1. Clone the repository:
```bash
git clone https://github.com/anpigon/mcp-server-obsidian-omnisearch.git
cd mcp-server-obsidian-omnisearch
```
2. Install dependencies:
```bash
uv install
```
## Configuration
The Obsidian vault path is now provided as a command line argument when running the server:
```bash
python server.py /path/to/your/obsidian/vault
```
## Usage
### Obsidian Omnisearch API
You need the Obsidian Omnisearch community plugin running: https://publish.obsidian.md/omnisearch/Inject+Omnisearch+results+into+your+search+engine
### Claude Desktop
On MacOS: `~/Library/Application\ Support/Claude/claude_desktop_config.json`
On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
<details>
<summary>Development/Unpublished Servers Configuration</summary>
```json
{
"mcpServers": {
"obsidian-omnisearch": {
"command": "uv",
"args": [
"--directory",
"<dir_to>/mcp-server-obsidian-omnisearch",
"run",
"mcp-server-obsidian-omnisearch",
"/path/to/your/obsidian/vault"
]
}
}
}
```
</details>
<details>
<summary>Published Servers Configuration</summary>
```json
{
"mcpServers": {
"obsidian-omnisearch": {
"command": "uvx",
"args": [
"mcp-server-obsidian-omnisearch",
"/path/to/your/obsidian/vault"
]
}
}
}
```
</details>
## API Reference
### Search Notes
- Function: `obsidian_notes_search(query: str)`
- Description: Searches Obsidian notes and returns absolute paths to matching notes
- Parameters:
- `query`: Search query string
- Returns: List of absolute paths to matching notes
## Development
### Building and Publishing
To prepare the package for distribution:
1. Sync dependencies and update lockfile:
```bash
uv sync
```
2. Build package distributions:
```bash
uv build
```
This will create source and wheel distributions in the `dist/` directory.
3. Publish to PyPI:
```bash
uv publish
```
Note: You'll need to set PyPI credentials via environment variables or command flags:
- Token: `--token` or `UV_PUBLISH_TOKEN`
- Or username/password: `--username`/`UV_PUBLISH_USERNAME` and `--password`/`UV_PUBLISH_PASSWORD`
### Debugging
Since MCP servers run over stdio, debugging can be challenging. For the best debugging
experience, we strongly recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).
You can launch the MCP Inspector via [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) with this command:
```bash
npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-server-obsidian-omnisearch run mcp-server-obsidian-omnisearch
```
Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.
You can also watch the server logs with this command:
```bash
tail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-server-obsidian-omnisearch.log
```
## Dependencies
- FastMCP
- requests
- urllib
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Raw data
{
"_id": null,
"home_page": null,
"name": "mcp-server-obsidian-omnisearch",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "anpigon <anpigon@kakao.com>",
"keywords": "automation, http, llm, mcp, obsidian, omnisearch, second-brain",
"author": "anpigon",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/18/ad/a4525183bdec87c3ab4226ab2f41354c68f96a6c77aa7055d5442fd25384/mcp_server_obsidian_omnisearch-0.1.0.tar.gz",
"platform": null,
"description": "# MCP Server Obsidian Omnisearch\n\nA FastMCP-based server that provides Obsidian vault search functionality through a REST API interface.\n\n## Overview\n\nThis project implements a search service that allows you to search through Obsidian vault notes programmatically. It uses FastMCP to expose the search functionality as a tool that can be integrated with other services.\n\n## Features\n\n- Search through Obsidian vault notes\n- REST API integration\n- Returns absolute paths to matching notes\n- Easy integration with FastMCP tools\n\n## Prerequisites\n\n- Python 3.x\n- Obsidian with Omnisearch plugin installed and running\n- FastMCP library\n- Active Obsidian vault\n\n## Installation\n\n1. Clone the repository:\n```bash\ngit clone https://github.com/anpigon/mcp-server-obsidian-omnisearch.git\ncd mcp-server-obsidian-omnisearch\n```\n\n2. Install dependencies:\n```bash\nuv install\n```\n\n## Configuration\n\nThe Obsidian vault path is now provided as a command line argument when running the server:\n\n```bash\npython server.py /path/to/your/obsidian/vault\n```\n\n## Usage\n\n### Obsidian Omnisearch API\n\nYou need the Obsidian Omnisearch community plugin running: https://publish.obsidian.md/omnisearch/Inject+Omnisearch+results+into+your+search+engine\n\n### Claude Desktop\n\nOn MacOS: `~/Library/Application\\ Support/Claude/claude_desktop_config.json`\n\nOn Windows: `%APPDATA%/Claude/claude_desktop_config.json`\n\n<details>\n <summary>Development/Unpublished Servers Configuration</summary>\n\n```json\n{\n \"mcpServers\": {\n \"obsidian-omnisearch\": {\n \"command\": \"uv\",\n \"args\": [\n \"--directory\",\n \"<dir_to>/mcp-server-obsidian-omnisearch\",\n \"run\",\n \"mcp-server-obsidian-omnisearch\",\n \"/path/to/your/obsidian/vault\"\n ]\n }\n }\n}\n```\n</details>\n\n<details>\n <summary>Published Servers Configuration</summary>\n\n```json\n{\n \"mcpServers\": {\n \"obsidian-omnisearch\": {\n \"command\": \"uvx\",\n \"args\": [\n \"mcp-server-obsidian-omnisearch\",\n \"/path/to/your/obsidian/vault\"\n ]\n }\n }\n}\n```\n</details>\n\n## API Reference\n\n### Search Notes\n- Function: `obsidian_notes_search(query: str)`\n- Description: Searches Obsidian notes and returns absolute paths to matching notes\n- Parameters:\n - `query`: Search query string\n- Returns: List of absolute paths to matching notes\n\n## Development\n\n### Building and Publishing\n\nTo prepare the package for distribution:\n\n1. Sync dependencies and update lockfile:\n```bash\nuv sync\n```\n\n2. Build package distributions:\n```bash\nuv build\n```\n\nThis will create source and wheel distributions in the `dist/` directory.\n\n3. Publish to PyPI:\n```bash\nuv publish\n```\n\nNote: You'll need to set PyPI credentials via environment variables or command flags:\n- Token: `--token` or `UV_PUBLISH_TOKEN`\n- Or username/password: `--username`/`UV_PUBLISH_USERNAME` and `--password`/`UV_PUBLISH_PASSWORD`\n\n### Debugging\n\nSince MCP servers run over stdio, debugging can be challenging. For the best debugging\nexperience, we strongly recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).\n\nYou can launch the MCP Inspector via [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) with this command:\n\n```bash\nnpx @modelcontextprotocol/inspector uv --directory /path/to/mcp-server-obsidian-omnisearch run mcp-server-obsidian-omnisearch\n```\n\nUpon launching, the Inspector will display a URL that you can access in your browser to begin debugging.\n\nYou can also watch the server logs with this command:\n\n```bash\ntail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-server-obsidian-omnisearch.log\n```\n\n## Dependencies\n\n- FastMCP\n- requests\n- urllib\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Add your description here",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [
"automation",
" http",
" llm",
" mcp",
" obsidian",
" omnisearch",
" second-brain"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5a521b5ca56a8a049fabc64e133582bfa89fd0e2d31fa5bb0276407d89ec12b8",
"md5": "79b39a1ea0af5745df82592be0377880",
"sha256": "9bc22afd9159c5be81b88bf882133797fc40392efd8daee876b2d71430c5b129"
},
"downloads": -1,
"filename": "mcp_server_obsidian_omnisearch-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "79b39a1ea0af5745df82592be0377880",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 5208,
"upload_time": "2024-12-02T13:41:39",
"upload_time_iso_8601": "2024-12-02T13:41:39.606457Z",
"url": "https://files.pythonhosted.org/packages/5a/52/1b5ca56a8a049fabc64e133582bfa89fd0e2d31fa5bb0276407d89ec12b8/mcp_server_obsidian_omnisearch-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "18ada4525183bdec87c3ab4226ab2f41354c68f96a6c77aa7055d5442fd25384",
"md5": "3c3f70afaee01ee197dbdf91639b6110",
"sha256": "15fa4db22ff3551cd9987fee2b37820d83d2733b4f1a87b39edf88a0f14b17b8"
},
"downloads": -1,
"filename": "mcp_server_obsidian_omnisearch-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "3c3f70afaee01ee197dbdf91639b6110",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 55511,
"upload_time": "2024-12-02T13:41:40",
"upload_time_iso_8601": "2024-12-02T13:41:40.978287Z",
"url": "https://files.pythonhosted.org/packages/18/ad/a4525183bdec87c3ab4226ab2f41354c68f96a6c77aa7055d5442fd25384/mcp_server_obsidian_omnisearch-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-02 13:41:40",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mcp-server-obsidian-omnisearch"
}
JSON