diff options
| author | Chen Ye <cye@alumni.brown.edu> | 2026-02-08 16:07:31 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-02-09 00:07:31 +0000 |
| commit | 77b186c3a599297da0cf19e923c66607ad7d74e7 (patch) | |
| tree | e1dde00f39e6594499dd8e3fb9de3a9f1123e0ad /apps/mcp/README.md | |
| parent | fbe7e3a901862e5766662735a623a5a935c87c0b (diff) | |
| download | karakeep-77b186c3a599297da0cf19e923c66607ad7d74e7.tar.zst | |
feat(mcp): Support custom configurable HTTP headers (#2436)
* feat(mcp): Support custom configurable HTTP headers
* docs(mcp): Add KARAKEEP_CUSTOM_HEADERS documentation
* fix(mcp): Prioritize default headers and safely parse custom headers
* docs(mcp): Correct capitalization of Cloudflare headers
Diffstat (limited to 'apps/mcp/README.md')
| -rw-r--r-- | apps/mcp/README.md | 10 |
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" ] } |