Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MarkusPfundstein/mcp-obsidian
MCP server that interacts with Obsidian via the Obsidian rest API community plugin
https://github.com/MarkusPfundstein/mcp-obsidian
Last synced: 22 days ago
JSON representation
MCP server that interacts with Obsidian via the Obsidian rest API community plugin
- Host: GitHub
- URL: https://github.com/MarkusPfundstein/mcp-obsidian
- Owner: MarkusPfundstein
- Created: 2024-11-29T11:07:12.000Z (23 days ago)
- Default Branch: main
- Last Pushed: 2024-11-29T13:31:09.000Z (23 days ago)
- Last Synced: 2024-11-29T13:32:36.658Z (23 days ago)
- Language: Python
- Size: 28.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-mcp-servers - Obsidian - Obsidian vault integration with tools for file management, search, and content manipulation (📝 <a name="note-taking"></a>Note Taking)
- awesome-mcp - Obsidian - Interact with Obsidian. (Servers / Python)
- awesome-mcp-servers - Obsidian - Interacting with Obsidian via REST API (Community Servers)
- awesome-mcp-servers - Obsidian - Interacting with Obsidian via REST API (Community Servers)
README
# mcp-knowledge-base MCP server
Example MCP server to interact with Obsidian.
## Components
### Tools
The server implements multiple tools to interact with Obsidian:
- list_files_in_vault: Lists all files and directories in the root directory of your Obsidian vault
- list_files_in_dir: Lists all files and directories in a specific Obsidian directory
- get_file_contents: Return the content of a single file in your vault.
- search: Search for documents matching a specified text query across all files in the vault
- patch_content: Insert content into an existing note relative to a heading, block reference, or frontmatter field.
- append_content: Append content to a new or existing file in the vault.
### Example prompts
Its good to first instruct Claude to use Obsidian. Then it will always call the tool.
The use prompts like this:
- Get the contents of the last architecture call note and summarize them
- Search for all files where Azure CosmosDb is mentioned and quickly explain to me the context in which it is mentioned
- Summarize the last meeting notes and put them into a new note 'summary meeting.md'. Add an introduction so that I can send it via email.
## Configuration
### Environment Variables
Create a `.env` file in the root directory with the following required variable:
```
OBSIDIAN_API_KEY=your_api_key_here
```
Without this API key, the server will not be able to function.
## Quickstart
### Install
#### Obsidian REST API
You need the Obsidian REST API community plugin running: https://github.com/coddingtonbear/obsidian-local-rest-api
Install and enable it in the settings and copy the api key.
#### Claude Desktop
On MacOS: `~/Library/Application\ Support/Claude/claude_desktop_config.json`
On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
Development/Unpublished Servers Configuration
```json
{
"mcpServers": {
"mcp-knowledge-base": {
"command": "uv",
"args": [
"--directory",
"/mcp-knowledge-base",
"run",
"mcp-knowledge-base"
]
}
}
}
```
Published Servers Configuration
```json
{
"mcpServers": {
"mcp-knowledge-base": {
"command": "uvx",
"args": [
"mcp-knowledge-base"
]
}
}
}
```
## 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-knowledge-base run mcp-knowledge-base
```
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-knowledge-base.log
```