aboutsummaryrefslogtreecommitdiffstats
path: root/apps/mcp/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'apps/mcp/README.md')
-rw-r--r--apps/mcp/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/apps/mcp/README.md b/apps/mcp/README.md
new file mode 100644
index 00000000..d59bb894
--- /dev/null
+++ b/apps/mcp/README.md
@@ -0,0 +1,34 @@
+# Karakeep MCP Server
+
+This is the Karakeep MCP server, which is a server that can be used to interact with Karakeep from other tools.
+
+## Supported Tools
+
+- Searching bookmarks
+- Adding and removing bookmarks from lists
+- Attaching and detaching tags to bookmarks
+- Creating new lists
+- Creating text and URL bookmarks
+
+Currently, the MCP server only exposes tools (no resources).
+
+## Usage with Claude Desktop
+
+
+```
+{
+ "mcpServers": {
+ "karakeep": {
+ "command": "npx",
+ "args": [
+ "@karakeep/mcp",
+ ],
+ "env": {
+ "KARAKEEP_API_ADDR": "https://<YOUR_SERVER_ADDR>",
+ "KARAKEEP_API_KEY": "<YOUR_TOKEN>"
+ }
+ }
+ }
+}
+```
+