Skip to content
Back to search

mcp-obsidian

MCP server that interacts with Obsidian via the Obsidian rest API community plugin

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/markuspfundstein--mcp-obsidian/badge.svg)](/listings/markuspfundstein--mcp-obsidian)

HTML

<a href="/listings/markuspfundstein--mcp-obsidian"><img src="/api/listings/markuspfundstein--mcp-obsidian/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

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`

<details> <summary>Development/Unpublished Servers Configuration</summary>

{
  "mcpServers": {
    "mcp-obsidian": {
      "command": "uv",
      "args": [
        "--directory",
        "<dir_to>/mcp-obsidian",
        "run",
        "mcp-obsidian"
      ],
      "env": {
        "OBSIDIAN_API_KEY": "<your_api_key_here>",
        "OBSIDIAN_HOST": "<your_obsidian_host>",
        "OBSIDIAN_PORT": "<your_obsidian_port>"
      }
    }
  }
}

</details>

<details> <summary>Published Servers Configuration</summary>

{
  "mcpServers": {
    "mcp-obsidian": {
      "command": "uvx",
      "args": [
        "mcp-obsidian"
      ],
      "env": {
        "OBSIDIAN_API_KEY": "<YOUR_OBSIDIAN_API_KEY>",
        "OBSIDIAN_HOST": "<your_obsidian_host>",
        "OBSIDIAN_PORT": "<your_obsidian_port>"
      }
    }
  }
}

</details>

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 209 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # MCP server for Obsidian
  2. MCP server to interact with Obsidian via the Local REST API community plugin.
  3. <a href="https://glama.ai/mcp/servers/3wko1bhuek"><img width="380" height="200" src="https://glama.ai/mcp/servers/3wko1bhuek/badge" alt="server for Obsidian MCP server" /></a>
  4. ## Components
  5. ### Tools
  6. The server implements multiple tools to interact with Obsidian:
  7. - list_files_in_vault: Lists all files and directories in the root directory of your Obsidian vault
  8. - list_files_in_dir: Lists all files and directories in a specific Obsidian directory
  9. - get_file_contents: Return the content of a single file in your vault.
  10. - search: Search for documents matching a specified text query across all files in the vault
  11. - patch_content: Insert content into an existing note relative to a heading, block reference, or frontmatter field.
  12. - append_content: Append content to a new or existing file in the vault.
  13. - delete_file: Delete a file or directory from your vault.
  14. ### Example prompts
  15. Its good to first instruct Claude to use Obsidian. Then it will always call the tool.
  16. The use prompts like this:
  17. - Get the contents of the last architecture call note and summarize them
  18. - Search for all files where Azure CosmosDb is mentioned and quickly explain to me the context in which it is mentioned
  19. - 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.
  20. ## Requirements
  21. - Python >= 3.11
  22. - `mcp` Python SDK `>=1.1.0,<2.0.0` (pinned in `pyproject.toml`). `mcp-obsidian` currently registers its tool handlers via the `mcp` 1.x low-level `Server` API (`@app.list_tools()` / `@app.call_tool()`), which was removed in `mcp` 2.0. Installing with an unconstrained `mcp>=2.0` will crash at import with `AttributeError: 'Server' object has no attribute 'list_tools'`.
  23. ## Configuration
  24. ### Obsidian REST API Key
  25. There are two ways to configure the environment with the Obsidian REST API Key.
  26. 1. Add to server config (preferred)
  27. ```json
  28. {
  29. "mcp-obsidian": {
  30. "command": "uvx",
  31. "args": [
  32. "mcp-obsidian"
  33. ],
  34. "env": {
  35. "OBSIDIAN_API_KEY": "<your_api_key_here>",
  36. "OBSIDIAN_HOST": "<your_obsidian_host>",
  37. "OBSIDIAN_PORT": "<your_obsidian_port>"
  38. }
  39. }
  40. }
  41. ```
  42. Sometimes Claude has issues detecting the location of uv / uvx. You can use `which uvx` to find and paste the full path in above config in such cases.
  43. 2. Create a `.env` file in the working directory with the following required variables:
  44. ```
  45. OBSIDIAN_API_KEY=your_api_key_here
  46. OBSIDIAN_HOST=your_obsidian_host
  47. OBSIDIAN_PORT=your_obsidian_port
  48. ```
  49. Note:
  50. - You can find the API key in the Obsidian plugin config
  51. - Default port is 27124 if not specified
  52. - Default host is 127.0.0.1 if not specified
  53. ## Quickstart
  54. ### Install
  55. #### Obsidian REST API
  56. You need the Obsidian REST API community plugin running: https://github.com/coddingtonbear/obsidian-local-rest-api
  57. Install and enable it in the settings and copy the api key.
  58. #### Claude Desktop
  59. On MacOS: `~/Library/Application\ Support/Claude/claude_desktop_config.json`
  60. On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
  61. <details>
  62. <summary>Development/Unpublished Servers Configuration</summary>
  63. ```json
  64. {
  65. "mcpServers": {
  66. "mcp-obsidian": {
  67. "command": "uv",
  68. "args": [
  69. "--directory",
  70. "<dir_to>/mcp-obsidian",
  71. "run",
  72. "mcp-obsidian"
  73. ],
  74. "env": {
  75. "OBSIDIAN_API_KEY": "<your_api_key_here>",
  76. "OBSIDIAN_HOST": "<your_obsidian_host>",
  77. "OBSIDIAN_PORT": "<your_obsidian_port>"
  78. }
  79. }
  80. }
  81. }
  82. ```
  83. </details>
  84. <details>
  85. <summary>Published Servers Configuration</summary>
  86. ```json
  87. {
  88. "mcpServers": {
  89. "mcp-obsidian": {
  90. "command": "uvx",
  91. "args": [
  92. "mcp-obsidian"
  93. ],
  94. "env": {
  95. "OBSIDIAN_API_KEY": "<YOUR_OBSIDIAN_API_KEY>",
  96. "OBSIDIAN_HOST": "<your_obsidian_host>",
  97. "OBSIDIAN_PORT": "<your_obsidian_port>"
  98. }
  99. }
  100. }
  101. }
  102. ```
  103. </details>
  104. ## Docker
  105. You can run the server in a container instead of installing `uv`/Python locally.
  106. 1. Copy `.env.example` to `.env` and fill in your Obsidian REST API key:
  107. ```bash
  108. cp .env.example .env
  109. ```
  110. By default `OBSIDIAN_HOST` is set to `host.docker.internal`, which resolves to
  111. your host machine from inside the container (works on Linux, Mac and Windows).
  112. 2. Build the image:
  113. ```bash
  114. docker compose build
  115. ```
  116. 3. Point your MCP client at the container. Since MCP speaks JSON-RPC over
  117. stdio, the client must run it with stdin attached and no pseudo-TTY — use
  118. `docker compose run --rm -T`, not `docker compose up`:
  119. ```json
  120. {
  121. "mcpServers": {
  122. "mcp-obsidian": {
  123. "command": "docker",
  124. "args": [
  125. "compose",
  126. "-f",
  127. "<dir_to>/mcp-obsidian/docker-compose.yml",
  128. "run",
  129. "--rm",
  130. "-T",
  131. "mcp-obsidian"
  132. ]
  133. }
  134. }
  135. }
  136. ```
  137. You can also run it manually to sanity-check the container starts:
  138. ```bash
  139. docker compose run --rm -T mcp-obsidian
  140. ```
  141. (it will sit waiting for a JSON-RPC message on stdin; Ctrl+C to exit)
  142. ## Development
  143. ### Building
  144. To prepare the package for distribution:
  145. 1. Sync dependencies and update lockfile:
  146. ```bash
  147. uv sync
  148. ```
  149. ### Debugging
  150. Since MCP servers run over stdio, debugging can be challenging. For the best debugging
  151. experience, we strongly recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).
  152. You can launch the MCP Inspector via [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) with this command:
  153. ```bash
  154. npx @modelcontextprotocol/inspector uv --directory /path/to/mcp-obsidian run mcp-obsidian
  155. ```
  156. Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.
  157. You can also watch the server logs with this command:
  158. ```bash
  159. tail -n 20 -f ~/Library/Logs/Claude/mcp-server-mcp-obsidian.log
  160. ```

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.