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.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/apps/mcp/README.md b/apps/mcp/README.md
index 0d134c34..45b0d79f 100644
--- a/apps/mcp/README.md
+++ b/apps/mcp/README.md
@@ -1,6 +1,7 @@
# Karakeep MCP Server
-This is the Karakeep MCP server, which is a server that can be used to interact with Karakeep from other tools.
+This is the Karakeep MCP server, which is a server that can be used to interact
+with Karakeep from other tools.
## Supported Tools
@@ -22,11 +23,12 @@ From NPM:
"karakeep": {
"command": "npx",
"args": [
- "@karakeep/mcp",
+ "@karakeep/mcp"
],
"env": {
"KARAKEEP_API_ADDR": "https://<YOUR_SERVER_ADDR>",
- "KARAKEEP_API_KEY": "<YOUR_TOKEN>"
+ "KARAKEEP_API_KEY": "<YOUR_TOKEN>",
+ "KARAKEEP_CUSTOM_HEADERS": "{\"CF-Access-Client-Id\": \"...\", \"CF-Access-Client-Secret\": \"...\"}"
}
}
}
@@ -46,6 +48,8 @@ From Docker:
"KARAKEEP_API_ADDR=https://<YOUR_SERVER_ADDR>",
"-e",
"KARAKEEP_API_KEY=<YOUR_TOKEN>",
+ "-e",
+ "KARAKEEP_CUSTOM_HEADERS={\"CF-Access-Client-Id\": \"...\", \"CF-Access-Client-Secret\": \"...\"}",
"ghcr.io/karakeep-app/karakeep-mcp:latest"
]
}