ai.smithery/sunub-obsidian-mcp-server

Install

Config snippet generator goes here (5 client tabs)

README

# Obsidian MCP Server

[![npm version](https://img.shields.io/npm/v/@sunub/obsidian-mcp-server.svg)](https://www.npmjs.com/package/@sunub/obsidian-mcp-server)

`obsidian-mcp-server`는 Obsidian Vault의 Markdown 문서를 AI 에이전트가 조회하고, 검색하고, 요약할 수 있게 해주는 MCP 서버입니다.

MCP 클라이언트에 연결해 에이전트에게 **토큰 사용량을 제어하면서** Vault 내용을 조회할 수 있게 합니다.


## 무엇을 할 수 있나

- 키워드 기반 노트 검색 (`vault`, `action="search"`)
- 특정 노트 열람 (`vault`, `action="read"`)
- Vault 전체 문서 목록 조회 (`vault`, `action="list_all"`)
- Vault 상태 조회 (`vault`, `action="stats"`)
- 장기 컨텍스트용 메모리 패킷 생성 (`vault`, `action="collect_context"`)
- 저장된 메모리 노트 조회 (`vault`, `action="load_memory"`)
- frontmatter 자동 생성 제안 (`generate_property`)
- frontmatter 실제 반영 (`write_property`)
- 문서 기반 프롬프트 워크플로우 (`create_document_with_properties`)
- 이미지 첨부파일 정리 (`organize_attachments`)

## 사전 주의사항

이 서버는 Vault 내용을 클라이언트에 노출합니다. 운영 환경에서 신중히 사용하세요.

- 신뢰할 수 없는 AI 에이전트와 연결하지 마세요.
- Vault 경로(`VAULT_DIR_PATH`)는 최소 권한으로 제한하세요.
- 조회량이 큰 Vault는 `maxOutputChars`, `limit`를 조절해 토큰 비용을 통제하세요.
- `vault` 액션 기본 압축 모드는 `balanced`입니다.

### 설정 확인사항

1. Vault 경로: VAULT_DIR_PATH에는 반드시 절대 경로를 입력해야 합니다.

```plaintext
// ✅ 올바른 예시
"VAULT_DIR_PATH": "/Users/username/Documents/MyVault"
"VAULT_DIR_PATH": "C:\\Users\\username\\Documents\\MyVault"  // Windows
"VAULT_DIR_PATH": "/mnt/c/Users/username/Documents/MyVault"  // WSL

// ❌ 잘못된 예시
"VAULT_DIR_PATH": "~/Documents/MyVault"  // 상대 경로 사용 불가
"VAULT_DIR_PATH": "./vault"              // 상대 경로 사용 불가
```

2. Node.js 요구사항: Node.js 22 이상이 설치되어 있어야 합니다.

```bash
node --version  # v22.0.0 이상 확인
```

## 시작하기 (빠른 설정)

### 1) 공통 요구사항

- 최소 설정은 `VAULT_DIR_PATH` (Vault 절대 경로)입니다.
- MCP 실행 자체는 배포 패키지 기준으로 맞춰 설명합니다.
  - 배포 패키지(`npx`) 사용 (권장)
  - 로컬 `build/index.js`는 개발/디버깅 목적
- 로컬 실행은 마지막 섹션(5)에서 분리 안내합니다.
- Vault 경로가 없으면 시작이 실패합니다.
- 아래 예시는 복붙으로 바로 사용할 수 있도록 정리했습니다.

### 2) 배포 패키지 (`npx`) 설정

```json
{
  "mcpServers": {
    "obsidian": {
      "command": "npx",
      "args": ["-y", "@sunub/obsidian-mcp-server@latest"],
      "env": {
        "VAULT_DIR_PATH": "/abs/path/to/your/vault",
        "LOGGING_LEVEL": "info"
      }
    }
  }
}
```

CLI 직접 실행:

```bash
npx -y @sunub/obsidian-mcp-server@latest --vault-path /abs/path/to/your/vault --logging-level info
```

### 3) MCP Client configuration

클라이언트별 UI가 다르더라도 `command`/`args`/`env`의 기본 형태는 동일합니다.

> 배포 패키지 기준 핵심: `command="npx"`, `args=["-y","@sunub/obsidian-mcp-server@latest"]`, `env.VAULT_DIR_PATH`

<details>
  <summary>Codex</summary>
  `.codex/config.toml`에 아래처럼 등록합니다.

  ```toml
  [mcp_servers.obsidian]
  command = "npx"
  args = ["-y", "@sunub/obsidian-mcp-server@latest"]
  env = { VAULT_DIR_PATH = "/abs/path/to/your/vault" }
  ```
</details>

<details>
  <summary>Copilot CLI</summary>

  1) `copilot` 실행
  2) `/mcp add`
  3) 아래 값 입력

  - **Server name:** `obsidian`
  - **Server Type:** `[1] Local`
  - **Command:** `npx -y @sunub/obsidian-mcp-server@latest`
  - **Environment:** `{ "VAULT_DIR_PATH": "/abs/path/to/your/vault" }`
