diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-04-13 01:27:45 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2025-04-13 01:53:11 +0000 |
| commit | cf97bace33fdd14f29ce947d55d17cba8fa85c11 (patch) | |
| tree | 048a88eeabfcb1b1b32b2cd298c229e6c7082341 /apps/mcp/README.md | |
| parent | a39cd5f3c0a3e287652f945d203facab413b5b65 (diff) | |
| download | karakeep-cf97bace33fdd14f29ce947d55d17cba8fa85c11.tar.zst | |
feat: Add an MCP server for karakeep
Diffstat (limited to 'apps/mcp/README.md')
| -rw-r--r-- | apps/mcp/README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/apps/mcp/README.md b/apps/mcp/README.md new file mode 100644 index 00000000..d59bb894 --- /dev/null +++ b/apps/mcp/README.md @@ -0,0 +1,34 @@ +# Karakeep MCP Server + +This is the Karakeep MCP server, which is a server that can be used to interact with Karakeep from other tools. + +## Supported Tools + +- Searching bookmarks +- Adding and removing bookmarks from lists +- Attaching and detaching tags to bookmarks +- Creating new lists +- Creating text and URL bookmarks + +Currently, the MCP server only exposes tools (no resources). + +## Usage with Claude Desktop + + +``` +{ + "mcpServers": { + "karakeep": { + "command": "npx", + "args": [ + "@karakeep/mcp", + ], + "env": { + "KARAKEEP_API_ADDR": "https://<YOUR_SERVER_ADDR>", + "KARAKEEP_API_KEY": "<YOUR_TOKEN>" + } + } + } +} +``` + |