Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| OBSIDIAN_API_KEY | Yes | Your API key for the Obsidian REST API. This key can be found in the Obsidian plugin config. |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| obsidian_list_files_in_dir | Lists all files and directories that exist in a specific Obsidian directory. |
| obsidian_list_files_in_vault | Lists all files and directories in the root directory of your Obsidian vault. |
| obsidian_get_file_contents | Return the content of a single file in your vault. |
| obsidian_simple_search | Simple search for documents matching a specified text query across all files in the vault. Use this tool when you want to do a simple text search |
| obsidian_patch_content | Insert content into an existing note relative to a heading, block reference, or frontmatter field. |
| obsidian_append_content | Append content to a new or existing file in the vault. |
| obsidian_put_content | Create a new file in your vault or update the content of an existing one in your vault. |
| obsidian_delete_file | Delete a file or directory from the vault. |
| obsidian_complex_search | Complex search for documents using a JsonLogic query. Supports standard JsonLogic operators plus 'glob' and 'regexp' for pattern matching. Results must be non-falsy. Use this tool when you want to do a complex search, e.g. for all documents with certain tags etc.
ALWAYS follow query syntax in examples.
Examples
1. Match all markdown files
{"glob": ["*.md", {"var": "path"}]}
2. Match all markdown files with 1221 substring inside them
{
"and": [
{ "glob": ["*.md", {"var": "path"}] },
{ "regexp": [".*1221.*", {"var": "content"}] }
]
}
3. Match all markdown files in Work folder containing name Keaton
{
"and": [
{ "glob": ["*.md", {"var": "path"}] },
{ "regexp": [".*Work.*", {"var": "path"}] },
{ "regexp": ["Keaton", {"var": "content"}] }
]
}
|
| obsidian_batch_get_file_contents | Return the contents of multiple files in your vault, concatenated with headers. |
| obsidian_get_periodic_note | Get current periodic note for the specified period. |
| obsidian_get_recent_periodic_notes | Get most recent periodic notes for the specified period type. |
| obsidian_get_recent_changes | Get recently modified files in the vault. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |