@cursor/bdk 0.2.4 → 0.2.6

package/templates/grokbot-agents/README.md

@@ -3,10 +3,7 @@
 Consults the Grok Bot agents you name. This agent stays in its own
 conversation and reports the reply.
 
-> **Docs ahead:** `@cursor/bdk` is not on npm yet. This command will work
-> after publication.
-
-```text
+```bash
 npx @cursor/bdk init ./grokbot --template grokbot-agents
 ```
 
@@ -15,12 +12,13 @@ with `--var agents="Plan Keeper, Chief of Staff"`.
 
 ## Run
 
-```text
+```bash
 bdk login
+bdk validate
 bdk dev
 ```
 
-In the playground, ask it to talk to one of the names you entered. A
+In the playground, ask it to consult one of the names you entered. A
 name outside the list is refused.
 
 ## Edit

package/templates/security-help/README.md

@@ -3,9 +3,6 @@
 Answers security questions in Slack from your skills and takes a first
 look when someone pastes a GitHub pull request.
 
-> **Docs ahead:** `@cursor/bdk` is not on npm yet. This command will work
-> after publication.
-
 ```text
 npx @cursor/bdk init ./security-help --template security-help
 ```
@@ -18,6 +15,18 @@ npx @cursor/bdk init ./security-help --template security-help
 ```text
 bdk login
 bdk slack create --name "Security Help" --channel-posts
+```
+
+The Slack app uses `SECURITY_HELP_SLACK_BOT_TOKEN` and
+`SECURITY_HELP_SLACK_APP_TOKEN`. `bdk slack create` writes both values
+to `.env.local`.
+
+To watch channel posts, add channel names or IDs to `watch` in
+`bot/channels/slack.ts`, then invite the app to each channel. An empty
+`watch` keeps channel-post dispatch off. Mentions and DMs work without
+this configuration.
+
+```bash
 bdk dev
 ```
 
@@ -34,7 +43,4 @@ one in the playground.
 - `bot/skills/`: how to look at a PR, a leak, or an access ask
 - `bot/instructions.md`: routing
 
-`--channel-posts` is required to watch channels. Mentions and DMs work
-without it.
-
 `bdk eval` runs three smoke turns and writes nothing to Slack or GitHub.

package/templates/security-reviewer/README.md

@@ -2,15 +2,14 @@
 
 Reviews pull requests for exploitable bugs. Posts one review comment.
 
-> **Docs ahead:** `@cursor/bdk` is not on npm yet. This command will work
-> after publication.
-
 ```text
-npx @cursor/bdk init ./security-reviewer --template security-reviewer
+npx @cursor/bdk init ./security-reviewer --template security-reviewer \
+  --var repos=owner/repo
 ```
 
-`init` asks which repos to watch. Skip the prompt with
-`--var repos=owner/repo`.
+`--var repos` must name a repository already connected in Cursor for
+your account. Separate multiple repositories with commas; they must
+share one owner.
 
 ## Run
 

package/templates/security-reviewer/bot/tools/post_findings.ts

@@ -1,6 +1,6 @@
 import { readFile } from "node:fs/promises";
 import { join } from "node:path";
-import { parseGitHubPrRef } from "@cursor/bdk/channels/github";
+import { parseGitHubPrContinuationKey } from "@cursor/bdk/channels/github";
 import { defineTool } from "@cursor/bdk/tools";
 import { z } from "zod";
 
@@ -26,13 +26,9 @@ export default defineTool({
     if (ctx.session.purpose === "eval") {
       return { posted: false, reason: "eval" };
     }
-    const key = ctx.session.continuationKey ?? "";
-    if (!key.startsWith("github-pr:")) {
-      throw new Error("post_findings requires a GitHub pull request session");
-    }
-    const ref = parseGitHubPrRef(key.slice("github-pr:".length));
+    const ref = parseGitHubPrContinuationKey(ctx.session.continuationKey ?? "");
     if (ref === undefined) {
-      throw new Error(`unrecognized PR: ${key}`);
+      throw new Error("post_findings requires a GitHub pull request session");
     }
     const headSha = (await readFile(join(ctx.workspaceDir, "pr/head.sha"), "utf8")).trim();
     if (!SHA.test(headSha)) {
@@ -47,7 +43,11 @@ export default defineTool({
       body: reviewBody(findings),
       event: "COMMENT",
     });
-    return { posted: true, pr: ref.label, url: response.data.html_url };
+    return {
+      posted: true,
+      pr: `${ref.owner}/${ref.repo}#${ref.number}`,
+      url: response.data.html_url,
+    };
   },
 });
 

package/templates/thermo-quality-review/README.md

@@ -2,9 +2,6 @@
 
 Reviews pull requests for structural code quality. Posts one review comment.
 
-> **Docs ahead:** `@cursor/bdk` is not on npm yet. This command will work
-> after publication.
-
 ```text
 npx @cursor/bdk init ./thermo-quality-review --template thermo-quality-review
 ```

package/templates/thermo-quality-review/bot/tools/post_findings.ts

@@ -1,6 +1,6 @@
 import { readFile } from "node:fs/promises";
 import { join } from "node:path";
-import { parseGitHubPrRef } from "@cursor/bdk/channels/github";
+import { parseGitHubPrContinuationKey } from "@cursor/bdk/channels/github";
 import { defineTool } from "@cursor/bdk/tools";
 import { z } from "zod";
 
@@ -25,13 +25,9 @@ export default defineTool({
     if (ctx.session.purpose === "eval") {
       return { posted: false, reason: "eval" };
     }
-    const key = ctx.session.continuationKey ?? "";
-    if (!key.startsWith("github-pr:")) {
-      throw new Error("post_findings requires a GitHub pull request session");
-    }
-    const ref = parseGitHubPrRef(key.slice("github-pr:".length));
+    const ref = parseGitHubPrContinuationKey(ctx.session.continuationKey ?? "");
     if (ref === undefined) {
-      throw new Error(`unrecognized PR: ${key}`);
+      throw new Error("post_findings requires a GitHub pull request session");
     }
     const headSha = (await readFile(join(ctx.workspaceDir, "pr/head.sha"), "utf8")).trim();
     if (!SHA.test(headSha)) {
@@ -46,7 +42,11 @@ export default defineTool({
       body: reviewBody(findings),
       event: "COMMENT",
     });
-    return { posted: true, pr: ref.label, url: response.data.html_url };
+    return {
+      posted: true,
+      pr: `${ref.owner}/${ref.repo}#${ref.number}`,
+      url: response.data.html_url,
+    };
   },
 });
 

package/templates/thermo-review/README.md

@@ -2,9 +2,6 @@
 
 Reviews pull requests for bugs and breakage. Posts one review comment.
 
-> **Docs ahead:** `@cursor/bdk` is not on npm yet. This command will work
-> after publication.
-
 ```text
 npx @cursor/bdk init ./thermo-review --template thermo-review
 ```

package/templates/thermo-review/bot/tools/post_findings.ts

@@ -1,6 +1,6 @@
 import { readFile } from "node:fs/promises";
 import { join } from "node:path";
-import { parseGitHubPrRef } from "@cursor/bdk/channels/github";
+import { parseGitHubPrContinuationKey } from "@cursor/bdk/channels/github";
 import { defineTool } from "@cursor/bdk/tools";
 import { z } from "zod";
 
@@ -25,13 +25,9 @@ export default defineTool({
     if (ctx.session.purpose === "eval") {
       return { posted: false, reason: "eval" };
     }
-    const key = ctx.session.continuationKey ?? "";
-    if (!key.startsWith("github-pr:")) {
-      throw new Error("post_findings requires a GitHub pull request session");
-    }
-    const ref = parseGitHubPrRef(key.slice("github-pr:".length));
+    const ref = parseGitHubPrContinuationKey(ctx.session.continuationKey ?? "");
     if (ref === undefined) {
-      throw new Error(`unrecognized PR: ${key}`);
+      throw new Error("post_findings requires a GitHub pull request session");
     }
     const headSha = (await readFile(join(ctx.workspaceDir, "pr/head.sha"), "utf8")).trim();
     if (!SHA.test(headSha)) {
@@ -46,7 +42,11 @@ export default defineTool({
       body: reviewBody(findings),
       event: "COMMENT",
     });
-    return { posted: true, pr: ref.label, url: response.data.html_url };
+    return {
+      posted: true,
+      pr: `${ref.owner}/${ref.repo}#${ref.number}`,
+      url: response.data.html_url,
+    };
   },
 });
 

package/templates/triage/README.md

@@ -4,9 +4,6 @@ Comments on existing Linear or Jira issues. Classifies the ticket, writes
 the next step, links a duplicate, and sets bug priority when the
 connector can.
 
-> **Docs ahead:** `@cursor/bdk` is not on npm yet. This command will work
-> after publication.
-
 ```text
 npx @cursor/bdk init ./my-triage-agent --template triage-linear
 npx @cursor/bdk init ./my-triage-agent --template triage-jira

package/templates/triage/overlays/jira/README.md

@@ -2,9 +2,6 @@
 
 Comments on existing Jira issues. Scaffold with:
 
-> **Docs ahead:** `@cursor/bdk` is not on npm yet. This command will work
-> after publication.
-
 ```text
 npx @cursor/bdk init ./my-triage-agent --template triage-jira
 ```

package/templates/triage/overlays/linear/README.md

@@ -2,9 +2,6 @@
 
 Comments on existing Linear issues. Scaffold with:
 
-> **Docs ahead:** `@cursor/bdk` is not on npm yet. This command will work
-> after publication.
-
 ```text
 npx @cursor/bdk init ./my-triage-agent --template triage-linear
 ```