obsidian-mcp-server
Version:
MCP server for Obsidian vaults — read, write, search, and surgically edit notes, tags, and frontmatter via the Local REST API plugin. STDIO or Streamable HTTP.
206 lines (205 loc) • 8.13 kB
JSON
{
"$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
"name": "io.github.cyanheads/obsidian-mcp-server",
"description": "MCP server for Obsidian — read, write, search, and surgically edit notes, tags, and frontmatter.",
"repository": {
"url": "https://github.com/cyanheads/obsidian-mcp-server",
"source": "github"
},
"version": "3.2.4",
"packages": [
{
"registryType": "npm",
"registryBaseUrl": "https://registry.npmjs.org",
"identifier": "obsidian-mcp-server",
"runtimeHint": "node",
"version": "3.2.4",
"packageArguments": [
{
"type": "positional",
"value": "run"
},
{
"type": "positional",
"value": "start:stdio"
}
],
"environmentVariables": [
{
"name": "OBSIDIAN_API_KEY",
"description": "Bearer token for the Obsidian Local REST API plugin (Settings → Community Plugins → Local REST API).",
"format": "string",
"isRequired": true
},
{
"name": "OBSIDIAN_BASE_URL",
"description": "Base URL of the Obsidian Local REST API. Default: http://127.0.0.1:27123 (enable \"Non-encrypted (HTTP) Server\" in plugin settings). Use https://127.0.0.1:27124 for the always-on HTTPS port (self-signed cert; pair with OBSIDIAN_VERIFY_SSL=false).",
"format": "string",
"isRequired": false,
"default": "http://127.0.0.1:27123"
},
{
"name": "OBSIDIAN_VERIFY_SSL",
"description": "Whether to verify the TLS certificate on the Obsidian endpoint. Default false because the plugin uses a self-signed cert.",
"format": "string",
"isRequired": false,
"default": "false"
},
{
"name": "OBSIDIAN_REQUEST_TIMEOUT_MS",
"description": "Per-request timeout in milliseconds.",
"format": "string",
"isRequired": false,
"default": "30000"
},
{
"name": "OBSIDIAN_ENABLE_COMMANDS",
"description": "Opt-in flag for the command-palette pair (obsidian_list_commands + obsidian_execute_command). Off by default — Obsidian commands are opaque and can be destructive.",
"format": "string",
"isRequired": false,
"default": "false"
},
{
"name": "OBSIDIAN_READ_PATHS",
"description": "Optional comma-separated vault-relative folder allowlist for reads. Prefix-based with implicit recursion; case-insensitive; trailing slashes normalized. Unset = full vault. Write paths are implicitly readable. Example: 'public/,projects/'.",
"format": "string",
"isRequired": false
},
{
"name": "OBSIDIAN_WRITE_PATHS",
"description": "Optional comma-separated vault-relative folder allowlist for writes. Same syntax as OBSIDIAN_READ_PATHS. Unset = full vault. Example: 'projects/,scratch/'.",
"format": "string",
"isRequired": false
},
{
"name": "OBSIDIAN_READ_ONLY",
"description": "Global read-only kill switch. When true, every write is denied regardless of OBSIDIAN_WRITE_PATHS, and the command-palette pair is suppressed (commands can mutate). Useful for shared or public-facing deployments.",
"format": "string",
"isRequired": false,
"default": "false"
},
{
"name": "MCP_LOG_LEVEL",
"description": "Sets the minimum log level for output (e.g., 'debug', 'info', 'warn').",
"format": "string",
"isRequired": false,
"default": "info"
}
],
"transport": {
"type": "stdio"
}
},
{
"registryType": "npm",
"registryBaseUrl": "https://registry.npmjs.org",
"identifier": "obsidian-mcp-server",
"runtimeHint": "node",
"version": "3.2.4",
"packageArguments": [
{
"type": "positional",
"value": "run"
},
{
"type": "positional",
"value": "start:http"
}
],
"environmentVariables": [
{
"name": "OBSIDIAN_API_KEY",
"description": "Bearer token for the Obsidian Local REST API plugin (Settings → Community Plugins → Local REST API).",
"format": "string",
"isRequired": true
},
{
"name": "OBSIDIAN_BASE_URL",
"description": "Base URL of the Obsidian Local REST API. Default: http://127.0.0.1:27123 (enable \"Non-encrypted (HTTP) Server\" in plugin settings). Use https://127.0.0.1:27124 for the always-on HTTPS port (self-signed cert; pair with OBSIDIAN_VERIFY_SSL=false).",
"format": "string",
"isRequired": false,
"default": "http://127.0.0.1:27123"
},
{
"name": "OBSIDIAN_VERIFY_SSL",
"description": "Whether to verify the TLS certificate on the Obsidian endpoint. Default false because the plugin uses a self-signed cert.",
"format": "string",
"isRequired": false,
"default": "false"
},
{
"name": "OBSIDIAN_REQUEST_TIMEOUT_MS",
"description": "Per-request timeout in milliseconds.",
"format": "string",
"isRequired": false,
"default": "30000"
},
{
"name": "OBSIDIAN_ENABLE_COMMANDS",
"description": "Opt-in flag for the command-palette pair (obsidian_list_commands + obsidian_execute_command). Off by default — Obsidian commands are opaque and can be destructive.",
"format": "string",
"isRequired": false,
"default": "false"
},
{
"name": "OBSIDIAN_READ_PATHS",
"description": "Optional comma-separated vault-relative folder allowlist for reads. Prefix-based with implicit recursion; case-insensitive; trailing slashes normalized. Unset = full vault. Write paths are implicitly readable. Example: 'public/,projects/'.",
"format": "string",
"isRequired": false
},
{
"name": "OBSIDIAN_WRITE_PATHS",
"description": "Optional comma-separated vault-relative folder allowlist for writes. Same syntax as OBSIDIAN_READ_PATHS. Unset = full vault. Example: 'projects/,scratch/'.",
"format": "string",
"isRequired": false
},
{
"name": "OBSIDIAN_READ_ONLY",
"description": "Global read-only kill switch. When true, every write is denied regardless of OBSIDIAN_WRITE_PATHS, and the command-palette pair is suppressed (commands can mutate). Useful for shared or public-facing deployments.",
"format": "string",
"isRequired": false,
"default": "false"
},
{
"name": "MCP_HTTP_HOST",
"description": "The hostname for the HTTP server.",
"format": "string",
"isRequired": false,
"default": "127.0.0.1"
},
{
"name": "MCP_HTTP_PORT",
"description": "The port to run the HTTP server on.",
"format": "string",
"isRequired": false,
"default": "3010"
},
{
"name": "MCP_HTTP_ENDPOINT_PATH",
"description": "The endpoint path for the MCP server.",
"format": "string",
"isRequired": false,
"default": "/mcp"
},
{
"name": "MCP_AUTH_MODE",
"description": "Authentication mode to use: 'none', 'jwt', or 'oauth'.",
"format": "string",
"isRequired": false,
"default": "none"
},
{
"name": "MCP_LOG_LEVEL",
"description": "Sets the minimum log level for output (e.g., 'debug', 'info', 'warn').",
"format": "string",
"isRequired": false,
"default": "info"
}
],
"transport": {
"type": "streamable-http",
"url": "http://localhost:3010/mcp"
}
}
]
}