obsidian-full-mcp

MCP文档知识

提供方 gitjfmd

文档知识 stdio · 本地进程 API Key 社区 / 第三方 Claude DesktopClaudeClineCodex
查看接入方式

obsidian-full-mcp is a full-featured MCP server for Obsidian that provides AI assistants with complete vault operations through 16 tools, including note creation, reading, editing, deletion, search, Dataview queries, command execution, and periodic note management.

一句话选型结论

按资料字段整理

obsidian-full-mcp 属于文档知识类 MCP 服务器,stdio · 本地进程,API Key,可直接接入 Claude Desktop、Claude、Cline 等,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类文档知识 传输方式stdio · 本地进程 鉴权API Key 部署方式本地部署
GitHub 星标 0 仓库热度,无公开仓库时显示未标注
工具数 未标注 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

文档知识
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量未标注暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

Local Deployment MCP server Obsidian TypeScript Note management AI assistant integration Dataview query

支持客户端

适用场景

Local DeploymentMCP serverObsidian

安装与配置

stdio · 本地进程 API Key
客户端在本机拉起子进程,数据不出本机
node /path/to/obsidian-full-mcp/dist/index.js

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 node,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后随便调一个只读工具,确认能返回结果,再接入正式流程。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
文档检索问答

在你的文档库里按问题找答案。

知识库读写

把新资料写进知识库,随用随取。

内容整理

把零散资料归纳成结构化笔记。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 Claude Desktop、Claude、Cline,换客户端不用重新研究配置。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 使用前要准备好API Key对应的凭据,并按最小权限配置。
  • 资料没标注工具数量,实际能力要装好后确认。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在文档知识场景里让模型直接调用外部能力的人。
  • 已经在用 Claude Desktop、Claude 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
obsidian-full-mcp当前 未标注 stdio · 本地进程 本地部署 有 2026-09-26
dify 未标注 stdio · 本地进程 本地部署 有 2026-04-11
open-webui 未标注 stdio · 本地进程 本地部署 有 2026-04-11
JeecgBoot 未标注 stdio · 本地进程 本地部署 有 2026-04-11
Cherry Studio 未标注 未标注 未标注 无 2026-05-17
mempalace 未标注 stdio · 本地进程 本地部署 有 2026-04-11

服务器档案

文档知识
字段来自项目仓库与公开索引,中文说明由本站标注
提供方gitjfmd上游标注的维护方 gitjfmd
分类文档知识本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式API Key远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · node本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验2026-09-26上游最后核验时间

详细介绍

7.9 KB
来自项目仓库与上游目录的原文,未做删改

Full-featured MCP server for Obsidian — read, write, search, and manage your vault from any AI assistant.


Why?

The existing Obsidian MCP servers are read-only (3 tools). This one gives you full CRUD access with 16 tools — create notes, edit sections, search with Dataview, execute commands, manage periodic notes, and more.

@oleksandrkucherenko/mcp-obsidian obsidian-full-mcp
Read notes :white_check_mark: :white_check_mark:
Search :white_check_mark: text only :white_check_mark: text + Dataview DQL
Create notes :x: :white_check_mark:
Update notes :x: :white_check_mark:
Append to notes :x: :white_check_mark:
Patch (surgical edit) :x: :white_check_mark:
Delete notes :x: :white_check_mark:
List directories :x: :white_check_mark:
Periodic notes :x: :white_check_mark:
Execute commands :x: :white_check_mark:
Open in Obsidian UI :x: :white_check_mark:
Total tools 3 16

Prerequisites

  • Obsidian with the Local REST API plugin installed and enabled
  • Node.js 20+

Quick Start

Claude Code / Claude Desktop

Add to your ~/.mcp.json or claude_desktop_config.json:```json
{
"mcpServers": {
"obsidian": {
"command": "node",
"args": ["/path/to/obsidian-full-mcp/dist/index.js"],
"env": {
"OBSIDIAN_API_URL": "https://127.0.0.1:27124",
"OBSIDIAN_API_KEY": "your-api-key-here"
}
}
}
}


### From npm (coming soon)```bash
npx obsidian-full-mcp

From source```bash

git clone https://github.com/jfmd/obsidian-full-mcp.git
cd obsidian-full-mcp
npm install
npm run build


## Configuration

| Variable | Description | Default |
|----------|-------------|---------|
| `OBSIDIAN_API_URL` | Obsidian REST API URL | `https://127.0.0.1:27124` |
| `OBSIDIAN_API_KEY` | Your REST API key (from plugin settings) | **Required** |

> **Note:** The Obsidian Local REST API uses a self-signed TLS certificate. This server automatically handles that — no extra configuration needed.

## Tools

### Read Operations

| Tool | Description |
|------|-------------|
| `get_note` | Read note content as markdown or structured JSON (with frontmatter, tags) |
| `list_directory` | List files and folders in a vault directory |
| `get_active_file` | Get the currently open file in Obsidian |
| `get_periodic_note` | Get daily, weekly, monthly, quarterly, or yearly notes |

### Write Operations

| Tool | Description |
|------|-------------|
| `create_note` | Create a new note (fails if exists, unless `overwrite=true`) |
| `update_note` | Replace full note content |
| `append_to_note` | Append content to end of a note (creates it if missing) |
| `patch_note` | Surgical edit — target a heading, block ref, or frontmatter field |
| `delete_note` | Delete a note (requires explicit `confirm: true`) |
| `update_active_file` | Replace the content of the currently open file |
| `create_periodic_note` | Create or update periodic notes (daily/weekly/monthly/quarterly/yearly) |

