From 725516d81296a392706fa03c84c62e11714ae4da Mon Sep 17 00:00:00 2001 From: Markus Pfundstein Date: Fri, 29 Nov 2024 14:05:05 +0100 Subject: [PATCH] more info --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a0fc2ba..83b6bc9 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,28 @@ # mcp-knowledge-base MCP server -Example MCP server to interact with Obsidian vaults. +Example MCP server to interact with Obsidian. ## Components ### Tools -The server implements two tools: +The server implements multiple tools to interact with Obsidian: - list_files_in_vault: Lists all files and directories in the root directory of your Obsidian vault - - Takes no arguments - - Returns a JSON list of files and directories - list_files_in_dir: Lists all files and directories in a specific Obsidian directory - - Takes "dirpath" as a string argument - - Returns a JSON list of files and directories in the specified path +- get_file_contents: Return the content of a single file in your vault. ### Example prompts +Its good to first instruct Claude to use Obsidian. Then it will always call the tool. + - List all files in my vault - List all files in the XYZ directory -- Get the contents of the last architecture call note +- Get the contents of the last architecture call note and summarize them ## Configuration + + ### Environment Variables Create a `.env` file in the root directory with the following required variable: @@ -36,6 +37,12 @@ Without this API key, the server will not be able to function. ### Install +#### Obsidian REST API + +You need the Obsidian REST API community plugin running: https://github.com/coddingtonbear/obsidian-local-rest-api + +Install and enable it in the settings and copy the api key. + #### Claude Desktop On MacOS: `~/Library/Application\ Support/Claude/claude_desktop_config.json`