aboutsummaryrefslogtreecommitdiffstats
path: root/docs/versioned_docs/version-v0.24.0/09-mcp.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/versioned_docs/version-v0.24.0/09-mcp.md')
-rw-r--r--docs/versioned_docs/version-v0.24.0/09-mcp.md65
1 files changed, 65 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.24.0/09-mcp.md b/docs/versioned_docs/version-v0.24.0/09-mcp.md
new file mode 100644
index 00000000..8b86f96a
--- /dev/null
+++ b/docs/versioned_docs/version-v0.24.0/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)