obsidian-mcp-server
mcpkey · packageio.github.cyanheads/obsidian-mcp-server · v3.7.0
Read, write, search, and surgically edit Obsidian notes, tags, and frontmatter via MCP.
run it
on your own machines, one way per deploy methodgenerated from the record, not tested yet
#!/usr/bin/env bash # obsidian (io.github.cyanheads/obsidian-mcp-server), recipe baremetal (generated). # Generated by Hub for toolset "my-agent"; started by mcp-my-agent-obsidian.service. set -euo pipefail export HOST=127.0.0.1 PORT=8101 exec npx -y supergateway@4 --stdio 'npx -y [email protected]' --outputTransport streamableHttp --stateful --host 127.0.0.1 --port 8101 --streamableHttpPath /mcp --healthEndpoint /healthz [Unit] Description=MCP server obsidian (toolset my-agent), generated by Hub After=network-online.target Wants=network-online.target [Service] Type=simple User=mcp Group=mcp EnvironmentFile=/etc/mcp/my-agent.env Environment=HOME=/var/lib/mcp/obsidian WorkingDirectory=/var/lib/mcp/obsidian ExecStart=/opt/mcp/my-agent/bin/obsidian.sh Restart=on-failure RestartSec=5 NoNewPrivileges=true ProtectSystem=strict ProtectHome=true PrivateTmp=true ReadWritePaths=/var/lib/mcp/obsidian [Install] WantedBy=multi-user.target
generated from the record, not tested yet
docker run --rm -p 127.0.0.1:8101:8000 -e OBSIDIAN_API_KEY -e OBSIDIAN_BASE_URL -e OBSIDIAN_VERIFY_SSL -e OBSIDIAN_REQUEST_TIMEOUT_MS -e OBSIDIAN_ENABLE_COMMANDS -e OBSIDIAN_READ_PATHS -e OBSIDIAN_WRITE_PATHS -e OBSIDIAN_READ_ONLY -e OBSIDIAN_DELETE_ELICITATION -e OBSIDIAN_OMNISEARCH_URL -e MCP_LOG_LEVEL node:22-alpine sh -c 'npx -y supergateway@4 --stdio '"'"'npx -y [email protected]'"'"' --outputTransport streamableHttp --stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz'
generated from the record, not tested yet
# Generated by Hub for toolset "my-agent" (2026-10-18T07:38:47+00:00).
# Each package server runs behind a stdio->HTTP bridge and listens on localhost only.
# cp .env.example .env # fill the ${VAR}s
# docker compose up -d && bash smoke.sh
# Remote servers are not here: clients reach them directly (see clients/).
name: mcp-my-agent
services:
obsidian:
image: node:22-alpine
command:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y [email protected]' --outputTransport streamableHttp
--stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz
ports:
- 127.0.0.1:8101:8000
volumes:
- npm-cache:/root/.npm
healthcheck:
test:
- CMD-SHELL
- wget -qO- http://127.0.0.1:8000/healthz || exit 1
interval: 30s
timeout: 5s
retries: 5
start_period: 2m
restart: unless-stopped
environment:
OBSIDIAN_API_KEY: ${OBSIDIAN_API_KEY}
OBSIDIAN_BASE_URL: ${OBSIDIAN_BASE_URL}
OBSIDIAN_VERIFY_SSL: ${OBSIDIAN_VERIFY_SSL}
OBSIDIAN_REQUEST_TIMEOUT_MS: ${OBSIDIAN_REQUEST_TIMEOUT_MS}
OBSIDIAN_ENABLE_COMMANDS: ${OBSIDIAN_ENABLE_COMMANDS}
OBSIDIAN_READ_PATHS: ${OBSIDIAN_READ_PATHS}
OBSIDIAN_WRITE_PATHS: ${OBSIDIAN_WRITE_PATHS}
OBSIDIAN_READ_ONLY: ${OBSIDIAN_READ_ONLY}
OBSIDIAN_DELETE_ELICITATION: ${OBSIDIAN_DELETE_ELICITATION}
OBSIDIAN_OMNISEARCH_URL: ${OBSIDIAN_OMNISEARCH_URL}
MCP_LOG_LEVEL: ${MCP_LOG_LEVEL}
volumes:
npm-cache: {}
uv-cache: {}
generated from the record, not tested yet
# Generated by Hub for toolset "my-agent" (2026-10-18T07:38:47+00:00).
# kubectl create namespace mcp
# kubectl -n mcp create secret generic mcp-credentials --from-env-file=.env
# kubectl apply -f kubernetes.yaml
# Services are cluster-internal: <name>.mcp.svc.cluster.local:8000/mcp. Put an ingress
# with auth in front before exposing any of them.
apiVersion: v1
kind: Namespace
metadata:
name: mcp
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: obsidian
namespace: mcp
labels: &id001
app: obsidian
spec:
replicas: 1
selector:
matchLabels: *id001
template:
metadata:
labels: *id001
spec:
containers:
- name: obsidian
image: node:22-alpine
ports:
- containerPort: 8000
name: http
env:
- name: OBSIDIAN_API_KEY
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_API_KEY
- name: OBSIDIAN_BASE_URL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_BASE_URL
- name: OBSIDIAN_VERIFY_SSL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_VERIFY_SSL
- name: OBSIDIAN_REQUEST_TIMEOUT_MS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_REQUEST_TIMEOUT_MS
- name: OBSIDIAN_ENABLE_COMMANDS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_ENABLE_COMMANDS
- name: OBSIDIAN_READ_PATHS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_READ_PATHS
- name: OBSIDIAN_WRITE_PATHS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_WRITE_PATHS
- name: OBSIDIAN_READ_ONLY
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_READ_ONLY
- name: OBSIDIAN_DELETE_ELICITATION
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_DELETE_ELICITATION
- name: OBSIDIAN_OMNISEARCH_URL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_OMNISEARCH_URL
- name: MCP_LOG_LEVEL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: MCP_LOG_LEVEL
command:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y [email protected]' --outputTransport streamableHttp
--stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz
readinessProbe:
httpGet:
path: /healthz
port: http
initialDelaySeconds: 10
---
apiVersion: v1
kind: Service
metadata:
name: obsidian
namespace: mcp
spec:
selector:
app: obsidian
ports:
- port: 8000
targetPort: http
name: http
generated from the record, not tested yet
# Generated by Hub for toolset "my-agent" (2026-10-18T07:38:47+00:00).
# Credentials come from the Secret 'mcp-credentials' (kubectl create secret generic ... --from-env-file=.env).
# Each server under `servers` is one Deployment + Service; the keys after it configure
# upstream charts a worker verified.
servers:
obsidian:
enabled: true
replicas: 1
port: 8000
path: /mcp
container:
name: obsidian
image: node:22-alpine
ports:
- containerPort: 8000
name: http
env:
- name: OBSIDIAN_API_KEY
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_API_KEY
- name: OBSIDIAN_BASE_URL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_BASE_URL
- name: OBSIDIAN_VERIFY_SSL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_VERIFY_SSL
- name: OBSIDIAN_REQUEST_TIMEOUT_MS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_REQUEST_TIMEOUT_MS
- name: OBSIDIAN_ENABLE_COMMANDS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_ENABLE_COMMANDS
- name: OBSIDIAN_READ_PATHS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_READ_PATHS
- name: OBSIDIAN_WRITE_PATHS
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_WRITE_PATHS
- name: OBSIDIAN_READ_ONLY
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_READ_ONLY
- name: OBSIDIAN_DELETE_ELICITATION
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_DELETE_ELICITATION
- name: OBSIDIAN_OMNISEARCH_URL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: OBSIDIAN_OMNISEARCH_URL
- name: MCP_LOG_LEVEL
valueFrom:
secretKeyRef:
name: mcp-credentials
key: MCP_LOG_LEVEL
command:
- sh
- -c
- npx -y supergateway@4 --stdio 'npx -y [email protected]' --outputTransport streamableHttp
--stateful --host 0.0.0.0 --port 8000 --streamableHttpPath /mcp --healthEndpoint /healthz
readinessProbe:
httpGet:
path: /healthz
port: http
initialDelaySeconds: 10
# helm install my-agent helm/my-agent -n mcp
in the cloud
one click: the provider's deploy form opens filled in, in your own account- koyeb
-
The form opens with CHANGE_ME for each value you supply: OBSIDIAN_API_KEY, OBSIDIAN_BASE_URL, OBSIDIAN_VERIFY_SSL, OBSIDIAN_REQUEST_TIMEOUT_MS, OBSIDIAN_ENABLE_COMMANDS, OBSIDIAN_READ_PATHS, OBSIDIAN_WRITE_PATHS, OBSIDIAN_READ_ONLY, OBSIDIAN_DELETE_ELICITATION, OBSIDIAN_OMNISEARCH_URL, MCP_LOG_LEVEL. Fill them in before you deploy.
Clients connect to the service's https://…koyeb.app address plus /mcp.
- azure
-
A Container Apps environment with one app per server, each with HTTPS ingress and one replica. The portal asks for each value you supply as a secure parameter; the deployment's outputs list the endpoints.
connect to it
copy what your client needsnpx -y [email protected] # env: OBSIDIAN_API_KEY, OBSIDIAN_BASE_URL, OBSIDIAN_VERIFY_SSL, OBSIDIAN_REQUEST_TIMEOUT_MS, OBSIDIAN_ENABLE_COMMANDS, OBSIDIAN_READ_PATHS, OBSIDIAN_WRITE_PATHS, OBSIDIAN_READ_ONLY, OBSIDIAN_DELETE_ELICITATION, OBSIDIAN_OMNISEARCH_URL, MCP_LOG_LEVEL
{
"mcpServers": {
"obsidian": {
"command": "npx",
"args": [
"-y",
"[email protected]"
],
"env": {
"OBSIDIAN_API_KEY": "${OBSIDIAN_API_KEY}",
"OBSIDIAN_BASE_URL": "${OBSIDIAN_BASE_URL}",
"OBSIDIAN_VERIFY_SSL": "${OBSIDIAN_VERIFY_SSL}",
"OBSIDIAN_REQUEST_TIMEOUT_MS": "${OBSIDIAN_REQUEST_TIMEOUT_MS}",
"OBSIDIAN_ENABLE_COMMANDS": "${OBSIDIAN_ENABLE_COMMANDS}",
"OBSIDIAN_READ_PATHS": "${OBSIDIAN_READ_PATHS}",
"OBSIDIAN_WRITE_PATHS": "${OBSIDIAN_WRITE_PATHS}",
"OBSIDIAN_READ_ONLY": "${OBSIDIAN_READ_ONLY}",
"OBSIDIAN_DELETE_ELICITATION": "${OBSIDIAN_DELETE_ELICITATION}",
"OBSIDIAN_OMNISEARCH_URL": "${OBSIDIAN_OMNISEARCH_URL}",
"MCP_LOG_LEVEL": "${MCP_LOG_LEVEL}"
}
}
}
}
#!/usr/bin/env bash
# Registers every server with Claude Code (run once; `claude mcp list` to check).
set -euo pipefail
set -a; [ -f .env ] && source .env; set +a
claude mcp add obsidian -e "OBSIDIAN_API_KEY=${OBSIDIAN_API_KEY}" -e "OBSIDIAN_BASE_URL=${OBSIDIAN_BASE_URL}" -e "OBSIDIAN_VERIFY_SSL=${OBSIDIAN_VERIFY_SSL}" -e "OBSIDIAN_REQUEST_TIMEOUT_MS=${OBSIDIAN_REQUEST_TIMEOUT_MS}" -e "OBSIDIAN_ENABLE_COMMANDS=${OBSIDIAN_ENABLE_COMMANDS}" -e "OBSIDIAN_READ_PATHS=${OBSIDIAN_READ_PATHS}" -e "OBSIDIAN_WRITE_PATHS=${OBSIDIAN_WRITE_PATHS}" -e "OBSIDIAN_READ_ONLY=${OBSIDIAN_READ_ONLY}" -e "OBSIDIAN_DELETE_ELICITATION=${OBSIDIAN_DELETE_ELICITATION}" -e "OBSIDIAN_OMNISEARCH_URL=${OBSIDIAN_OMNISEARCH_URL}" -e "MCP_LOG_LEVEL=${MCP_LOG_LEVEL}" -- npx -y [email protected]
{
"mcpServers": {
"obsidian": {
"command": "npx",
"args": [
"-y",
"[email protected]"
],
"env": {
"OBSIDIAN_API_KEY": "${OBSIDIAN_API_KEY}",
"OBSIDIAN_BASE_URL": "${OBSIDIAN_BASE_URL}",
"OBSIDIAN_VERIFY_SSL": "${OBSIDIAN_VERIFY_SSL}",
"OBSIDIAN_REQUEST_TIMEOUT_MS": "${OBSIDIAN_REQUEST_TIMEOUT_MS}",
"OBSIDIAN_ENABLE_COMMANDS": "${OBSIDIAN_ENABLE_COMMANDS}",
"OBSIDIAN_READ_PATHS": "${OBSIDIAN_READ_PATHS}",
"OBSIDIAN_WRITE_PATHS": "${OBSIDIAN_WRITE_PATHS}",
"OBSIDIAN_READ_ONLY": "${OBSIDIAN_READ_ONLY}",
"OBSIDIAN_DELETE_ELICITATION": "${OBSIDIAN_DELETE_ELICITATION}",
"OBSIDIAN_OMNISEARCH_URL": "${OBSIDIAN_OMNISEARCH_URL}",
"MCP_LOG_LEVEL": "${MCP_LOG_LEVEL}"
}
}
}
}
{
"servers": {
"obsidian": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"[email protected]"
],
"env": {
"OBSIDIAN_API_KEY": "${OBSIDIAN_API_KEY}",
"OBSIDIAN_BASE_URL": "${OBSIDIAN_BASE_URL}",
"OBSIDIAN_VERIFY_SSL": "${OBSIDIAN_VERIFY_SSL}",
"OBSIDIAN_REQUEST_TIMEOUT_MS": "${OBSIDIAN_REQUEST_TIMEOUT_MS}",
"OBSIDIAN_ENABLE_COMMANDS": "${OBSIDIAN_ENABLE_COMMANDS}",
"OBSIDIAN_READ_PATHS": "${OBSIDIAN_READ_PATHS}",
"OBSIDIAN_WRITE_PATHS": "${OBSIDIAN_WRITE_PATHS}",
"OBSIDIAN_READ_ONLY": "${OBSIDIAN_READ_ONLY}",
"OBSIDIAN_DELETE_ELICITATION": "${OBSIDIAN_DELETE_ELICITATION}",
"OBSIDIAN_OMNISEARCH_URL": "${OBSIDIAN_OMNISEARCH_URL}",
"MCP_LOG_LEVEL": "${MCP_LOG_LEVEL}"
}
}
}
}
name: my-agent target: local servers: - hub: io.github.cyanheads/obsidian-mcp-server
- not probed yet: tools unpinned, ingest lists them
tools
Not probed yetThe tools appear once the hub or its worker has listed this entry. Running it still works: your client lists them on first start.