obsidian

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Obsidian Vault Interaction

Obsidian 库交互

You can interact with Obsidian vaults by reading and writing Markdown files directly on the local filesystem. Obsidian vaults are simply directories of
.md
files with optional YAML frontmatter and
[[wikilink]]
syntax for inter-note linking.
When creating new notes, always include YAML frontmatter with relevant metadata fields like
tags
,
date
,
aliases
, and any custom properties the vault uses. Use
[[wikilinks]]
for internal links and
![[embeds]]
for transclusion. Respect the vault's folder structure -- check for existing organizational patterns (e.g., daily notes in
Daily/
, templates in
Templates/
) before creating files in new locations.
For searching and navigating the vault, scan file contents for keywords, tags (
#tag
syntax), and frontmatter properties. Follow
[[wikilinks]]
to traverse the knowledge graph. When summarizing vault contents, consider both the explicit folder hierarchy and the implicit link-based graph structure.
When editing existing notes, preserve all existing frontmatter fields, wikilinks, and formatting. Append new content at appropriate locations rather than overwriting. For daily notes, follow the vault's date format convention (typically
YYYY-MM-DD
). Support Dataview-compatible frontmatter when the user's vault uses the Dataview plugin.
你可以通过直接在本地文件系统上读写Markdown文件来与Obsidian库进行交互。Obsidian库本质上是存放
.md
文件的目录,这些文件可包含可选的YAML frontmatter,以及用于笔记间链接的
[[wikilink]]
语法。
创建新笔记时,请务必包含带有相关元数据字段的YAML frontmatter,例如
tags
date
aliases
以及该库使用的任何自定义属性。内部链接使用
[[wikilinks]]
,内容嵌入使用
![[embeds]]
。请遵循库的文件夹结构——在新位置创建文件前,先检查现有的组织模式(例如,每日笔记存放在
Daily/
目录,模板存放在
Templates/
目录)。
搜索和导航库时,可扫描文件内容中的关键词、标签(
#tag
语法)和frontmatter属性。通过
[[wikilinks]]
遍历知识图谱。总结库内容时,需同时考虑显式的文件夹层级和基于链接的隐式图谱结构。
编辑现有笔记时,请保留所有现有的frontmatter字段、wikilinks和格式。在合适的位置追加新内容,而非覆盖原有内容。对于每日笔记,请遵循库的日期格式约定(通常为
YYYY-MM-DD
)。如果用户的库使用Dataview插件,请支持兼容Dataview的frontmatter。

Examples

示例

  • "Create a new note called 'Project Kickoff' in the Meetings folder with today's date"
  • "Find all notes tagged #research and summarize their key points"
  • "Add a link to [[Architecture Decisions]] in the project overview note"
  • "List all notes that link to [[API Design]] (backlinks)"
  • "Create a daily note for today with the standup template"
  • "在Meetings文件夹中创建一个名为'Project Kickoff'的新笔记,并添加今天的日期"
  • "查找所有带有#research标签的笔记并总结其要点"
  • "在项目概览笔记中添加指向[[Architecture Decisions]]的链接"
  • "列出所有链接到[[API Design]]的笔记(反向链接)"
  • "使用站会模板创建今天的每日笔记"

Constraints

约束条件

  • Operates on local filesystem only; no cloud sync awareness.
  • Cannot interact with Obsidian plugins directly (Canvas, Excalidraw, etc.) -- only reads/writes Markdown files.
  • Binary attachments (images, PDFs) can be referenced but not created.
  • Vault path must be known and accessible to the agent.
  • Wikilink resolution follows Obsidian's "shortest path" convention when note names are unique.
  • Large vaults (10,000+ notes) may require targeted searches rather than full scans.
  • 仅在本地文件系统上运行;不支持云同步感知。
  • 无法直接与Obsidian插件(如Canvas、Excalidraw等)交互——仅能读写Markdown文件。
  • 可引用二进制附件(图片、PDF等),但无法创建它们。
  • 代理必须知晓且可访问库的路径。
  • 当笔记名称唯一时,Wikilink解析遵循Obsidian的“最短路径”约定。
  • 大型库(包含10000+条笔记)可能需要针对性搜索,而非全量扫描。