EO

eddmann/obsidian-mcp

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

15 stars 12 forks 质量 70 趋势 21MIT

MCP server for git-backed Obsidian vaults. Access and manage notes through Claude, ChatGPT, and other LLMs with automatic git sync. Supports local (stdio/HTTP) and remote (AWS Lambda) deployment.

概览

A Model Context Protocol (MCP) server for git-backed Obsidian vaults. Access and manage your notes through Claude, ChatGPT, and other LLMs by syncing changes via git. This MCP server provides and to interact with your Obsidian vault through LLMs: - File Operations (9) - Read, create, edit, delete, move, append, and patch notes - Directory Operations (3) - Create directories and list files - Search (1) - Fuzzy search with relevance scoring and exact matching - Tag Management (4) - Add, remove, rename, and manage tags - Journal Logging (1) - Auto-log LLM activity to daily journals - Stdio - Local deployment for Claude Desktop, Cursor - HTTP - Local/remote with OAuth for ChatGPT, Claude web - AWS Lambda - Serverless deployment with DynamoDB sessions Get started with Claude Desktop in 3 steps using Docker: macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%\Claude\claude_desktop_config.

README

以下为原文 README 节选,完整内容请查看原文。

Obsidian MCP Server

A Model Context Protocol (MCP) server for git-backed Obsidian vaults. Access and manage your notes through Claude, ChatGPT, and other LLMs by syncing changes via git.

Table of Contents

Overview

This MCP server provides 18 tools and 1 resource to interact with your Obsidian vault through LLMs:

Tool Categories:

  • File Operations (9) - Read, create, edit, delete, move, append, and patch notes
  • Directory Operations (3) - Create directories and list files
  • Search (1) - Fuzzy search with relevance scoring and exact matching
  • Tag Management (4) - Add, remove, rename, and manage tags
  • Journal Logging (1) - Auto-log LLM activity to daily journals

Deployment Modes:

  • Stdio - Local deployment for Claude Desktop, Cursor
  • HTTP - Local/remote with OAuth for ChatGPT, Claude web
  • AWS Lambda - Serverless deployment with DynamoDB sessions

Quick Start

Get started with Claude Desktop in 3 steps using Docker:

# 1. Download the example environment file
curl -O https://raw.githubusercontent.com/eddmann/obsidian-mcp/main/.env.example
mv .env.example obsidian-mcp.env

# 2. Edit obsidian-mcp.env with your vault repo and git token
# Required fields:
#   VAULT_REPO=https://github.com/username/vault-repo.git
#   VAULT_BRANCH=main
#   GIT_TOKEN=your_token_here

3. Add to Claude Desktop config:

Restart Claude Desktop and start chatting with your vault!

# 1. Clone and install
git clone https://github.com/eddmann/obsidian-mcp
cd obsidian-mcp
npm install

# 2. Configure credentials
cp .env.example .env
在 GitHub 查看完整 README

安装

docker run -i --rm -v /ABSOLUTE/PATH/TO/obsidian-mcp.env:/app/.env ghcr.io/eddmann/obsidian-mcp:latest stdio
新手?先看 mcpskill.org 教程 →

配置

{ "mcpServers": { "obsidian": { "command": "docker", "args": [ "run", "-i", "--rm", "-v", "/ABSOLUTE/PATH/TO/obsidian-mcp.env:/app/.env", "ghcr.io/eddmann/obsidian-mcp:latest", "stdio" ] } } }