Obsidian

使用说明

Read, create, update, search, and delete notes in your Obsidian vault. Manage periodic notes, execute commands, and patch content at specific locations. Requires the Obsidian Local REST API plugin.

工具

`obsidian_append_active`

Append content to the currently active file in Obsidian

输入

参数	类型	必填	描述
`apiKey`	string	是	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	是	Base URL for the Obsidian Local REST API
`content`	string	是	Markdown content to append to the active file

输出

参数	类型	描述
`appended`	boolean	Whether content was successfully appended

`obsidian_append_note`

Append content to an existing note in your Obsidian vault

输入

参数	类型	必填	描述
`apiKey`	string	是	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	是	Base URL for the Obsidian Local REST API
`filename`	string	是	Path to the note relative to vault root (e.g. "folder/note.md")
`content`	string	是	Markdown content to append to the note

输出

参数	类型	描述
`filename`	string	Path of the note
`appended`	boolean	Whether content was successfully appended

`obsidian_append_periodic_note`

Append content to the current periodic note (daily, weekly, monthly, quarterly, or yearly). Creates the note if it does not exist.

输入

参数	类型	必填	描述
`apiKey`	string	是	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	是	Base URL for the Obsidian Local REST API
`period`	string	是	Period type: daily, weekly, monthly, quarterly, or yearly
`content`	string	是	Markdown content to append to the periodic note

输出

参数	类型	描述
`period`	string	Period type of the note
`appended`	boolean	Whether content was successfully appended

`obsidian_create_note`

Create or replace a note in your Obsidian vault

输入

参数	类型	必填	描述
`apiKey`	string	是	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	是	Base URL for the Obsidian Local REST API
`filename`	string	是	Path for the note relative to vault root (e.g. "folder/note.md")
`content`	string	是	Markdown content for the note

输出

参数	类型	描述
`filename`	string	Path of the created note
`created`	boolean	Whether the note was successfully created

`obsidian_delete_note`

Delete a note from your Obsidian vault

输入

参数	类型	必填	描述
`apiKey`	string	是	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	是	Base URL for the Obsidian Local REST API
`filename`	string	是	Path to the note to delete relative to vault root

输出

参数	类型	描述
`filename`	string	Path of the deleted note
`deleted`	boolean	Whether the note was successfully deleted

`obsidian_execute_command`

Execute a command in Obsidian (e.g. open daily note, toggle sidebar)

输入

参数	类型	必填	描述
`apiKey`	string	是	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	是	Base URL for the Obsidian Local REST API
`commandId`	string	是	ID of the command to execute (use List Commands operation to discover available commands)

输出

参数	类型	描述
`commandId`	string	ID of the executed command
`executed`	boolean	Whether the command was successfully executed

`obsidian_get_active`

Retrieve the content of the currently active file in Obsidian

输入

参数	类型	必填	描述
`apiKey`	string	是	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	是	Base URL for the Obsidian Local REST API

输出

参数	类型	描述
`content`	string	Markdown content of the active file
`filename`	string	Path to the active file

`obsidian_get_note`

Retrieve the content of a note from your Obsidian vault

输入

参数	类型	必填	描述
`apiKey`	string	是	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	是	Base URL for the Obsidian Local REST API
`filename`	string	是	Path to the note relative to vault root (e.g. "folder/note.md")

输出

参数	类型	描述
`content`	string	Markdown content of the note
`filename`	string	Path to the note

`obsidian_get_periodic_note`

Retrieve the current periodic note (daily, weekly, monthly, quarterly, or yearly)

输入

参数	类型	必填	描述
`apiKey`	string	是	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	是	Base URL for the Obsidian Local REST API
`period`	string	是	Period type: daily, weekly, monthly, quarterly, or yearly

输出

参数	类型	描述
`content`	string	Markdown content of the periodic note
`period`	string	Period type of the note

`obsidian_list_commands`

List all available commands in Obsidian

输入

参数	类型	必填	描述
`apiKey`	string	是	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	是	Base URL for the Obsidian Local REST API

输出

参数	类型	描述
`commands`	json	List of available commands with IDs and names
↳ `id`	string	Command identifier
↳ `name`	string	Human-readable command name

`obsidian_list_files`

List files and directories in your Obsidian vault

输入

参数	类型	必填	描述
`apiKey`	string	是	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	是	Base URL for the Obsidian Local REST API
`path`	string	否	Directory path relative to vault root. Leave empty to list root.

输出

参数	类型	描述
`files`	json	List of files and directories
↳ `path`	string	File or directory path
↳ `type`	string	Whether the entry is a file or directory

`obsidian_open_file`

Open a file in the Obsidian UI (creates the file if it does not exist)

输入

参数	类型	必填	描述
`apiKey`	string	是	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	是	Base URL for the Obsidian Local REST API
`filename`	string	是	Path to the file relative to vault root
`newLeaf`	boolean	否	Whether to open the file in a new leaf/tab

输出

参数	类型	描述
`filename`	string	Path of the opened file
`opened`	boolean	Whether the file was successfully opened

`obsidian_patch_active`

Insert or replace content at a specific heading, block reference, or frontmatter field in the active file

输入

参数	类型	必填	描述
`apiKey`	string	是	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	是	Base URL for the Obsidian Local REST API
`content`	string	是	Content to insert at the target location
`operation`	string	是	How to insert content: append, prepend, or replace
`targetType`	string	是	Type of target: heading, block, or frontmatter
`target`	string	是	Target identifier (heading text, block reference ID, or frontmatter field name)
`targetDelimiter`	string	否	Delimiter for nested headings (default: "::")
`trimTargetWhitespace`	boolean	否	Whether to trim whitespace from target before matching (default: false)

输出

参数	类型	描述
`patched`	boolean	Whether the active file was successfully patched

`obsidian_patch_note`

Insert or replace content at a specific heading, block reference, or frontmatter field in a note

输入

参数	类型	必填	描述
`apiKey`	string	是	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	是	Base URL for the Obsidian Local REST API
`filename`	string	是	Path to the note relative to vault root (e.g. "folder/note.md")
`content`	string	是	Content to insert at the target location
`operation`	string	是	How to insert content: append, prepend, or replace
`targetType`	string	是	Type of target: heading, block, or frontmatter
`target`	string	是	Target identifier (heading text, block reference ID, or frontmatter field name)
`targetDelimiter`	string	否	Delimiter for nested headings (default: "::")
`trimTargetWhitespace`	boolean	否	Whether to trim whitespace from target before matching (default: false)

输出

参数	类型	描述
`filename`	string	Path of the patched note
`patched`	boolean	Whether the note was successfully patched

`obsidian_search`

Search for text across notes in your Obsidian vault

输入

参数	类型	必填	描述
`apiKey`	string	是	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	是	Base URL for the Obsidian Local REST API
`query`	string	是	Text to search for across vault notes
`contextLength`	number	否	Number of characters of context around each match (default: 100)

输出

参数	类型	描述
`results`	json	Search results with filenames, scores, and matching contexts
↳ `filename`	string	Path to the matching note
↳ `score`	number	Relevance score
↳ `matches`	json	Matching text contexts
↳ `context`	string	Text surrounding the match

Obsidian

On this page