From 8b0aa6ee3c975eac0c9993920c3869bee142f64b Mon Sep 17 00:00:00 2001 From: Maor Izenberg Date: Mon, 16 Nov 2026 17:21:01 +0200 Subject: [PATCH 1/7] docs: explain Cursor plugin installation and configuration --- integrations/cursor/README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/integrations/cursor/README.md b/integrations/cursor/README.md index e1e7129..d4c6872 100644 --- a/integrations/cursor/README.md +++ b/integrations/cursor/README.md @@ -18,6 +18,21 @@ npm run build:plugin The built plugin is in `cursor-plugin/`. Its launchers find a compatible JavaScript runtime on the machine or in Cursor. +## Install from the repository + +1. In Cursor, open **Customize** and choose **Add from Repo**. +2. Enter + `https://github.com/Deepkeepai/deepkeep-integrations/tree/main/integrations/cursor`. + If Cursor requires a repository URL, use + `https://github.com/Deepkeepai/deepkeep-integrations` instead. +3. Select the DeepKeep plugin and install it. +4. In Cursor chat, run `/deepkeep-connect` and follow the configuration + instructions. Enter your API key privately, outside chat and agent tools. +5. Fully quit and reopen Cursor. + +The repository's root `.cursor-plugin/marketplace.json` identifies the plugin +in `integrations/cursor/cursor-plugin/` for marketplace imports. + ## Local installation Run `npm run install:plugin`, then fully quit and reopen Cursor. The command @@ -38,10 +53,13 @@ Create `~/.deepkeep/config.json` with your DeepKeep endpoint and API key: { "firewallUrl": "https://api..deepkeep.ai/api/v2/developer-agent/validate", "apiKey": "", - "failMode": "block" + "failMode": "block", + "timeoutMs": 2500, + "cacheTtlMs": 300000 } ``` +An optional `bearerToken` can also be supplied. Keep all credentials private. Create the directory with permissions `0700` and the file with permissions `0600`. Enter the key privately, outside Cursor chat and agent tools. @@ -50,6 +68,10 @@ The file takes precedence over environment variables for `firewallUrl`, `apiKey` configuration when it runs, so changing the endpoint or key does not require a rebuild. +The environment variables `DEEPKEEP_TIMEOUT_MS` and `DEEPKEEP_CACHE_TTL_MS` +take precedence over the corresponding file values. `cacheTtlMs` defaults to +300,000 ms, but the current plugin does not use it or cache policy decisions. + `failMode` defaults to `block`. With `allow`, an action can proceed unchecked when validation fails. Hook inputs over 5 MiB follow this setting. The API truncates serialized payloads over 32,768 characters before inspection, so a From 4b202c50140f4ea98887242177337746bed01865 Mon Sep 17 00:00:00 2001 From: Maor Izenberg Date: Mon, 16 Nov 2026 17:23:00 +0200 Subject: [PATCH 2/7] docs: add Cursor team marketplace instructions --- integrations/cursor/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/integrations/cursor/README.md b/integrations/cursor/README.md index d4c6872..38d636e 100644 --- a/integrations/cursor/README.md +++ b/integrations/cursor/README.md @@ -33,6 +33,24 @@ JavaScript runtime on the machine or in Cursor. The repository's root `.cursor-plugin/marketplace.json` identifies the plugin in `integrations/cursor/cursor-plugin/` for marketplace imports. +## Install from a team marketplace + +A Cursor team administrator can make the plugin available to the team: + +1. Open the [Cursor Plugins & MCPs dashboard](https://cursor.com/dashboard/plugins). +2. Under **Team Marketplaces**, choose **Add Marketplace**, then + **Import from Repo**. +3. Enter `https://github.com/Deepkeepai/deepkeep-integrations` and follow the + prompts to add the marketplace. +4. Verify the marketplace and its DeepKeep plugin appear in the dashboard. + Set marketplace access and the plugin installation mode for your team. + +Team members can then open **Customize** in Cursor and install the DeepKeep +plugin if it is not installed automatically. Follow the +[plugin configuration guide](cursor-plugin/README.md#configuration), or run +`/deepkeep-connect` in Cursor chat. Enter your API key privately, outside chat +and agent tools, then fully quit and reopen Cursor. + ## Local installation Run `npm run install:plugin`, then fully quit and reopen Cursor. The command From de675baf32bf7a4efb70e43f47292f28a610811a Mon Sep 17 00:00:00 2001 From: Maor Izenberg Date: Mon, 16 Nov 2026 17:27:45 +0200 Subject: [PATCH 3/7] docs: clarify Cursor installation requirements --- integrations/cursor/README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/integrations/cursor/README.md b/integrations/cursor/README.md index 38d636e..3b1ef1f 100644 --- a/integrations/cursor/README.md +++ b/integrations/cursor/README.md @@ -23,8 +23,6 @@ JavaScript runtime on the machine or in Cursor. 1. In Cursor, open **Customize** and choose **Add from Repo**. 2. Enter `https://github.com/Deepkeepai/deepkeep-integrations/tree/main/integrations/cursor`. - If Cursor requires a repository URL, use - `https://github.com/Deepkeepai/deepkeep-integrations` instead. 3. Select the DeepKeep plugin and install it. 4. In Cursor chat, run `/deepkeep-connect` and follow the configuration instructions. Enter your API key privately, outside chat and agent tools. @@ -35,7 +33,8 @@ in `integrations/cursor/cursor-plugin/` for marketplace imports. ## Install from a team marketplace -A Cursor team administrator can make the plugin available to the team: +Team marketplaces require a Cursor Teams or Enterprise plan. A Cursor team +administrator can make the plugin available to the team: 1. Open the [Cursor Plugins & MCPs dashboard](https://cursor.com/dashboard/plugins). 2. Under **Team Marketplaces**, choose **Add Marketplace**, then From 22d4a72370fec7413d096ca14ad56d0753b25f70 Mon Sep 17 00:00:00 2001 From: Maor Izenberg Date: Mon, 16 Nov 2026 17:39:27 +0200 Subject: [PATCH 4/7] docs: remove marketplace implementation detail --- integrations/cursor/README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/integrations/cursor/README.md b/integrations/cursor/README.md index 3b1ef1f..b0a6445 100644 --- a/integrations/cursor/README.md +++ b/integrations/cursor/README.md @@ -28,9 +28,6 @@ JavaScript runtime on the machine or in Cursor. instructions. Enter your API key privately, outside chat and agent tools. 5. Fully quit and reopen Cursor. -The repository's root `.cursor-plugin/marketplace.json` identifies the plugin -in `integrations/cursor/cursor-plugin/` for marketplace imports. - ## Install from a team marketplace Team marketplaces require a Cursor Teams or Enterprise plan. A Cursor team From 87aa872c5e09e770ce2361cce944fcfe6b88eb21 Mon Sep 17 00:00:00 2001 From: Maor Izenberg Date: Mon, 16 Nov 2026 17:46:54 +0200 Subject: [PATCH 5/7] docs: clarify initial setup and doctor command --- integrations/cursor/README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/integrations/cursor/README.md b/integrations/cursor/README.md index b0a6445..ee5c94a 100644 --- a/integrations/cursor/README.md +++ b/integrations/cursor/README.md @@ -24,8 +24,9 @@ JavaScript runtime on the machine or in Cursor. 2. Enter `https://github.com/Deepkeepai/deepkeep-integrations/tree/main/integrations/cursor`. 3. Select the DeepKeep plugin and install it. -4. In Cursor chat, run `/deepkeep-connect` and follow the configuration - instructions. Enter your API key privately, outside chat and agent tools. +4. Configure the plugin as described in [Configuration](#configuration). + Once configured, you can run `/deepkeep-connect` in Cursor chat for + configuration guidance. 5. Fully quit and reopen Cursor. ## Install from a team marketplace @@ -43,9 +44,10 @@ administrator can make the plugin available to the team: Team members can then open **Customize** in Cursor and install the DeepKeep plugin if it is not installed automatically. Follow the -[plugin configuration guide](cursor-plugin/README.md#configuration), or run -`/deepkeep-connect` in Cursor chat. Enter your API key privately, outside chat -and agent tools, then fully quit and reopen Cursor. +[plugin configuration guide](cursor-plugin/README.md#configuration). Once +configured, you can run `/deepkeep-connect` in Cursor chat for guidance. Enter +your API key privately, outside chat and agent tools, then fully quit and reopen +Cursor. ## Local installation @@ -60,6 +62,7 @@ duplicate hooks. ## Configuration The plugin is free, but requires a paid DeepKeep API token to function. +Configure it before using chat: an unconfigured plugin blocks prompts by default. Create `~/.deepkeep/config.json` with your DeepKeep endpoint and API key: @@ -113,10 +116,10 @@ DeepKeep can delete data upon customer request. ## Check the connection -From the repository, run: +From the repository root, run: ```bash -node cursor-plugin/bin/cli.js doctor +node integrations/cursor/cursor-plugin/bin/cli.js doctor ``` This sends a test prompt to the configured policy endpoint. Hook decisions and From 9e6faf87ac6848677d84a92276b44ecdfef790ac Mon Sep 17 00:00:00 2001 From: Maor Izenberg Date: Mon, 16 Nov 2026 17:51:07 +0200 Subject: [PATCH 6/7] docs: explain initial configuration requirement --- integrations/cursor/README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/integrations/cursor/README.md b/integrations/cursor/README.md index ee5c94a..a78869d 100644 --- a/integrations/cursor/README.md +++ b/integrations/cursor/README.md @@ -24,9 +24,9 @@ JavaScript runtime on the machine or in Cursor. 2. Enter `https://github.com/Deepkeepai/deepkeep-integrations/tree/main/integrations/cursor`. 3. Select the DeepKeep plugin and install it. -4. Configure the plugin as described in [Configuration](#configuration). - Once configured, you can run `/deepkeep-connect` in Cursor chat for - configuration guidance. +4. Create the configuration file manually as described in + [Configuration](#configuration). Once configured, you can run + `/deepkeep-connect` in Cursor chat for configuration guidance. 5. Fully quit and reopen Cursor. ## Install from a team marketplace @@ -45,9 +45,9 @@ administrator can make the plugin available to the team: Team members can then open **Customize** in Cursor and install the DeepKeep plugin if it is not installed automatically. Follow the [plugin configuration guide](cursor-plugin/README.md#configuration). Once -configured, you can run `/deepkeep-connect` in Cursor chat for guidance. Enter -your API key privately, outside chat and agent tools, then fully quit and reopen -Cursor. +configured manually, you can run `/deepkeep-connect` in Cursor chat for +guidance. Enter your API key privately, outside chat and agent tools, then fully +quit and reopen Cursor. ## Local installation @@ -62,7 +62,10 @@ duplicate hooks. ## Configuration The plugin is free, but requires a paid DeepKeep API token to function. -Configure it before using chat: an unconfigured plugin blocks prompts by default. +Create the configuration file manually before using chat. The plugin checks +every prompt, including `/deepkeep-connect`, and blocks it by default if the +policy endpoint is not configured. The command provides guidance but does not +create the configuration file or handle your API key. Create `~/.deepkeep/config.json` with your DeepKeep endpoint and API key: From 6a24bbf9299568e3d10aae8d362a1cd3b90a35ab Mon Sep 17 00:00:00 2001 From: Maor Izenberg Date: Mon, 16 Nov 2026 17:51:48 +0200 Subject: [PATCH 7/7] docs: remove optional bearer token guidance --- integrations/cursor/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/integrations/cursor/README.md b/integrations/cursor/README.md index a78869d..3f97941 100644 --- a/integrations/cursor/README.md +++ b/integrations/cursor/README.md @@ -79,7 +79,6 @@ Create `~/.deepkeep/config.json` with your DeepKeep endpoint and API key: } ``` -An optional `bearerToken` can also be supplied. Keep all credentials private. Create the directory with permissions `0700` and the file with permissions `0600`. Enter the key privately, outside Cursor chat and agent tools.