Obsidian Mcp Server
by cyanheadscommunityv3.1.3
516
75
An MCP server for interacting with Obsidian vaults through the Obsidian Local REST API plugin. It can read, list, search, create, append, patch, replace, tag, and delete notes, and optionally execute Obsidian commands over STDIO or Streamable HTTP.
From the registry: MCP server for Obsidian vaults — read, write, search, and edit notes via the Local REST API plugin.
Install & configure
Prerequisites
- optionalInstall Node.js or BunInstall Node.js v22+ or Bun v1.3.11+ to run the server. The simplest portable path uses npx, so Node.js is sufficient.https://bun.sh/
- requiredInstall and enable the Obsidian Local REST API pluginIn Obsidian, install and enable the Obsidian Local REST API plugin for your vault. Generate an API key in Settings → Community Plugins → Local REST API.https://github.com/coddingtonbear/obsidian-local-rest-api/
- requiredEnable the plugin HTTP server or configure HTTPSThe server defaults to connecting to the plugin at http://127.0.0.1:27123. Enable the plugin's "Non-encrypted (HTTP) Server" setting to use that default, or set OBSIDIAN_BASE_URL to your HTTPS endpoint instead.
Install in your client
Paste into the AI you're chatting with — it will figure out the rest
Please install the `obsidian-mcp-server` MCP server into my current AI client (that's you).
Required prerequisites (do these first if not already done):
- **Install and enable the Obsidian Local REST API plugin** — In Obsidian, install and enable the Obsidian Local REST API plugin for your vault. Generate an API key in Settings → Community Plugins → Local REST API. (https://github.com/coddingtonbear/obsidian-local-rest-api/)
- **Enable the plugin HTTP server or configure HTTPS** — The server defaults to connecting to the plugin at http://127.0.0.1:27123. Enable the plugin's "Non-encrypted (HTTP) Server" setting to use that default, or set OBSIDIAN_BASE_URL to your HTTPS endpoint instead.
Optional prerequisites:
- Install Node.js or Bun — Install Node.js v22+ or Bun v1.3.11+ to run the server. The simplest portable path uses npx, so Node.js is sufficient. (https://bun.sh/)
Canonical MCP server config (stdio transport):
- command: `npx`
- args: ["-y","obsidian-mcp-server@latest"]
- required environment variables:
- `MCP_TRANSPORT_TYPE`: Transport mode for the MCP server. Use stdio for MCP client configuration. (example: `stdio`)
- `OBSIDIAN_API_KEY`: Bearer token for the Obsidian Local REST API plugin. (example: `<your-obsidian-local-rest-api-key>`)
- optional environment variables:
- `MCP_LOG_LEVEL`: Log level in RFC 5424 format. (example: `info`)
- `OBSIDIAN_BASE_URL`: Base URL of the Obsidian Local REST API plugin. Set this if you are not using the default local HTTP endpoint, such as when using the always-on HTTPS port. (example: `<your-obsidian-base-url>`)
- `OBSIDIAN_VERIFY_SSL`: Whether to verify the TLS certificate when connecting over HTTPS. Default is false because the plugin commonly uses a self-signed certificate. (example: `false`)
- `OBSIDIAN_REQUEST_TIMEOUT_MS`: Per-request timeout in milliseconds for calls to the Obsidian Local REST API. (example: `30000`)
- `OBSIDIAN_ENABLE_COMMANDS`: Opt-in flag to enable the Obsidian command-palette tools obsidian_list_commands and obsidian_execute_command. (example: `true`)
- `MCP_AUTH_MODE`: Authentication mode for the server. Supported values are none, jwt, or oauth. (example: `jwt`)
- `MCP_AUTH_SECRET_KEY`: Shared secret used to verify incoming JWTs. Required when MCP_AUTH_MODE=jwt. (example: `<your-jwt-secret>`)
- `OTEL_ENABLED`: Enable OpenTelemetry tracing. (example: `true`)
Note: The README also supports Streamable HTTP transport, but the simplest portable client config is stdio via npx. For HTTP mode, the server uses MCP_TRANSPORT_TYPE=http and defaults to host 127.0.0.1, port 3010, endpoint path /mcp. Additional HTTP-only env vars are MCP_HTTP_HOST, MCP_HTTP_PORT, and MCP_HTTP_ENDPOINT_PATH.
Add this MCP server to my current client's config in the correct format for you. If you need secrets or credentials I haven't provided, ASK me — do not invent values or leave raw placeholders. After adding it, tell me how to verify the server is connected.Note: The README also supports Streamable HTTP transport, but the simplest portable client config is stdio via npx. For HTTP mode, the server uses MCP_TRANSPORT_TYPE=http and defaults to host 127.0.0.1, port 3010, endpoint path /mcp. Additional HTTP-only env vars are MCP_HTTP_HOST, MCP_HTTP_PORT, and MCP_HTTP_ENDPOINT_PATH.
Tools (14)
obsidian_get_note
Read a note as raw content, full structured data, a document map, or a single section.
obsidian_list_notes
List notes and subdirectories in a vault path with recursive traversal and filtering.
obsidian_list_tags
List all tags in the vault with usage counts, including hierarchical parents.
obsidian_list_commands
List available Obsidian command-palette commands for execution.
obsidian_search_notes
Search notes by text, Dataview DQL, or JSONLogic.
obsidian_write_note
Create a note or replace a whole note or section in place.
obsidian_append_to_note
Append content to a note or to a specific section.
obsidian_patch_note
Append, prepend, or replace a heading, block reference, or frontmatter field.
obsidian_replace_in_note
Perform body-wide search and replace within a single note.
obsidian_manage_frontmatter
Get, set, or delete a single frontmatter key.
obsidian_manage_tags
Add, remove, or list tags while reconciling frontmatter and inline tag syntax.
obsidian_delete_note
Permanently delete a note.
Environment variables
OBSIDIAN_API_KEYrequiredAPI key for the Obsidian Local REST API plugin.OBSIDIAN_ENABLE_COMMANDSEnables command listing and command execution tools.Prerequisites
- • Node.js v22+
Packages
obsidian-mcp-server
npmv3.1.3transport: stdio
obsidian-mcp-server
npmv3.1.3transport: streamable-http
Details
- Language
- TypeScript
- License
- Apache-2.0
- Released
- May 4, 2026
- Last commit
- May 11, 2026
- Registry name
- io.github.cyanheads/obsidian-mcp-server