知识库AI连接服务

Obsidian-MCP-Server是一个为Obsidian知识库设计的AI连接服务,提供笔记管理、全文搜索、元数据提取等功能,帮助用户高效连接和管理知识库内容。

  • by indie-geeker
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 indie-geeker/obsidian-mcp-server

使用说明

“obsidian-mcp-server”翻译成中文是“奥西迪安MCP服务器”。不过,这里的“MCP”可能是一个特定上下文或领域的缩写,具体含义可能需要根据上下文来确定。在没有特定上下文的情况下,“MCP”通常可以理解为“Modded Minecraft Pack”(模组化我的世界包)的缩写,但在此处直接翻译为“服务器”可能已足够,具体还需结合使用场景

🔗 Obsidian的模型上下文协议服务器 - 将您的知识库与AI连接

✨ 特点

  • 📝 翻译为中文是:📝(这个符号本身没有特定的中文翻译,它通常代表“便签”或“笔记”的意思,但在这里直接以符号形式呈现,因为符号本身无需翻译,其含义在上下文中已隐含。)不过,如果非要给出一个与符号含义相关的中文表述,可以是“📝(便签/笔记)”。 笔记管理创建、阅读、更新和删除笔记
  • 🔍 翻译为中文是:放大镜(或表示正在搜索、查找的意图)。在没有具体上下文的情况下,这个符号通常被理解为表示放大、放大查看或搜索的动作。 搜索在您的保险库中进行全文搜索
  • 📋(清单/待办事项列表) 列表列出带有过滤选项的笔记
  • 📊 表格/数据图表 元数据获取文件大小、时间戳、标签和属性
  • ⏰ 排序按创建/修改时间或大小对笔记进行排序
  • 🏷️ 标签提取自动从前置信息和内容中提取标签
  • 🔒 表示“锁定”或“安全”的符号。 安全路径验证以防止目录遍历攻击
  • ⚡(闪电符号,常用于表示速度、能量或快速充电等概念) 快高效的文件操作

🚀 快速入门

安装

npm install -g @indiegeeker/obsidian-mcp-server
# or
pnpm install -g @indiegeeker/obsidian-mcp-server

配置

在您的Claude桌面配置中添加:

{
  "mcpServers": {
    "obsidian": {
      "command": "obsidian-mcp-server",
      "env": {
        "OBSIDIAN_VAULT_PATH": "/path/to/your/vault"
      }
    }
  }
}

📖 可用工具

创建笔记

在你的保险库中创建一个新笔记。

参数:

  • filename (必填):笔记的名称
  • content (必填):Markdown 内容
  • path (可选):保险库内的文件夹路径

读笔记

读取现有笔记的内容和前置信息。

参数:

  • filepath (必填):笔记的路径

搜索笔记

按内容搜索笔记。

参数:

  • query (必填):搜索字符串
  • path (可选):将搜索限制在文件夹内

列表笔记

列出保险库或文件夹中的所有笔记。

参数:

  • path (可选):要列出的文件夹
  • recursive (可选):包含子文件夹

更新说明

更新现有笔记的内容。

参数:

  • filepath (必填):笔记的路径
  • content (必填):新内容
  • append (可选):追加而非替换

删除笔记

从保险库中删除一条笔记。

参数:

  • filepath (必填):要删除的笔记的路径

获取笔记元数据

获取笔记的详细元数据。

参数:

  • filepath (必填):笔记的路径
  • includeTags (可选):从前置元数据和内容中提取标签(默认:true)

返回值:

  • 文件大小(以字节和格式化形式表示)
  • 创建时间
  • 修改时间
  • 前置材料属性
  • 提取的标签(来自前置信息和#话题标签)

排序后的笔记列表

按各种标准列出并排序笔记。

参数:

  • path (可选):要列出的文件夹(默认:根目录)
  • recursive (可选):包含子文件夹(默认:true)
  • sortBy (可选):排序标准 - "created", "modified", "size",或 "name" (默认: "modified")
  • order (可选):排序顺序 - "asc" 或者 "desc" (默认: "desc")
  • includeMetadata (可选):包含大小和时间戳(默认:true)
  • limit (可选):要返回的最大备注数

🛠️ 开发

# Clone the repo
git clone https://github.com/indiegeeker/obsidian-mcp-server.git

# Install dependencies
pnpm install

# Build
pnpm run build

# Watch mode
pnpm run dev

📄 许可证

麻省理工学院(MIT)