From c81e7bae942291d8c7b39495ed8c4caf646c5992 Mon Sep 17 00:00:00 2001
From: Mohamed Bassem <me@mbassem.com>
Date: Sun, 27 Apr 2025 19:10:44 +0000
Subject: docs: Add docs about the MCP server

---
 apps/mcp/README.md        |   2 --
 docs/docs/09-mcp.md       |  65 ++++++++++++++++++++++++++++++++++++++++++++++
 docs/static/img/mcp-1.gif | Bin 0 -> 805787 bytes
 docs/static/img/mcp-2.gif | Bin 0 -> 1704069 bytes
 docs/static/img/mcp-3.gif | Bin 0 -> 3601217 bytes
 5 files changed, 65 insertions(+), 2 deletions(-)
 create mode 100644 docs/docs/09-mcp.md
 create mode 100644 docs/static/img/mcp-1.gif
 create mode 100644 docs/static/img/mcp-2.gif
 create mode 100644 docs/static/img/mcp-3.gif

diff --git a/apps/mcp/README.md b/apps/mcp/README.md
index 150aae78..0d134c34 100644
--- a/apps/mcp/README.md
+++ b/apps/mcp/README.md
@@ -42,8 +42,6 @@ From Docker:
       "command": "docker",
       "args": [
         "run",
-        "-p",
-        "3000:3000",
         "-e",
         "KARAKEEP_API_ADDR=https://<YOUR_SERVER_ADDR>",
         "-e",
diff --git a/docs/docs/09-mcp.md b/docs/docs/09-mcp.md
new file mode 100644
index 00000000..8b86f96a
--- /dev/null
+++ b/docs/docs/09-mcp.md
@@ -0,0 +1,65 @@
+# Model Context Protocol Server (MCP)
+
+Karakeep comes with a Model Context Protocol server that can be used to interact with it through LLMs.
+
+## Supported Tools
+
+- Searching bookmarks
+- Adding and removing bookmarks from lists
+- Attaching and detaching tags to bookmarks
+- Creating new lists
+- Creating text and URL bookmarks
+
+
+## Usage with Claude Desktop
+
+From NPM:
+
+```json
+{
+  "mcpServers": {
+    "karakeep": {
+      "command": "npx",
+      "args": [
+        "@karakeep/mcp",
+      ],
+      "env": {
+        "KARAKEEP_API_ADDR": "https://<YOUR_SERVER_ADDR>",
+        "KARAKEEP_API_KEY": "<YOUR_TOKEN>"
+      }
+    }
+  }
+}
+```
+
+From Docker:
+
+```json
+{
+  "mcpServers": {
+    "karakeep": {
+      "command": "docker",
+      "args": [
+        "run",
+        "-e",
+        "KARAKEEP_API_ADDR=https://<YOUR_SERVER_ADDR>",
+        "-e",
+        "KARAKEEP_API_KEY=<YOUR_TOKEN>",
+        "ghcr.io/karakeep-app/karakeep-mcp:latest"
+      ]
+    }
+  }
+}
+```
+
+
+### Demo
+
+#### Search
+![mcp-1](/img/mcp-1.gif)
+
+#### Adding Text Bookmarks
+![mcp-2](/img/mcp-2.gif)
+
+#### Adding URL Bookmarks
+![mcp-2](/img/mcp-3.gif)
diff --git a/docs/static/img/mcp-1.gif b/docs/static/img/mcp-1.gif
new file mode 100644
index 00000000..ddb34a1d
Binary files /dev/null and b/docs/static/img/mcp-1.gif differ
diff --git a/docs/static/img/mcp-2.gif b/docs/static/img/mcp-2.gif
new file mode 100644
index 00000000..18b2c11d
Binary files /dev/null and b/docs/static/img/mcp-2.gif differ
diff --git a/docs/static/img/mcp-3.gif b/docs/static/img/mcp-3.gif
new file mode 100644
index 00000000..555ac3e5
Binary files /dev/null and b/docs/static/img/mcp-3.gif differ
-- 
cgit v1.2.3-70-g09d2