</details>

<details>
  <summary>Copilot / VS Code</summary>

  버전별 JSON 키 이름이 다를 수 있으므로(예: `servers`/`mcpServers`), 프로젝트 문서에 맞춰 적용하세요.

  ```json
  {
    "mcpServers": {
      "obsidian": {
        "command": "npx",
        "args": ["-y", "@sunub/obsidian-mcp-server@latest"],
        "env": { "VAULT_DIR_PATH": "/abs/path/to/your/vault" }
      }
    }
  }
  ```
</details>

<details>
  <summary>Cursor</summary>

  `Cursor Settings` → `MCP` → `New MCP Server`에서 등록합니다.

  ```json
  {
    "obsidian": {
      "command": "npx",
      "args": ["-y", "@sunub/obsidian-mcp-server@latest"],
      "env": { "VAULT_DIR_PATH": "/abs/path/to/your/vault" }
    }
  }
  ```
  
  ※ 일부 버전은 서버 식별 키명이 다를 수 있으니 설정 화면 안내에 맞춰 붙여넣으세요.
</details>

<details>
  <summary>Gemini CLI</summary>

  패키지 설치형 예시:

  ```bash
  gemini mcp add obsidian npx -y @sunub/obsidian-mcp-server@latest --vault-path /abs/path/to/your/vault
  ```
  
  ※ 일부 Gemini 버전은 `--vault-path` 지원이 다를 수 있으므로, `gemini mcp add`의 최신 문서를 확인하세요.
</details>

### 4) 완성 예시 설정

```json
{
  "mcpServers": {
    "obsidian": {
      "command": "npx",
      "args": [
        "-y",
        "@sunub/obsidian-mcp-server@latest"
      ],
      "env": {
        "VAULT_DIR_PATH": "/path/to/obsidian-vault",
        "VAULT_METRICS_LOG_PATH": "/path/to/vault-metrics.ndjson",
        "LOGGING_LEVEL": "info"
      }
    }
  }
}
```

## 환경 변수 설정

- `VAULT_DIR_PATH` (필수): Obsidian Vault 절대 경로
- `VAULT_METRICS_LOG_PATH` (선택): 액션 응답 압축/토큰 메트릭을 JSONL로 기록
- `LOGGING_LEVEL` (선택): `debug` | `info` | `warn` | `error`

## 시작 후 빠른 검증

연결이 끝나면 아래 3가지만 먼저 확인하세요.  
문서가 안 열리더라도 어디서 실패했는지 바로 좁힐 수 있습니다.

1) Vault 상태 확인

```text
"Vault 상태를 요약해줘."
```

예상 내부 동작:

```json
{
  "method": "tools/call",
  "params": {
    "name": "vault",
    "arguments": { "action": "stats" }
  }
}
```

정상 동작 시 응답에 `totalFiles`, `isInitialized`, `vaultPath`가 들어갑니다.

2) 검색 인덱스 확인

```text
"노트 제목에 'MCP'가 들어간 문서만 5개 찾아줘."
```

예상 내부 동작:

```json
{
  "method": "tools/call",
  "params": {
    "name": "vault",
    "arguments": {
      "action": "se