aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMohamed Bassem <me@mbassem.com>2025-04-27 19:10:44 +0000
committerMohamed Bassem <me@mbassem.com>2025-04-27 19:10:44 +0000
commitc81e7bae942291d8c7b39495ed8c4caf646c5992 (patch)
treeb0e2e813da2e3ebc59e453113a7f3f8e289a9b7c /docs
parent6178736d64180f9bc8954099c90d54aa2f9f35f5 (diff)
downloadkarakeep-c81e7bae942291d8c7b39495ed8c4caf646c5992.tar.zst
docs: Add docs about the MCP server
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/09-mcp.md65
-rw-r--r--docs/static/img/mcp-1.gifbin0 -> 805787 bytes
-rw-r--r--docs/static/img/mcp-2.gifbin0 -> 1704069 bytes
-rw-r--r--docs/static/img/mcp-3.gifbin0 -> 3601217 bytes
4 files changed, 65 insertions, 0 deletions
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
--- /dev/null
+++ b/docs/static/img/mcp-1.gif
Binary files differ
diff --git a/docs/static/img/mcp-2.gif b/docs/static/img/mcp-2.gif
new file mode 100644
index 00000000..18b2c11d
--- /dev/null
+++ b/docs/static/img/mcp-2.gif
Binary files differ
diff --git a/docs/static/img/mcp-3.gif b/docs/static/img/mcp-3.gif
new file mode 100644
index 00000000..555ac3e5
--- /dev/null
+++ b/docs/static/img/mcp-3.gif
Binary files differ