Obsidian Dictionary MCP

🚀 Obsidian Dictionary MCP Server

這是一個用於在Obsidian保險庫中管理技術術語詞典的MCP服務器。它可以幫助用戶更高效地管理和使用技術術語詞典。

🚀 快速開始

本服務器可用於在Obsidian保險庫中管理技術術語詞典，以下是安裝和使用的詳細步驟。

📦 安裝指南

1. 構建項目

在終端中執行以下命令：

cd obsidian-dictionary-mcp
npm install
npm run build

2. 配置Claude Desktop

打開~/Library/Application Support/Claude/claude_desktop_config.json文件，並添加以下內容：

{
  "mcpServers": {
    "dict": {
      "command": "node",
      "args": [
        "/path/to/obsidian-dictionary-mcp/dist/index.js",
        "--glossary-path",
        "/path/to/your/ObsidianVault/Glossary/개발용어사전.md"
      ]
    }
  }
}

3. 配置Claude Code (CLI)

若要在Claude Code CLI中使用，可從以下兩種方法中選擇其一：

方法A：按項目配置（推薦）

在項目根目錄下創建.mcp.json文件，並添加以下內容：

{
  "mcpServers": {
    "dict": {
      "command": "node",
      "args": [
        "/path/to/obsidian-dictionary-mcp/dist/index.js",
        "--glossary-path",
        "/path/to/your/ObsidianVault/Glossary/개발용어사전.md"
      ]
    }
  }
}

方法B：全局配置

在~/.claude/settings.json文件中添加以下內容：

{
  "mcpServers": {
    "dict": {
      "command": "node",
      "args": [
        "/path/to/obsidian-dictionary-mcp/dist/index.js",
        "--glossary-path",
        "/path/to/your/ObsidianVault/Glossary/개발용어사전.md"
      ]
    }
  }
}

⚠️ 重要提示

配置文件創建或修改後，需要重啟Claude Code才能使更改生效。因為MCP服務器會在Claude Code啟動時讀取配置並運行。

--glossary-path 選項

使用--glossary-path選項設置默認術語表路徑後：

• 調用工具時可省略file_path參數。
• 若未設置，則每次都需明確指定file_path。

💻 使用示例

基礎用法

append_entry

向詞典中添加新術語。

# 示例命令
node /path/to/obsidian-dictionary-mcp/dist/index.js append_entry --term "新術語" --dev_explanation "開發人員視角的解釋" --simple_explanation "簡單解釋" --example "示例"

參數說明：

• file_path (可選)：詞典文件路徑（設置默認路徑後可省略）。
• term：要添加的術語。
• dev_explanation：開發人員用的解釋（韓語，1 - 2 句話）。
• simple_explanation：非開發人員用的解釋（韓語，1 句話）。
• example：示例（韓語，1 行）。

search_entry

檢查術語是否已存在。

# 示例命令
node /path/to/obsidian-dictionary-mcp/dist/index.js search_entry --term "待搜索術語"

參數說明：

• file_path (可選)：詞典文件路徑（設置默認路徑後可省略）。
• term：要搜索的術語。

get_entry

僅獲取特定術語的內容（非整個文件）。

# 示例命令
node /path/to/obsidian-dictionary-mcp/dist/index.js get_entry --term "待獲取術語"

參數說明：

• file_path (可選)：詞典文件路徑（設置默認路徑後可省略）。
• term：要獲取的術語。

list_terms

返回詞典中所有術語的列表（僅術語名稱，無內容）。

# 示例命令
node /path/to/obsidian-dictionary-mcp/dist/index.js list_terms

參數說明：

• file_path (可選)：詞典文件路徑（設置默認路徑後可省略）。

📚 詳細文檔

詞典條目格式

詞典條目採用以下格式：

### {term}
- 開發人員用的解釋: {開發人員視角的解釋}
- 非開發人員用的解釋: {簡單解釋}
- 示例: {簡短示例}

Obsidian保險庫路徑

詞典文件路徑示例：

/path/to/your/ObsidianVault/Glossary/개발용어사전.md