obsidian MCP配置与使用教程
io.github.cyanheads/obsidian-mcp-server · v3.6.0
通过 MCP 读取、写入、检索并精准编辑 Obsidian 笔记、标签与 frontmatter。
原文描述:Read, write, search, and surgically edit Obsidian notes, tags, and frontmatter via MCP.
建议先在本页复制安装配置,再到上游核对文档与权限。
产品介绍
通过 MCP 读取、写入、检索并精准编辑 Obsidian 笔记、标签与 frontmatter。 obsidian-mcp-server 是一个MCP Server,收录自 官方 MCP Registry。支持 stdio、streamable-http 传输。本页提供产品介绍、配置教程、安装命令与适用场景,支持 Trae、通义灵码、Cursor、Claude Code、VS Code 等。
适用场景
AgentHub Verified 可用性验证技术测试通过
自动化测试流水线已校验安装命令、传输协议与客户端兼容性
按平台快速复制
选择你的平台查看安装方式
- 打开项目根目录下的 .cursor/mcp.json(没有就新建)
- 点击「复制配置」粘贴进去;若已有其他 MCP,只合并 mcpServers 里的本条目
- 将 env 中的 <占位符> 替换为真实密钥(见下方「环境变量」)
- 保存后按 Cmd+Shift+P(Windows:Ctrl+Shift+P)→ 输入 Reload Window 并执行
预填环境变量与密钥(可选)
{
"mcpServers": {
"obsidian-mcp-server": {
"command": "node",
"args": [
"-y",
"obsidian-mcp-server"
],
"env": {
"OBSIDIAN_API_KEY": "<OBSIDIAN_API_KEY>"
}
}
}
}配置教程
- 打开 obsidian-mcp-server 详情页,确认这是你需要的 MCP Server(来源 官方 MCP Registry)。
- 按客户端选择 Trae、通义灵码、Cursor、Claude Code 或 VS Code,复制 JSON 配置或 CLI 命令。
- 将配置合并进 mcpServers,并把环境变量占位符替换为真实密钥。
- 重载窗口后,在 Agent 对话中调用该 MCP 提供的工具。
安装命令
以下安装命令与配置步骤已写入页面 HTML,搜索引擎与未启用 JavaScript 的浏览器均可直接读取。
Claude Code(本地)
- 确保已安装 Claude Code CLI
- 复制下方命令,将 <占位符> 替换为真实环境变量值后,在终端执行
- 若下方列出了环境变量,请对照填写
claude mcp add obsidian-mcp-server --env OBSIDIAN_API_KEY=<OBSIDIAN_API_KEY> -- node -y obsidian-mcp-serverCursor — .cursor/mcp.json(本地)
- 打开项目根目录下的 .cursor/mcp.json(没有就新建)
- 点击「复制配置」粘贴进去;若已有其他 MCP,只合并 mcpServers 里的本条目
- 将 env 中的 <占位符> 替换为真实密钥(见下方「环境变量」)
- 保存后按 Cmd+Shift+P(Windows:Ctrl+Shift+P)→ 输入 Reload Window 并执行
{
"mcpServers": {
"obsidian-mcp-server": {
"command": "node",
"args": [
"-y",
"obsidian-mcp-server"
],
"env": {
"OBSIDIAN_API_KEY": "<OBSIDIAN_API_KEY>"
}
}
}
}VS Code — .vscode/mcp.json(本地)
- 确保 VS Code 已安装 GitHub Copilot 扩展并支持 MCP
- 打开项目根目录下的 .vscode/mcp.json(没有就新建)
- 点击「复制配置」粘贴;若已有其他 MCP,只合并 mcpServers 里的本条目
- 将 env 中的 <占位符> 替换为真实密钥(见下方「环境变量」)
- 保存后重新加载 VS Code 窗口
{
"mcpServers": {
"obsidian-mcp-server": {
"command": "node",
"args": [
"-y",
"obsidian-mcp-server"
],
"env": {
"OBSIDIAN_API_KEY": "<OBSIDIAN_API_KEY>"
}
}
}
}Claude Desktop — claude_desktop_config.json(本地)
- 打开 Claude Desktop 的 claude_desktop_config.json(路径见远程指引)
- 点击「复制配置」合并到 mcpServers
- 将 env 中的 <占位符> 替换为真实密钥
- 完全退出并重启 Claude Desktop
{
"mcpServers": {
"obsidian-mcp-server": {
"command": "node",
"args": [
"-y",
"obsidian-mcp-server"
],
"env": {
"OBSIDIAN_API_KEY": "<OBSIDIAN_API_KEY>"
}
}
}
}Trae — .trae/mcp.json(本地)
- 打开 Trae → 设置 → MCP,或编辑 .trae/mcp.json / 全局 mcp.json
- 点击「复制配置」粘贴并合并 mcpServers
- 将 env 中的 <占位符> 替换为真实密钥
- 保存后重载 Trae 窗口
{
"mcpServers": {
"obsidian-mcp-server": {
"command": "node",
"args": [
"-y",
"obsidian-mcp-server"
],
"env": {
"OBSIDIAN_API_KEY": "<OBSIDIAN_API_KEY>"
}
}
}
}Cherry Studio — MCP 设置(本地)
- 打开 Cherry Studio → 设置 → MCP 服务器 → 添加(STDIO)
- 也可直接导入下方 JSON:点击「复制配置」合并到 mcpServers
- 将 env 中的 <占位符> 替换为真实密钥,并确保本机已安装 Node.js / uv(npx、uvx)
- 启用服务并查看工具列表是否加载成功
{
"mcpServers": {
"obsidian-mcp-server": {
"command": "node",
"args": [
"-y",
"obsidian-mcp-server"
],
"env": {
"OBSIDIAN_API_KEY": "<OBSIDIAN_API_KEY>"
}
}
}
}通义灵码 — MCP 配置(本地)
- 通义灵码:个人设置 → MCP 服务 → 「+」→ 手工添加(STDIO)或配置文件添加
- 点击「复制配置」合并 mcpServers;命令/参数/环境变量与 JSON 一致
- 将 env 中的 <占位符> 替换为真实密钥;本机需 Node.js 18+(npx)或已安装 uv(uvx)
- 确认服务状态为已连接后再在智能体对话中调用
{
"mcpServers": {
"obsidian-mcp-server": {
"command": "node",
"args": [
"-y",
"obsidian-mcp-server"
],
"env": {
"OBSIDIAN_API_KEY": "<OBSIDIAN_API_KEY>"
}
}
}
}Windsurf — mcp_config.json(本地)
- 编辑 ~/.codeium/windsurf/mcp_config.json
- 点击「复制配置」合并 mcpServers(本地 stdio 与 Cursor 格式相同)
- 将 env 中的 <占位符> 替换为真实密钥后保存并刷新 Cascade
{
"mcpServers": {
"obsidian-mcp-server": {
"command": "node",
"args": [
"-y",
"obsidian-mcp-server"
],
"env": {
"OBSIDIAN_API_KEY": "<OBSIDIAN_API_KEY>"
}
}
}
}Cline — MCP Servers(本地)
- Cline 面板 → 设置 → MCP Servers
- 点击「复制配置」粘贴并合并
- 将 env 中的 <占位符> 替换为真实密钥后保存
{
"mcpServers": {
"obsidian-mcp-server": {
"command": "node",
"args": [
"-y",
"obsidian-mcp-server"
],
"env": {
"OBSIDIAN_API_KEY": "<OBSIDIAN_API_KEY>"
}
}
}
}WorkBuddy — .workbuddy/mcp.json(本地)
- 编辑 ~/.workbuddy/mcp.json(用户级)或项目目录 .workbuddy/mcp.json
- 也可在界面:插件 → MCP 服务器 → 配置 MCP,粘贴下方 JSON
- 将 env 中的 <占位符> 替换为真实密钥;Windows 下 command/脚本路径建议用绝对路径
- 保存并重启 WorkBuddy,确认连接器状态为绿色
{
"mcpServers": {
"obsidian-mcp-server": {
"command": "node",
"args": [
"-y",
"obsidian-mcp-server"
],
"env": {
"OBSIDIAN_API_KEY": "<OBSIDIAN_API_KEY>"
}
}
}
}常见报错排查与运行避坑 (Troubleshooting)FAQ
针对 obsidian-mcp-server 在 Cursor、Claude Code 中的常见连接错误与解决办法
在 Cursor / Claude Code 中配置 obsidian-mcp-server 提示 connection closed 或 exit code 1?
通常由本地运行时环境缺失或命令路径未被 IDE 继承引起。排查步骤: 1. 确认已安装 Node.js 18+(支持 npx)或 Python 3.10+(支持 uvx); 2. 尝试在终端运行 which npx 或 which uvx,把配置文件中的 "command" 字段改为完整绝对路径; 3. 修改 mcp.json 后,必须完全重载或重启客户端窗口。
# 终端测试命令是否存在: which npx node -v
提示 spawn npx ENOENT 或 command not found?
这是因为编辑器后台进程未加载完整的终端环境变量(PATH)。解决方案:在全局安装该包(如 npm install -g 包名),或在配置文件中将 command 设置为系统的实际路径(如 Windows 下的 C:\Program Files\nodejs\npx.cmd,Mac 下的 /usr/local/bin/npx)。
提示 Missing required environment variable 或 API 认证失败?
obsidian-mcp-server 依赖环境变量(如 OBSIDIAN_API_KEY、OBSIDIAN_API_KEY)。请在客户端配置文件的 "env" 对象中填入有效密钥,注意不要包含多余空格或未闭合的双引号。
// .cursor/mcp.json 或 claude_desktop_config.json
{
"env": {
"OBSIDIAN_API_KEY": "your_actual_key_here"
}
}免安装模拟调用 (Playground)
仿真环境obsidian-mcp-server 核心接口调用仿真 · 无需配置本地环境,直接预览调用参数与返回格式
{
"target": "obsidian-mcp-server",
"action": "execute",
"options": {
"mode": "standard",
"timeoutMs": 5000
}
}点击上方「模拟运行」按钮
查看该工具在 Agent 内部的返回数据格式
选型与决策建议(为什么选它?)
帮助你快速判断该资源是否契合当前项目,避免盲目折腾
- PR 自动审查
- 生成 changelog
- 跨仓库 Issue 检索
- 替代人工安全审计
- 在无授权仓库上操作
obsidian-mcp-server + 对应场景 Prompt → 组成标准 Agent 自动化任务
MCP 实战教程:从安装到看见效果
按完整实例走一遍(含期望效果与对比验收)。装完本页资源后,用教程里的提示词核对是否真正生效。
相关资源
顺序思考
io.mcp-cn.modelcontextprotocol/server-sequential-thinking
帮助AI进行结构化思考和推理的MCP工具
n8n
io.mcp-cn.drballs/n8n-mcp-server
n8n工作流自动化平台的MCP服务器,提供完整的工作流管理、执行控制、凭证管理等功能
Playwright
io.mcp-cn.playwright/mcp
基于Playwright的自动化测试和网页操作MCP工具
GitHub
io.mcp-cn.modelcontextprotocol/server-github
连接GitHub的MCP服务器,支持仓库管理、问题跟踪、代码搜索等功能
高德地图
io.mcp-cn.amap/amap-maps-mcp-server
高德地图的MCP服务器
Figma
io.mcp-cn.figma-developer-mcp
连接Figma的MCP服务器,支持设计文件管理和操作
常搭配使用
基于文件的规划
v3.23.0
io.clawhub.othmanadi/planning-with-files
面向多步 AI Agent 工作的持久化文件规划。将 task_plan.md、findings.md 与 progress.md 保存在磁盘上,生命周期钩子注入所选的项目规划上下文;自动恢复仅读取项目规划文件,显式运行 session-catchup.py --input-file 时读取同项目的本地 Agent……(原文截断)
OpenClaw 指挥中心
v1.5.0
io.clawhub.jontsai/command-center
OpenClaw 任务控制台仪表盘——实时会话监控、LLM 用量跟踪、成本情报与系统生命体征。在一处查看你所有的 AI Age……(原文截断)
ClawCall 语音电话
v2.0.1
io.clawhub.clawcall-dev/clawcall-dev
当用户需要 AI Agent 拨打美国电话、呼叫商家、处理通话等待或语音菜单、完成确认/改期/取消/预订/跟进/查询……时使用本技能(原文截断)。
中文公文写作
v2.0.25
io.clawhub.gongyu0918-debug/chinese-official-writing
用于中文公文、事务性材料和新闻稿件的起草、改写、压缩、润色、审校、文种核对、去口语化、降 AI 味及 Word 格式处理,适用于机关、企事业单位、学校和新闻机构。涵盖申请、请示、报告、通知、通告、意见、决定、决议、议案、公报、命令、函、复函、批复、说明、方案、纪要、公告、公示、通报、制度、规定、办法、细则、操作规程、工作要点、总结、调研、讲话、致辞、主持词、述职、可研、审查材料、技术需求、新闻消息、编者按、新闻评论,以及采购、整改、反馈和 AI 算力等场景。
继续逛 AgentHub
大多数人安装前还会对比同类工具或看场景方案——下面这些能帮你少走弯路。
收录徽章:把 AgentHub 挂到你的官网
复制下面任意一段代码到项目主页、官网或 GitHub README。徽章是 SVG 热链,无需上传文件,链接指向本页,访客可由此直接找到安装方式。
<a href="https://myagenthub.cn/p/io.github.cyanheads/obsidian-mcp-server" title="AgentHub 已收录:obsidian-mcp-server" target="_blank" rel="noopener">
<img src="https://myagenthub.cn/badge/io.github.cyanheads/obsidian-mcp-server" alt="AgentHub 已收录:obsidian-mcp-server" height="20" style="border:0"/>
</a>[](https://myagenthub.cn/p/io.github.cyanheads/obsidian-mcp-server)徽章由 /badge/<资源ID> 动态生成,名称与收录状态变化后自动更新;请保留链接指向,它是收录来源的判定依据。
统一 Manifest
{
"id": "io.github.cyanheads/obsidian-mcp-server",
"type": "mcp-server",
"version": "3.6.0",
"displayName": "obsidian-mcp-server",
"description": "Read, write, search, and surgically edit Obsidian notes, tags, and frontmatter via MCP.",
"repository": {
"url": "https://github.com/cyanheads/obsidian-mcp-server",
"source": "github"
},
"distribution": {
"packages": [
{
"registryType": "npm",
"identifier": "obsidian-mcp-server",
"version": "3.6.0",
"runtimeHint": "node",
"transport": "stdio",
"environmentVariables": [
{
"name": "OBSIDIAN_API_KEY",
"description": "Bearer token for the Obsidian Local REST API plugin (Settings → Community Plugins → Local REST API).",
"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)."
},
{
"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."
},
{
"name": "OBSIDIAN_REQUEST_TIMEOUT_MS",
"description": "Per-request timeout in milliseconds."
},
{
"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."
},
{
"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/'."
},
{
"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/'."
},
{
"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."
},
{
"name": "OBSIDIAN_OMNISEARCH_URL",
"description": "Override URL for the Omnisearch plugin HTTP server. Unset derives from OBSIDIAN_BASE_URL host with port 51361. Required only if the Omnisearch plugin is not on the default port."
},
{
"name": "MCP_LOG_LEVEL",
"description": "Sets the minimum log level for output (e.g., 'debug', 'info', 'warn')."
}
]
},
{
"registryType": "npm",
"identifier": "obsidian-mcp-server",
"version": "3.6.0",
"runtimeHint": "node",
"transport": "streamable-http",
"environmentVariables": [
{
"name": "OBSIDIAN_API_KEY",
"description": "Bearer token for the Obsidian Local REST API plugin (Settings → Community Plugins → Local REST API).",
"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)."
},
{
"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."
},
{
"name": "OBSIDIAN_REQUEST_TIMEOUT_MS",
"description": "Per-request timeout in milliseconds."
},
{
"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."
},
{
"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/'."
},
{
"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/'."
},
{
"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."
},
{
"name": "OBSIDIAN_OMNISEARCH_URL",
"description": "Override URL for the Omnisearch plugin HTTP server. Unset derives from OBSIDIAN_BASE_URL host with port 51361. Required only if the Omnisearch plugin is not on the default port."
},
{
"name": "MCP_HTTP_HOST",
"description": "The hostname for the HTTP server."
},
{
"name": "MCP_HTTP_PORT",
"description": "The port to run the HTTP server on."
},
{
"name": "MCP_HTTP_ENDPOINT_PATH",
"description": "The endpoint path for the MCP server."
},
{
"name": "MCP_AUTH_MODE",
"description": "Authentication mode to use: 'none', 'jwt', or 'oauth'."
},
{
"name": "MCP_LOG_LEVEL",
"description": "Sets the minimum log level for output (e.g., 'debug', 'info', 'warn')."
}
]
}
],
"remotes": []
},
"dependencies": [],
"installTargets": [
"claude-code",
"claude-desktop",
"cursor",
"vscode",
"trae",
"cherry-studio",
"lingma",
"windsurf",
"cline",
"workbuddy"
],
"keywords": [],
"provenance": {
"origin": "official-mcp-registry",
"originalId": "io.github.cyanheads/obsidian-mcp-server",
"originalUrl": "https://registry.modelcontextprotocol.io/v0.1/servers/io.github.cyanheads%2Fobsidian-mcp-server/versions/latest",
"isOfficial": true,
"status": "active"
}
}