### Search Operations

| Tool | Description |
|------|-------------|
| `search_vault` | Full-text search with configurable context length |
| `search_dataview` | Run Dataview DQL queries against your vault |

### Commands & UI

| Tool | Description |
|------|-------------|
| `list_commands` | List all available Obsidian commands (core + plugins) |
| `execute_command` | Execute an Obsidian command by ID |
| `open_in_obsidian` | Open a file in the Obsidian UI (current or new tab) |

## Tool Annotations

All tools include MCP tool annotations for safe AI usage:

- **Read tools** (`get_note`, `list_directory`, `get_active_file`, `get_periodic_note`, `search_vault`, `search_dataview`, `list_commands`): `readOnlyHint: true` — safe to call freely
- **Write tools** (`create_note`, `update_note`, `append_to_note`, `patch_note`, `update_active_file`, `create_periodic_note`): `destructiveHint: false, idempotentHint: true` — safe to retry
- **Delete tool** (`delete_note`): `destructiveHint: true` — requires `confirm: true` parameter
- **Command/UI tools** (`execute_command`, `open_in_obsidian`): `openWorldHint: true` — may have side effects beyond the vault

## Multi-Tool Configuration

Works with any MCP-compatible client:

Codex CLI```bash
codex mcp add obsidian \
  --env "OBSIDIAN_API_URL=https://127.0.0.1:27124" \
  --env "OBSIDIAN_API_KEY=your-key" \
  -- node /path/to/dist/index.js

OpenCode

In ~/.config/opencode/opencode.json:```json
{
"mcp": {
"obsidian": {
"type": "local",
"command": ["node", "/path/to/dist/index.js"],
"environment": {
"OBSIDIAN_API_URL": "https://127.0.0.1:27124",
"OBSIDIAN_API_KEY": "your-key"
},
"enabled": true
}
}
}


Cline

In MCP settings:```json
{
  "mcpServers": {
    "obsidian": {
      "command": "node",
      "args": ["/path/to/dist/index.js"],
      "env": {
        "OBSIDIAN_API_URL": "https://127.0.0.1:27124",
        "OBSIDIAN_API_KEY": "your-key"
      }
    }
  }
}

Any MCP Client (Generic)

The server communicates over stdio using JSON-RPC. Point your MCP client at the built entry point:```
node /path/to/obsidian-full-mcp/dist/index.js


Set the `OBSIDIAN_API_URL` and `OBSIDIAN_API_KEY` environment variables before launching.

## Architecture```
┌─────────────────────────────────────────┐
│         AI Assistant (Claude, etc.)      │
│              MCP Client                  │
└─────────────┬───────────────────────────┘
              │ stdio (JSON-RPC)
┌─────────────▼───────────────────────────┐
│        obsidian-full-mcp                 │
│   16 tools · Zod validation · annotations│
│         TypeScript MCP Server            │
└─────────────┬───────────────────────────┘
              │ HTTPS (REST)
┌─────────────▼───────────────────────────┐
│     Obsidian Local REST API Plugin       │
│          https://127.0.0.1:27124         │
└─────────────┬───────────────────────────┘
              │
┌─────────────▼───────────────────────────┐
│          Obsidian Vault                  │
│     Your notes, files, and config        │
└─────────────────────────────────────────┘

Development```bash

Install dependencies

npm install

Run in development mode (auto-reload with tsx)

npm run dev

Build for production

npm run build

Start production server

npm start

Lint

npm run lint


### Project Structure```
src/
  index.ts    # Entry point — stdio transport setup
  server.ts   # MCP server with all 16 tool definitions
  api.ts      # Obsidian Local REST API client

How It Works

  1. Your AI assistant connects to this server over stdio using the Model Context Protocol.
  2. The server exposes 16 tools that the assistant can call.
  3. Each tool call is translated into an HTTPS request to the Obsidian Local REST API plugin running inside Obsidian.
  4. Obsidian processes the request and the result flows back to the assistant.

All input is validated with Zod schemas before reaching the API. Tool annotations tell the assistant which operations are safe, destructive, or have side effects.

License

MIT -- see LICENSE.

Credits

  • Model Context Protocol by Anthropic
  • Obsidian Local REST API by coddingtonbear
  • Built with @modelcontextprotocol/sdk and Zod

常见问题

8 问
答案由本站依据条目字段整理,不引用上游原文
obsidian-full-mcp 怎么安装?

在客户端按下面的安装命令接入:node /path/to/obsidian-full-mcp/dist/index.js。装完在客户端配置里引用同一个包或端点。

obsidian-full-mcp 怎么在 Claude Desktop、Claude、Cline 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

obsidian-full-mcp 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

obsidian-full-mcp 需要 API Key 吗?

资料标注需要API Key认证,使用前准备好对应凭据,并按最小权限配置。

obsidian-full-mcp 支持哪些客户端?

资料标注支持 Claude Desktop、Claude、Cline、Codex;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

obsidian-full-mcp 能提供哪些能力?

资料显示能力标签包括 Local Deployment、MCP server、Obsidian、TypeScript、Note management、AI assistant integration。具体工具清单以官方文档为准。

obsidian-full-mcp 需要什么运行环境?

运行时为 node;属于本地进程,需要在本机装好运行环境。

obsidian-full-mcp 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-09-26。