Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| VAULT_DIR_PATH | Yes | The absolute path to your Obsidian vault directory |
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 |
|---|---|
| vault | Retrieves and searches the content of Markdown (.md, .mdx) documents stored in an Obsidian vault. Use this tool to find notes related to a specific topic or keyword and understand their core content. When to use:
Returns the content of the most relevant document(s) in text format. It can also include metadata such as the document's title, tags, and creation date. Requirements: The user's Obsidian Vault path must be correctly configured in an environment variable or a similar setting. For searches, use the exact filename or include core keywords for content-based queries. |
| generate_property | Analyzes the content of a specified Obsidian Markdown file to automatically generate the most suitable properties (frontmatter) and updates the file directly. Use Cases:
Parameters: filename: The name or path of the file to analyze and add properties to (e.g., "my-first-post.md"). overwrite: If set to true, existing properties will be overwritten by the AI-generated content. Default: false. Generated Properties: The AI analyzes the context of the content to generate the following properties:
Return Value: Upon success, returns a JSON object containing a success message that includes the modified filename. { "status": "success", "message": "Successfully updated properties for my-first-post.md" } Requirements: The user's absolute path to the Obsidian vault must be correctly set in an environment variable. |
| write_property | Description: Adds or updates properties within the frontmatter section at the top of a specified Obsidian markdown file. This tool is primarily used to apply metadata generated by the generate_obsidian_properties tool to an actual file. Parameters:
Example: JSON { "title": "Optimizing I/O Handling in a Serverless Environment", "date": "2025-04-03", "tags": ["serverless", "optimization"], "summary": "A case study on optimizing I/O in a serverless environment by benchmarking Promise.all and Workers.", "completed": true } Return Value: Upon successful execution, it returns a JSON object containing the status, a confirmation message, and the property object that was applied to the file. Example: JSON { "status": "success", "message": "Successfully updated properties for my-first-post.md", "properties": { "title": "Optimizing I/O Handling in a Serverless Environment", "date": "2025-04-03", "tags": ["serverless", "optimization"], "summary": "A case study on optimizing I/O in a serverless environment by benchmarking Promise.all and Workers.", "completed": true } } Dependencies & Requirements:
|
| create_document_with_properties | Initiates an integrated workflow to read a document, guide an AI to generate properties, and then write those properties to a file. This tool acts as a workflow manager for an AI agent. It reads the content of a specified document and returns a structured, multi-step plan. The AI agent must follow this plan by first calling the 'generate_obsidian_property' tool to get the document's content for analysis, and then, after generating the properties, calling the 'write_obsidian_property' tool to save them. Use this tool to start the end-to-end process of enriching a document with AI-generated metadata. |
| organize_attachments | Scans a specified markdown file for linked images (or other attachments), moves them to a dedicated folder named after the document's title, and updates the links within the markdown file automatically. Use Cases:
Example Workflow:
|
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |