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