Obsidian

Usage Instructions

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.

Tools

`obsidian_append_active`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`content`	string	Yes	No description

Output

Parameter	Type	Description
`appended`	boolean	Whether content was successfully appended

`obsidian_append_note`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`filename`	string	Yes	Path to the note relative to vault root (e.g. "folder/note.md")
`content`	string	Yes	No description

Output

Parameter	Type	Description
`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.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`period`	string	Yes	No description
`content`	string	Yes	No description

Output

Parameter	Type	Description
`period`	string	Period type of the note
`appended`	boolean	Whether content was successfully appended

`obsidian_create_note`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`filename`	string	Yes	Path for the note relative to vault root (e.g. "folder/note.md")
`content`	string	Yes	No description

Output

Parameter	Type	Description
`filename`	string	Path of the created note
`created`	boolean	Whether the note was successfully created

`obsidian_delete_note`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`filename`	string	Yes	No description

Output

Parameter	Type	Description
`filename`	string	Path of the deleted note
`deleted`	boolean	Whether the note was successfully deleted

`obsidian_execute_command`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`commandId`	string	Yes	ID of the command to execute (use List Commands operation to discover available commands)

Output

Parameter	Type	Description
`commandId`	string	ID of the executed command
`executed`	boolean	Whether the command was successfully executed

`obsidian_get_active`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description

Output

Parameter	Type	Description
`content`	string	Markdown content of the active file
`filename`	string	Path to the active file

`obsidian_get_note`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`filename`	string	Yes	Path to the note relative to vault root (e.g. "folder/note.md")

Output

Parameter	Type	Description
`content`	string	Markdown content of the note
`filename`	string	Path to the note

`obsidian_get_periodic_note`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`period`	string	Yes	No description

Output

Parameter	Type	Description
`content`	string	Markdown content of the periodic note
`period`	string	Period type of the note

`obsidian_list_commands`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description

Output

Parameter	Type	Description
`commands`	json	List of available commands with IDs and names
↳ `id`	string	Command identifier
↳ `name`	string	Human-readable command name

`obsidian_list_files`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`path`	string	No	No description

Output

Parameter	Type	Description
`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`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`filename`	string	Yes	No description
`newLeaf`	boolean	No	No description

Output

Parameter	Type	Description
`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

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`content`	string	Yes	No description
`operation`	string	Yes	No description
`targetType`	string	Yes	No description
`target`	string	Yes	Target identifier (heading text, block reference ID, or frontmatter field name)
`targetDelimiter`	string	No	Delimiter for nested headings (default: "::")
`trimTargetWhitespace`	boolean	No	No description

Output

Parameter	Type	Description
`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

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`filename`	string	Yes	Path to the note relative to vault root (e.g. "folder/note.md")
`content`	string	Yes	No description
`operation`	string	Yes	No description
`targetType`	string	Yes	No description
`target`	string	Yes	Target identifier (heading text, block reference ID, or frontmatter field name)
`targetDelimiter`	string	No	Delimiter for nested headings (default: "::")
`trimTargetWhitespace`	boolean	No	No description

Output

Parameter	Type	Description
`filename`	string	Path of the patched note
`patched`	boolean	Whether the note was successfully patched

`obsidian_search`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`baseUrl`	string	Yes	No description
`query`	string	Yes	No description
`contextLength`	number	No	No description

Output

Parameter	Type	Description
`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