Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| VAULT_PATH | Yes | The absolute or relative path to the Obsidian vault to be accessed by the server. | |
| OBSIDIAN_ADDR | No | Environment variable or flag (--http) to run as an HTTP server on the specified address (e.g., :8080). | |
| ALLOWED_VAULTS | No | Comma-separated list of vault aliases defined via 'obx vault add' that the agent is permitted to switch to. | |
| DISABLED_TOOLS | No | Comma-separated list of tool groups to blacklist (e.g., 'manage-folders,bulk-operations'). | |
| ALLOW_VAULT_SWITCHING | No | Whether to allow the AI assistant to switch the active vault dynamically via the MCP protocol. |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
| logging | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| analyze-vault | Unified analytical tool to get vault stats, detect broken links, orphans, stubs, and outdated notes |
| bulk-operations | Unified bulk operational tool for tagging, moving, and updating frontmatter across multiple notes |
| edit-note | Unified tool for targeted text edits, section replacements, and batch edits |
| manage-canvas | Unified tool for reading, creating, and interacting with Canvas notes |
| manage-folders | Unified tool for listing, creating, and deleting folders |
| manage-frontmatter | Unified tool for manipulating note frontmatter properties, tags, aliases, and inline fields |
| manage-links | Unified tool covering backlinks, forward-links, and AI link suggestions for notes |
| manage-mocs | Unified tool to discover and generate Maps of Content (MOCs) and folder indices |
| manage-notes | Unified tool for listing, reading, writing, moving, deleting, renaming, and appending to notes |
| manage-periodic-notes | Unified tool for getting, creating, and listing daily, weekly, monthly, and yearly periodic notes |
| manage-tasks | Unified tool for finding, toggling, and completing checkbox tasks across the vault |
| manage-templates | Unified tool for listing, retrieving, and applying markdown templates |
| read-batch | Unified tool for reading batches of notes, specific headings, sections, or generated summaries |
| refactor-notes | Unified tool for structural note refactoring: split notes by heading, merge multiple notes, and extract sections to new notes |
| search-vault | Unified search tool spanning text query, advanced block search, regex, dates, tags, inline-fields, and frontmatter queries |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |