From 8494bdf83bb1eab0848a7294951bbf62d33d95a6 Mon Sep 17 00:00:00 2001 From: Markus Pfundstein Date: Thu, 5 Dec 2024 10:15:10 +0100 Subject: [PATCH] more info --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2432aac..a39e377 100644 --- a/README.md +++ b/README.md @@ -26,15 +26,32 @@ The use prompts like this: ## Configuration -### Environment Variables +### Obsidian REST API Key -Create a `.env` file in the root directory with the following required variable: +There are two ways to configure the environment with the Obsidian REST API Key. + +1. Add to server config (preferred) + +```json +{ + "mcp-obsidian": { + "command": "uvx", + "args": [ + "mcp-obsidian" + ], + "env": { + "OBSIDIAN_API_KEY":"" + } + } +``` + +2. Create a `.env` file in the working directory with the following required variable: ``` OBSIDIAN_API_KEY=your_api_key_here ``` -Without this API key, the server will not be able to function. +Note: You can find the key in the Obsidian plugin config. ## Quickstart