nicoryou-obsidian-cli-mcp

English | 中文

English

1. Introduction

nicoryou-obsidian-cli-mcp is an MCP (Model Context Protocol) server that wraps Obsidian CLI commands, enabling AI assistants to interact with your Obsidian vault directly. It provides 45 tools covering file operations, search, task management, tags, links analysis, properties, daily notes, and more.

Authors:

• First Author: qwencode + glm5 (AI Assistant)
• Second Author: Nicoryou (Human)

2. Requirements

• Obsidian: Installed and running
• Obsidian CLI: Available in your shell (verify with obsidian help)
• Node.js: Version 18.0.0 or higher

3. Getting Started

Installation

# Global installation via npm
npm install -g nicoryou-obsidian-cli-mcp

# Or install from source
git clone https://github.com/Nicoryou/nicoryou-obsidian-cli-mcp.git
cd nicoryou-obsidian-cli-mcp
npm install
npm link

Configuration

For Qwen Code (~/.qwen/settings.json):

{
  "mcpServers": {
    "obsidian": {
      "command": "nicoryou-obsidian-cli-mcp"
    }
  }
}

For Claude Desktop (~/Library/Application Support/Claude/claude_desktop_config.json):

{
  "mcpServers": {
    "obsidian": {
      "command": "nicoryou-obsidian-cli-mcp"
    }
  }
}

After configuration, restart your AI assistant to load the MCP tools.

4. Command Examples

Once configured, you can ask your AI assistant to perform these operations:

File Operations

# Read a note
obsidian_read --file "My Note"

# Create a new note
obsidian_create --name "New Note" --content "Initial content"

# Append content to a note
obsidian_append --file "My Note" --content "Additional text"

Search

# Search for text in vault
obsidian_search --query "project"

# Search with context
obsidian_search_context --query "important" --limit 10

Task Management

# List all tasks
obsidian_tasks

# List only incomplete tasks
obsidian_tasks --todo true

# Toggle a task status
obsidian_task_toggle --file "My Note" --line 5

Tags & Links

# List all tags
obsidian_tags --counts true

# Get tag info
obsidian_tag_info --name "#project"

# List backlinks
obsidian_backlinks --file "My Note"

# Find orphan notes
obsidian_orphans

Daily Notes

# Read today's daily note
obsidian_daily_read

# Append to daily note
obsidian_daily_append --content "Today's progress"

Vault Info

# Get vault information
obsidian_vault_info

# List files in a folder
obsidian_files --folder "Projects"

# Get note outline
obsidian_outline --file "My Note"

中文

1. 简介

nicoryou-obsidian-cli-mcp 是一个 MCP（Model Context Protocol）服务器，封装了 Obsidian CLI 命令，让 AI 助手能够直接操作你的 Obsidian 笔记库。它提供了 45 个工具，涵盖文件操作、搜索、任务管理、标签、链接分析、属性、日记等功能。

作者：

• 第一作者：qwencode + glm5（AI 助手）
• 第二作者：Nicoryou（人类）

2. 环境要求

• Obsidian：已安装并正在运行
• Obsidian CLI：在终端可用（运行 obsidian help 验证）
• Node.js：版本 18.0.0 或更高

3. 开始使用

安装

# 通过 npm 全局安装
npm install -g nicoryou-obsidian-cli-mcp

# 或从源码安装
git clone https://github.com/Nicoryou/nicoryou-obsidian-cli-mcp.git
cd nicoryou-obsidian-cli-mcp
npm install
npm link

配置

Qwen Code (~/.qwen/settings.json)：

{
  "mcpServers": {
    "obsidian": {
      "command": "nicoryou-obsidian-cli-mcp"
    }
  }
}

Claude Desktop (~/Library/Application Support/Claude/claude_desktop_config.json)：

{
  "mcpServers": {
    "obsidian": {
      "command": "nicoryou-obsidian-cli-mcp"
    }
  }
}

配置完成后，重启 AI 助手即可加载 MCP 工具。

4. 命令例子

配置完成后，你可以让 AI 助手执行以下操作：

文件操作

# 读取笔记
obsidian_read --file "我的笔记"

# 创建新笔记
obsidian_create --name "新笔记" --content "初始内容"

# 向笔记追加内容
obsidian_append --file "我的笔记" --content "追加的文本"

搜索

# 在笔记库中搜索
obsidian_search --query "项目"

# 搜索并显示上下文
obsidian_search_context --query "重要" --limit 10

任务管理

# 列出所有任务
obsidian_tasks

# 只列出未完成任务
obsidian_tasks --todo true

# 切换任务状态
obsidian_task_toggle --file "我的笔记" --line 5

标签与链接

# 列出所有标签
obsidian_tags --counts true

# 获取标签信息
obsidian_tag_info --name "#项目"

# 列出反向链接
obsidian_backlinks --file "我的笔记"

# 查找孤立笔记
obsidian_orphans

日记

# 读取今天的日记
obsidian_daily_read

# 向日记追加内容
obsidian_daily_append --content "今天的进度"

笔记库信息

# 获取笔记库信息
obsidian_vault_info

# 列出文件夹中的文件
obsidian_files --folder "项目"

# 获取笔记大纲
obsidian_outline --file "我的笔记"

Available Tools / 可用工具

| Category | Tools | |----------|-------| | File Operations / 文件操作 | obsidian_read, obsidian_create, obsidian_append, obsidian_prepend, obsidian_delete, obsidian_move, obsidian_rename | | Search / 搜索 | obsidian_search, obsidian_search_context | | Tasks / 任务 | obsidian_tasks, obsidian_task_toggle | | Tags / 标签 | obsidian_tags, obsidian_tag_info | | Links / 链接 | obsidian_links, obsidian_backlinks, obsidian_orphans, obsidian_unresolved | | Properties / 属性 | obsidian_properties, obsidian_property_read, obsidian_property_set, obsidian_property_remove | | Daily Notes / 日记 | obsidian_daily, obsidian_daily_read, obsidian_daily_append, obsidian_daily_prepend, obsidian_daily_path | | Others / 其他 | obsidian_outline, obsidian_bookmarks, obsidian_files, obsidian_folders, obsidian_vault_info, obsidian_templates, obsidian_command |

License / 许可证

MIT