返回市场
麦克佩斯-黑曜石

麦克佩斯-黑曜石

作者:kazuph5 星标更新:2024-12-27

项目介绍

MCP Obsidian

用于Obsidian保险库集成的模型上下文协议服务器。这允许Claude Desktop(或任何MCP客户端)搜索并阅读您的Obsidian笔记。

快速开始(用户)

先决条件

配置

  1. 打开您的Claude Desktop配置文件: ~/Library/Application Support/Claude/claude_desktop_config.json

您可以通过Claude Desktop菜单找到此文件:

  1. 打开Claude Desktop

  2. 点击Mac菜单栏中的Claude

  3. 点击“设置”

  4. 点击“开发者”

  5. 在您的配置中添加以下内容:

{
  "tools": {
    "obsidian": {
      "command": "npx",
      "args": ["-y", "@kazuph/mcp-obsidian"],
      "env": {
        "OBSIDIAN_VAULT_PATH": "/path/to/your/obsidian/vault"
      }
    }
  }
}

注意:请将/path/to/your/obsidian/vault替换为您实际的Obsidian保险库路径。

开发者指南

先决条件

安装

git clone https://github.com/kazuph/mcp-obsidian.git
cd mcp-obsidian
npm install
npm run build

配置

  1. 确保已安装并运行Claude Desktop。

  2. 如果尚未安装,请全局安装tsx:

npm install -g tsx
# 或
pnpm add -g tsx
  1. 修改位于以下位置的Claude Desktop配置: ~/Library/Application Support/Claude/claude_desktop_config.json

您可以通过Claude Desktop菜单轻松找到此文件:

  1. 打开Claude Desktop
  2. 点击Mac菜单栏中的Claude
  3. 点击“设置”
  4. 点击“开发者”

在您的MCP客户端配置中添加以下内容:

{
  "tools": {
    "obsidian": {
      "args": ["tsx", "/path/to/mcp-obsidian/index.ts"],
      "env": {
        "OBSIDIAN_VAULT_PATH": "/path/to/your/obsidian/vault"
      }
    }
  }
}

可用工具

  • obsidian_read_notes:读取多个笔记的内容。每个笔记的内容都会返回,并以路径作为参考。
  • obsidian_search_notes:按名称搜索笔记(不区分大小写,支持部分匹配和正则表达式)。
  • obsidian_read_notes_dir:列出指定路径下的目录结构。
  • obsidian_write_note:在指定路径下创建新的笔记。