Obsidian

Instructions d'utilisation

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.

Outils

`obsidian_append_active`

Append content to the currently active file in Obsidian

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	Oui	Base URL for the Obsidian Local REST API
`content`	string	Oui	Markdown content to append to the active file

Sortie

Paramètre	Type	Description
`appended`	boolean	Whether content was successfully appended

`obsidian_append_note`

Append content to an existing note in your Obsidian vault

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	Oui	Base URL for the Obsidian Local REST API
`filename`	string	Oui	Path to the note relative to vault root (e.g. "folder/note.md")
`content`	string	Oui	Markdown content to append to the note

Sortie

Paramètre	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.

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	Oui	Base URL for the Obsidian Local REST API
`period`	string	Oui	Period type: daily, weekly, monthly, quarterly, or yearly
`content`	string	Oui	Markdown content to append to the periodic note

Sortie

Paramètre	Type	Description
`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

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	Oui	Base URL for the Obsidian Local REST API
`filename`	string	Oui	Path for the note relative to vault root (e.g. "folder/note.md")
`content`	string	Oui	Markdown content for the note

Sortie

Paramètre	Type	Description
`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

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	Oui	Base URL for the Obsidian Local REST API
`filename`	string	Oui	Path to the note to delete relative to vault root

Sortie

Paramètre	Type	Description
`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)

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	Oui	Base URL for the Obsidian Local REST API
`commandId`	string	Oui	ID of the command to execute (use List Commands operation to discover available commands)

Sortie

Paramètre	Type	Description
`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

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	Oui	Base URL for the Obsidian Local REST API

Sortie

Paramètre	Type	Description
`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

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	Oui	Base URL for the Obsidian Local REST API
`filename`	string	Oui	Path to the note relative to vault root (e.g. "folder/note.md")

Sortie

Paramètre	Type	Description
`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)

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	Oui	Base URL for the Obsidian Local REST API
`period`	string	Oui	Period type: daily, weekly, monthly, quarterly, or yearly

Sortie

Paramètre	Type	Description
`content`	string	Markdown content of the periodic note
`period`	string	Period type of the note

`obsidian_list_commands`

List all available commands in Obsidian

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	Oui	Base URL for the Obsidian Local REST API

Sortie

Paramètre	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`

List files and directories in your Obsidian vault

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	Oui	Base URL for the Obsidian Local REST API
`path`	string	Non	Directory path relative to vault root. Leave empty to list root.

Sortie

Paramètre	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`

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

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	Oui	Base URL for the Obsidian Local REST API
`filename`	string	Oui	Path to the file relative to vault root
`newLeaf`	boolean	Non	Whether to open the file in a new leaf/tab

Sortie

Paramètre	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

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	Oui	Base URL for the Obsidian Local REST API
`content`	string	Oui	Content to insert at the target location
`operation`	string	Oui	How to insert content: append, prepend, or replace
`targetType`	string	Oui	Type of target: heading, block, or frontmatter
`target`	string	Oui	Target identifier (heading text, block reference ID, or frontmatter field name)
`targetDelimiter`	string	Non	Delimiter for nested headings (default: "::")
`trimTargetWhitespace`	boolean	Non	Whether to trim whitespace from target before matching (default: false)

Sortie

Paramètre	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

Entrée

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

Sortie

Paramètre	Type	Description
`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

Entrée

Paramètre	Type	Obligatoire	Description
`apiKey`	string	Oui	API key from Obsidian Local REST API plugin settings
`baseUrl`	string	Oui	Base URL for the Obsidian Local REST API
`query`	string	Oui	Text to search for across vault notes
`contextLength`	number	Non	Number of characters of context around each match (default: 100)

Sortie

Paramètre	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