@grok/agent-sdk 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (227) hide show
  1. package/dist/channels/slack/slack-channel.d.ts.map +1 -1
  2. package/dist/channels/slack/slack-channel.js +27 -14
  3. package/dist/docs/404.html +2 -2
  4. package/dist/docs/assets/{app.BzTUBOAD.js → app.BSH__xV4.js} +4 -4
  5. package/dist/docs/assets/{building-with-agents.md.BqJ7AAjG.js → building-with-agents.md.Bo3ct-rf.js} +1 -1
  6. package/dist/docs/assets/changelog.md.b6H_ea44.js +1 -0
  7. package/dist/docs/assets/{changelog.md.BWhC6DET.lean.js → changelog.md.b6H_ea44.lean.js} +1 -1
  8. package/dist/docs/assets/chunks/@localSearchIndexroot.CiRGcfZg.js +1 -0
  9. package/dist/docs/assets/chunks/{VPLocalSearchBox.DsnRlUT5.js → VPLocalSearchBox.Cadl7A0k.js} +1 -1
  10. package/dist/docs/assets/chunks/{arc.DH8GOhiv.js → arc.K7t9nNY6.js} +1 -1
  11. package/dist/docs/assets/chunks/{architectureDiagram-Q4EWVU46.9m9ObyuE.js → architectureDiagram-Q4EWVU46.SlHEknkX.js} +1 -1
  12. package/dist/docs/assets/chunks/{baseUniq.BXHpx1lE.js → baseUniq.DJLRMLkz.js} +1 -1
  13. package/dist/docs/assets/chunks/{blockDiagram-DXYQGD6D.xY3EX59q.js → blockDiagram-DXYQGD6D.Bs6XxFpe.js} +1 -1
  14. package/dist/docs/assets/chunks/{c4Diagram-AHTNJAMY.DnqgMVgc.js → c4Diagram-AHTNJAMY.CyLg6Ovc.js} +1 -1
  15. package/dist/docs/assets/chunks/channel.CVTdqYx0.js +1 -0
  16. package/dist/docs/assets/chunks/{chunk-4BX2VUAB.BjFxK2A3.js → chunk-4BX2VUAB.DTQ4TinT.js} +1 -1
  17. package/dist/docs/assets/chunks/{chunk-4TB4RGXK.BujS_Spt.js → chunk-4TB4RGXK.Es84IgcH.js} +1 -1
  18. package/dist/docs/assets/chunks/{chunk-55IACEB6.YbTjhdaM.js → chunk-55IACEB6.Clm3cGPQ.js} +1 -1
  19. package/dist/docs/assets/chunks/{chunk-EDXVE4YY.DnQ8t4GC.js → chunk-EDXVE4YY.DE4CRkS5.js} +1 -1
  20. package/dist/docs/assets/chunks/{chunk-FMBD7UC4.B67AwAmj.js → chunk-FMBD7UC4.Bf8HCvqp.js} +1 -1
  21. package/dist/docs/assets/chunks/{chunk-OYMX7WX6.DrZIAFOm.js → chunk-OYMX7WX6.eub-7nSx.js} +1 -1
  22. package/dist/docs/assets/chunks/{chunk-QZHKN3VN.BLmmydkn.js → chunk-QZHKN3VN.WyP9VAS_.js} +1 -1
  23. package/dist/docs/assets/chunks/{chunk-YZCP3GAM.DaoOfw0O.js → chunk-YZCP3GAM.LO9ohhDE.js} +1 -1
  24. package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.CsJJyx6-.js +1 -0
  25. package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.CsJJyx6-.js +1 -0
  26. package/dist/docs/assets/chunks/clone.Dk8KvtOB.js +1 -0
  27. package/dist/docs/assets/chunks/{cose-bilkent-S5V4N54A.DMQuNhM5.js → cose-bilkent-S5V4N54A.D5za6aH0.js} +1 -1
  28. package/dist/docs/assets/chunks/{dagre-KV5264BT.CZoGVuUf.js → dagre-KV5264BT.Dq1daUru.js} +1 -1
  29. package/dist/docs/assets/chunks/{diagram-5BDNPKRD.CLt9uOyL.js → diagram-5BDNPKRD.j1YL5BKS.js} +1 -1
  30. package/dist/docs/assets/chunks/{diagram-G4DWMVQ6.DpczEm1G.js → diagram-G4DWMVQ6.Bi1aLdhC.js} +1 -1
  31. package/dist/docs/assets/chunks/{diagram-MMDJMWI5.D4r13DvJ.js → diagram-MMDJMWI5.BOzMEkAr.js} +1 -1
  32. package/dist/docs/assets/chunks/{diagram-TYMM5635.CYU9eGFu.js → diagram-TYMM5635.Dx2FVhCr.js} +1 -1
  33. package/dist/docs/assets/chunks/{erDiagram-SMLLAGMA.QA9naWEw.js → erDiagram-SMLLAGMA.DI4TNkye.js} +1 -1
  34. package/dist/docs/assets/chunks/{flowDiagram-DWJPFMVM.BbNoVZYd.js → flowDiagram-DWJPFMVM.C58Z9uPK.js} +1 -1
  35. package/dist/docs/assets/chunks/{ganttDiagram-T4ZO3ILL.IHjDoG7r.js → ganttDiagram-T4ZO3ILL.DXSpW809.js} +1 -1
  36. package/dist/docs/assets/chunks/{gitGraphDiagram-UUTBAWPF.B21VMdf5.js → gitGraphDiagram-UUTBAWPF.B955oaFl.js} +1 -1
  37. package/dist/docs/assets/chunks/{graph.DgJ4L-8V.js → graph.BQXhKtxS.js} +1 -1
  38. package/dist/docs/assets/chunks/{infoDiagram-42DDH7IO.CQjrcthc.js → infoDiagram-42DDH7IO.Dozj_-Gm.js} +1 -1
  39. package/dist/docs/assets/chunks/{ishikawaDiagram-UXIWVN3A.D4tPGtVo.js → ishikawaDiagram-UXIWVN3A.D2140OzH.js} +1 -1
  40. package/dist/docs/assets/chunks/{journeyDiagram-VCZTEJTY.BD3WaNbQ.js → journeyDiagram-VCZTEJTY.DrqrMhCk.js} +1 -1
  41. package/dist/docs/assets/chunks/{kanban-definition-6JOO6SKY.Ca0o4Tqz.js → kanban-definition-6JOO6SKY.Dv-LTrlw.js} +1 -1
  42. package/dist/docs/assets/chunks/{layout.DXXqX4MQ.js → layout.CGtHp49X.js} +1 -1
  43. package/dist/docs/assets/chunks/{linear.5c61gNw4.js → linear.CHZLYB52.js} +1 -1
  44. package/dist/docs/assets/chunks/{min.B1-NAjHX.js → min.D4Vt3eIy.js} +1 -1
  45. package/dist/docs/assets/chunks/{mindmap-definition-QFDTVHPH.BELznv3-.js → mindmap-definition-QFDTVHPH.BBfpYTea.js} +1 -1
  46. package/dist/docs/assets/chunks/{pieDiagram-DEJITSTG.qPzO1mq5.js → pieDiagram-DEJITSTG.BVYvElmY.js} +1 -1
  47. package/dist/docs/assets/chunks/{quadrantDiagram-34T5L4WZ.CxIvzbjX.js → quadrantDiagram-34T5L4WZ.C6Gc2mdY.js} +1 -1
  48. package/dist/docs/assets/chunks/{requirementDiagram-MS252O5E.CqA0iJx8.js → requirementDiagram-MS252O5E.DWa8b4cn.js} +1 -1
  49. package/dist/docs/assets/chunks/{sankeyDiagram-XADWPNL6.XRTutBnb.js → sankeyDiagram-XADWPNL6.Bi-g4ajv.js} +1 -1
  50. package/dist/docs/assets/chunks/{sequenceDiagram-FGHM5R23.E--7bRLQ.js → sequenceDiagram-FGHM5R23.DlU3vVN9.js} +1 -1
  51. package/dist/docs/assets/chunks/{stateDiagram-FHFEXIEX.C4vGu8zq.js → stateDiagram-FHFEXIEX.CeqJRqnU.js} +1 -1
  52. package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.DE0BnUZh.js +1 -0
  53. package/dist/docs/assets/chunks/{theme.DMj_7q3B.js → theme.DGq7D4tt.js} +2 -2
  54. package/dist/docs/assets/chunks/{timeline-definition-GMOUNBTQ.C7LgNVAL.js → timeline-definition-GMOUNBTQ.Cqf2kjq9.js} +1 -1
  55. package/dist/docs/assets/chunks/{vennDiagram-DHZGUBPP.HUwoZcy_.js → vennDiagram-DHZGUBPP.BeOpE_lM.js} +1 -1
  56. package/dist/docs/assets/chunks/{wardley-RL74JXVD.BxFEFYZS.js → wardley-RL74JXVD.FMQXA-6q.js} +1 -1
  57. package/dist/docs/assets/chunks/{wardleyDiagram-NUSXRM2D.B2pSo5rB.js → wardleyDiagram-NUSXRM2D.BXS65dAC.js} +1 -1
  58. package/dist/docs/assets/chunks/{xychartDiagram-5P7HB3ND.NQhMiOOL.js → xychartDiagram-5P7HB3ND.haEiSxqc.js} +1 -1
  59. package/dist/docs/assets/{deployment.md.BtqJrHhp.js → deployment.md.DJtuDVLh.js} +3 -3
  60. package/dist/docs/assets/{deployment.md.BtqJrHhp.lean.js → deployment.md.DJtuDVLh.lean.js} +1 -1
  61. package/dist/docs/assets/{guides_agent-to-agent.md.BcmSqL2z.js → guides_agent-to-agent.md.DcB3nhOz.js} +1 -1
  62. package/dist/docs/assets/{guides_github.md.6jiEH7dg.js → guides_github.md.CcuZ7keS.js} +1 -1
  63. package/dist/docs/assets/{guides_mcp-oauth.md.C-Sx_IPa.js → guides_mcp-oauth.md.GVPMKcYl.js} +1 -1
  64. package/dist/docs/assets/{guides_migrate.md.BbhHYeCr.js → guides_migrate.md.B8CZxnnX.js} +1 -1
  65. package/dist/docs/assets/{guides_slack.md.BgIGG9ur.js → guides_slack.md.D7Rwyva4.js} +1 -1
  66. package/dist/docs/assets/{hillclimbing.md.3TkdF79A.js → hillclimbing.md.M51bF-oT.js} +1 -1
  67. package/dist/docs/assets/index.md.DnJPj_B6.js +14 -0
  68. package/dist/docs/assets/index.md.DnJPj_B6.lean.js +1 -0
  69. package/dist/docs/assets/{reference_agent-config.md.C0Tp_Fk9.js → reference_agent-config.md.BSNp2uJ7.js} +3 -3
  70. package/dist/docs/assets/{reference_cli.md.B8GdpaRj.js → reference_cli.md.DHm6DmYk.js} +2 -2
  71. package/dist/docs/assets/{reference_hooks.md.CSWmOwMM.js → reference_hooks.md.vbIM394-.js} +2 -2
  72. package/dist/docs/assets/{reference_hooks.md.CSWmOwMM.lean.js → reference_hooks.md.vbIM394-.lean.js} +1 -1
  73. package/dist/docs/assets/{reference_schedules.md.RhQ9ZLo1.js → reference_schedules.md.Dd8_d0WG.js} +3 -3
  74. package/dist/docs/building-with-agents.html +36 -36
  75. package/dist/docs/building-with-agents.md +3 -3
  76. package/dist/docs/changelog.html +36 -36
  77. package/dist/docs/changelog.md +20 -1
  78. package/dist/docs/deployment.html +37 -37
  79. package/dist/docs/deployment.md +22 -16
  80. package/dist/docs/evals.html +35 -35
  81. package/dist/docs/guides/agent-to-agent.html +37 -37
  82. package/dist/docs/guides/agent-to-agent.md +4 -2
  83. package/dist/docs/guides/bitbucket.html +35 -35
  84. package/dist/docs/guides/cloud-agents.html +35 -35
  85. package/dist/docs/guides/convert-automation.html +35 -35
  86. package/dist/docs/guides/github.html +37 -37
  87. package/dist/docs/guides/github.md +1 -1
  88. package/dist/docs/guides/gitlab.html +35 -35
  89. package/dist/docs/guides/improve.html +35 -35
  90. package/dist/docs/guides/jev.html +35 -35
  91. package/dist/docs/guides/mcp-oauth.html +37 -37
  92. package/dist/docs/guides/mcp-oauth.md +1 -1
  93. package/dist/docs/guides/migrate.html +37 -37
  94. package/dist/docs/guides/migrate.md +1 -1
  95. package/dist/docs/guides/opentelemetry.html +35 -35
  96. package/dist/docs/guides/pagerduty.html +35 -35
  97. package/dist/docs/guides/slack.html +37 -37
  98. package/dist/docs/guides/slack.md +1 -1
  99. package/dist/docs/guides/webhooks.html +35 -35
  100. package/dist/docs/hashmap.json +1 -1
  101. package/dist/docs/hillclimbing.html +36 -36
  102. package/dist/docs/hillclimbing.md +1 -1
  103. package/dist/docs/index.html +42 -48
  104. package/dist/docs/index.md +8 -14
  105. package/dist/docs/llms-full.txt +70 -50
  106. package/dist/docs/quickstart.html +35 -35
  107. package/dist/docs/reference/access.html +35 -35
  108. package/dist/docs/reference/agent-config.html +39 -39
  109. package/dist/docs/reference/agent-config.md +5 -6
  110. package/dist/docs/reference/artifacts.html +35 -35
  111. package/dist/docs/reference/channels.html +35 -35
  112. package/dist/docs/reference/cli.html +38 -38
  113. package/dist/docs/reference/cli.md +2 -2
  114. package/dist/docs/reference/connections.html +35 -35
  115. package/dist/docs/reference/evals.html +35 -35
  116. package/dist/docs/reference/extensions.html +35 -35
  117. package/dist/docs/reference/hooks.html +37 -37
  118. package/dist/docs/reference/hooks.md +1 -1
  119. package/dist/docs/reference/http-api.html +35 -35
  120. package/dist/docs/reference/instructions.html +35 -35
  121. package/dist/docs/reference/limits.html +35 -35
  122. package/dist/docs/reference/memory.html +35 -35
  123. package/dist/docs/reference/playground.html +35 -35
  124. package/dist/docs/reference/project-layout.html +35 -35
  125. package/dist/docs/reference/schedules.html +38 -38
  126. package/dist/docs/reference/sessions.html +35 -35
  127. package/dist/docs/reference/skills.html +35 -35
  128. package/dist/docs/reference/subagents.html +35 -35
  129. package/dist/docs/reference/tools.html +35 -35
  130. package/dist/docs/templates/agentic-owners.html +35 -35
  131. package/dist/docs/templates/reviews.html +35 -35
  132. package/dist/docs/troubleshooting.html +35 -35
  133. package/dist/filesystem.d.ts +7 -320
  134. package/dist/filesystem.d.ts.map +1 -1
  135. package/dist/filesystem.js +10 -691
  136. package/dist/index.d.ts +1 -1
  137. package/dist/index.d.ts.map +1 -1
  138. package/dist/index.js +1 -1
  139. package/dist/internal/authored-alias-hooks.d.ts +6 -0
  140. package/dist/internal/authored-alias-hooks.d.ts.map +1 -1
  141. package/dist/internal/authored-alias-hooks.js +12 -0
  142. package/dist/internal/authored-loaders.js +10 -1
  143. package/dist/internal/cli/commands/scaffold.js +1 -1
  144. package/dist/internal/continuation-session-ids.d.ts +15 -0
  145. package/dist/internal/continuation-session-ids.d.ts.map +1 -0
  146. package/dist/internal/continuation-session-ids.js +43 -0
  147. package/dist/internal/filesystem/walk.d.ts +1 -5
  148. package/dist/internal/filesystem/walk.d.ts.map +1 -1
  149. package/dist/internal/filesystem/walk.js +1 -9
  150. package/dist/internal/hosted-catch-protocol.d.ts +3 -3
  151. package/dist/internal/hosted-catch-protocol.js +3 -3
  152. package/dist/internal/hosted-fetch.d.ts +7 -0
  153. package/dist/internal/hosted-fetch.d.ts.map +1 -0
  154. package/dist/internal/hosted-fetch.js +26 -0
  155. package/dist/internal/install-cursor-skills.d.ts +5 -6
  156. package/dist/internal/install-cursor-skills.d.ts.map +1 -1
  157. package/dist/internal/install-cursor-skills.js +19 -4
  158. package/dist/internal/mcp-endpoint.js +4 -4
  159. package/dist/internal/model-config.d.ts.map +1 -1
  160. package/dist/internal/model-config.js +11 -4
  161. package/dist/internal/platform-timers.d.ts +3 -7
  162. package/dist/internal/platform-timers.d.ts.map +1 -1
  163. package/dist/internal/platform-timers.js +10 -51
  164. package/dist/internal/server.d.ts.map +1 -1
  165. package/dist/internal/server.js +6 -1
  166. package/dist/internal/session-engine.d.ts +3 -0
  167. package/dist/internal/session-engine.d.ts.map +1 -1
  168. package/dist/internal/session-engine.js +12 -3
  169. package/dist/playground/assets/index-Bno25Cg0.css +1 -0
  170. package/dist/playground/assets/index-SGKsaznh.js +62 -0
  171. package/dist/playground/index.html +2 -2
  172. package/dist/types.d.ts +2 -0
  173. package/dist/types.d.ts.map +1 -1
  174. package/dist/types.js +2 -2
  175. package/docs/README.md +8 -14
  176. package/docs/building-with-agents.md +3 -3
  177. package/docs/changelog.md +20 -1
  178. package/docs/deployment.md +22 -16
  179. package/docs/guides/agent-to-agent.md +4 -2
  180. package/docs/guides/github.md +1 -1
  181. package/docs/guides/mcp-oauth.md +1 -1
  182. package/docs/guides/migrate.md +1 -1
  183. package/docs/guides/slack.md +1 -1
  184. package/docs/hillclimbing.md +1 -1
  185. package/docs/reference/agent-config.md +5 -6
  186. package/docs/reference/cli.md +2 -2
  187. package/docs/reference/hooks.md +1 -1
  188. package/package.json +3 -3
  189. package/skills/cli/SKILL.md +1 -1
  190. package/skills/create-agent/SKILL.md +61 -7
  191. package/skills/debug/SKILL.md +1 -1
  192. package/skills/deploy/SKILL.md +3 -3
  193. package/skills/evals/SKILL.md +1 -1
  194. package/skills/framework-map/SKILL.md +2 -2
  195. package/skills/github/SKILL.md +1 -1
  196. package/skills/hillclimb/SKILL.md +1 -1
  197. package/skills/mcp-auth/SKILL.md +1 -1
  198. package/skills/migrate-v2/SKILL.md +2 -2
  199. package/skills/otel/SKILL.md +1 -1
  200. package/skills/setup-slack/SKILL.md +2 -2
  201. package/dist/docs/assets/changelog.md.BWhC6DET.js +0 -1
  202. package/dist/docs/assets/chunks/@localSearchIndexroot.CWxwVoCG.js +0 -1
  203. package/dist/docs/assets/chunks/channel.Cctv0f7X.js +0 -1
  204. package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.DU5sqchW.js +0 -1
  205. package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.DU5sqchW.js +0 -1
  206. package/dist/docs/assets/chunks/clone.B9rdNt6j.js +0 -1
  207. package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.ECMu2BdJ.js +0 -1
  208. package/dist/docs/assets/index.md.DRfaoRCZ.js +0 -20
  209. package/dist/docs/assets/index.md.DRfaoRCZ.lean.js +0 -1
  210. package/dist/internal/filesystem/errors.d.ts +0 -64
  211. package/dist/internal/filesystem/errors.d.ts.map +0 -1
  212. package/dist/internal/filesystem/errors.js +0 -180
  213. package/dist/internal/filesystem/merge.d.ts +0 -34
  214. package/dist/internal/filesystem/merge.d.ts.map +0 -1
  215. package/dist/internal/filesystem/merge.js +0 -154
  216. package/dist/playground/assets/index-D6mVn9og.js +0 -62
  217. package/dist/playground/assets/index-DlALM6gr.css +0 -1
  218. /package/dist/docs/assets/{building-with-agents.md.BqJ7AAjG.lean.js → building-with-agents.md.Bo3ct-rf.lean.js} +0 -0
  219. /package/dist/docs/assets/{guides_agent-to-agent.md.BcmSqL2z.lean.js → guides_agent-to-agent.md.DcB3nhOz.lean.js} +0 -0
  220. /package/dist/docs/assets/{guides_github.md.6jiEH7dg.lean.js → guides_github.md.CcuZ7keS.lean.js} +0 -0
  221. /package/dist/docs/assets/{guides_mcp-oauth.md.C-Sx_IPa.lean.js → guides_mcp-oauth.md.GVPMKcYl.lean.js} +0 -0
  222. /package/dist/docs/assets/{guides_migrate.md.BbhHYeCr.lean.js → guides_migrate.md.B8CZxnnX.lean.js} +0 -0
  223. /package/dist/docs/assets/{guides_slack.md.BgIGG9ur.lean.js → guides_slack.md.D7Rwyva4.lean.js} +0 -0
  224. /package/dist/docs/assets/{hillclimbing.md.3TkdF79A.lean.js → hillclimbing.md.M51bF-oT.lean.js} +0 -0
  225. /package/dist/docs/assets/{reference_agent-config.md.C0Tp_Fk9.lean.js → reference_agent-config.md.BSNp2uJ7.lean.js} +0 -0
  226. /package/dist/docs/assets/{reference_cli.md.B8GdpaRj.lean.js → reference_cli.md.DHm6DmYk.lean.js} +0 -0
  227. /package/dist/docs/assets/{reference_schedules.md.RhQ9ZLo1.lean.js → reference_schedules.md.Dd8_d0WG.lean.js} +0 -0
@@ -14,13 +14,13 @@ To let a running agent change its own source, see the [self-improvement extensio
14
14
 
15
15
  ## Create an agent from a goal
16
16
 
17
- Tell the coding agent what the agent is for and where people reach it, and ask it to follow the `bdk-create-agent` skill. It asks for any decisions you haven't made, shows a file plan, and scaffolds a small first version with a smoke eval.
17
+ Tell the coding agent what the agent is for and where people reach it, and ask it to follow the `agent-sdk-create-agent` skill. It asks for any decisions you haven't made, shows a file plan, and scaffolds a small first version with a smoke eval.
18
18
 
19
19
  ## Add one capability
20
20
 
21
- For an existing project, name the outcome and point the coding agent at the matching skill, such as `bdk-setup-slack`, `bdk-mcp-auth`, or `bdk-github`. For example:
21
+ For an existing project, name the outcome and point the coding agent at the matching skill, such as `agent-sdk-setup-slack`, `agent-sdk-mcp-auth`, or `agent-sdk-github`. For example:
22
22
 
23
- > Add Slack mentions and DMs to this agent. Follow the bdk-setup-slack
23
+ > Add Slack mentions and DMs to this agent. Follow the agent-sdk-setup-slack
24
24
  > skill, keep replies in the source thread, and verify one local mention.
25
25
 
26
26
  > Connect the private inventory MCP server with host OAuth. Keep its
@@ -54,7 +54,26 @@ Source: /docs/changelog.md
54
54
 
55
55
  # Changelog
56
56
 
57
- ## 0.3.0 (2026-10-23)
57
+ ## 0.4.0 (2026-10-27)
58
+
59
+ ### Breaking changes
60
+
61
+ - The `FileSystem` type, its helpers, and its errors match the file tools, and the package root exports `readOnlyFs`.
62
+ - Skill ids change from `bdk-<name>` to `agent-sdk-<name>` with no alias, and install removes the old folders.
63
+
64
+ ### Behavior changes
65
+
66
+ - An agent with no model uses `grok-4.7` with high effort and fast speed, and an agent that names a model keeps that model.
67
+
68
+ ### Fixes
69
+
70
+ - A reply in a Slack thread that a schedule started continues that session.
71
+ - A hosted Slack agent with `botMentions.allowFrom` starts a session when an allowed bot mentions it.
72
+ - A `check` on a peer that is still running returns `running`, an error, or the reply before the request ends.
73
+ - A hosted deploy that uses presigned file URLs passes its health check.
74
+ - The dashboard on grok.com embeds the hosted playground.
75
+
76
+ ## 0.3.0 (2026-10-25)
58
77
 
59
78
  - GA Release
60
79
  - `persistent` option is removed from `defineAgent`
@@ -155,22 +174,28 @@ fails on a literal or a getter.
155
174
 
156
175
  Write each egress host as a lowercase hostname with no scheme or path, such as `api.example.com`, and add a port such as `clickhouse.example.com:9440` only for raw TCP. `agent-sdk deploy` rejects any other form, and the error quotes that host.
157
176
 
158
- Your team's egress policy limits which hosts you can list in
159
- `hosting.egressDomains`. If you list a host that the policy blocks,
160
- `agent-sdk deploy` fails and the error names that host. A deployment that
161
- is already running keeps the policy from its last successful deploy. Ask a
162
- team admin to add the host, or remove it and deploy again.
163
-
164
- | Team egress mode | What `agent-sdk deploy` allows |
165
- | --- | --- |
166
- | No mode set | Every host in `hosting.egressDomains`. |
167
- | Allow all network access | Every host in `hosting.egressDomains`. The bot stays limited to that list. |
168
- | Defaults + team allowlist | The platform default list, plus the team list. |
169
- | Team allowlist only | The team list. |
170
-
171
- No team list can remove the platform base, which includes Cursor's API and
172
- the npm registry. `agent-sdk deploy --json` lists every allowed host under
173
- `egress.effective`.
177
+ ### How egress works
178
+
179
+ A deployed agent can only reach hosts on its egress list. A call to any other
180
+ host fails, usually as a connection reset or a 403 from the proxy. Here's how
181
+ the egress allowlist gets built:
182
+
183
+ 1. **Agent SDK Platform Egress:** Some hosts are required for the Agent SDK to
184
+ work, including the Cursor API.
185
+ 2. **Your Agent's Egress:** The hosts defined in `hosting.egressDomains`, plus
186
+ any hosts that your mounted extensions add. If your Cursor team enables the
187
+ team-wide egress policy, then each of these hosts must also be on the
188
+ team's egress allowlist. If one isn't, `agent-sdk deploy` fails and names
189
+ the host, and the agent that's already running doesn't change.
190
+ 3. **Channel Egress:** Each channel adds the hosts it needs by itself, and the
191
+ team allowlist doesn't apply to them. A Slack app adds `slack.com` and
192
+ `files.slack.com`. A GitHub or GitLab binding on a self-hosted instance
193
+ adds that host. MCP connections don't add anything, so be sure to declare
194
+ their hosts yourself in `hosting.egressDomains`.
195
+
196
+ Cursor saves your agent's list when you deploy, so an egress change only takes
197
+ effect after you deploy again. To check your declared and extension hosts
198
+ first, run `agent-sdk info --dir .`.
174
199
 
175
200
  A team entry `*.example.com` allows `example.com`, every subdomain, and
176
201
  narrower wildcards such as `*.api.example.com`. An agent entry
@@ -474,8 +499,10 @@ await ctx.host.mcp.callTool("weather", "ask", {
474
499
  });
475
500
  ```
476
501
 
477
- If the specialist is still working, `ask` returns `status: "running"`, and
478
- `check` waits for the answer.
502
+ If the specialist is still working, `ask` returns `status: "running"` and a
503
+ `sessionId`. Do not end your turn. Call `check` with that `sessionId` until
504
+ the status is `completed`. Ending your turn drops the reply, because nothing
505
+ else delivers it when the specialist finishes.
479
506
 
480
507
  ```ts
481
508
  await ctx.host.mcp.callTool("weather", "check", {
@@ -1229,7 +1256,7 @@ Pass each credential as `{ secretName: "NAME" }`. When you run locally, the chan
1229
1256
  ## Related
1230
1257
 
1231
1258
  - [Build a PR reviewer](/docs/quickstart.md) covers the full loop.
1232
- - Ask a coding agent to follow the `bdk-github` skill for the GitHub setup steps.
1259
+ - Ask a coding agent to follow the `agent-sdk-github` skill for the GitHub setup steps.
1233
1260
 
1234
1261
  ---
1235
1262
 
@@ -1839,7 +1866,7 @@ gives each caller its own downstream identity.
1839
1866
 
1840
1867
  ## Related
1841
1868
 
1842
- - Follow the `bdk-mcp-auth` skill, then run `agent-sdk mcp oauth <connection>`.
1869
+ - Follow the `agent-sdk-mcp-auth` skill, then run `agent-sdk mcp oauth <connection>`.
1843
1870
  - [MCP connections](/docs/reference/connections.md)
1844
1871
 
1845
1872
  ---
@@ -1891,7 +1918,7 @@ agent-sdk migrate --dir .
1891
1918
  To migrate a pushed source outside your checkout, pass `--repo`, `--ref`, and
1892
1919
  `--path`. The [CLI reference](/docs/reference/cli.md#migrate) lists every flag.
1893
1920
 
1894
- You can also ask a coding agent in your checkout to follow the bundled `bdk-migrate-v2` skill. If the project
1921
+ You can also ask a coding agent in your checkout to follow the bundled `agent-sdk-migrate-v2` skill. If the project
1895
1922
  relies on a v1 capability that has no v2 path, the agent stops and names the
1896
1923
  blocker.
1897
1924
 
@@ -2551,7 +2578,7 @@ The person who runs `slack create` grants Cursor three user scopes on their own
2551
2578
  create and install the app, and `botScopes` doesn't change them.
2552
2579
 
2553
2580
  If you already own the Slack app, run `agent-sdk slack init --manual --dir . --name "Triage"` and
2554
- follow the `bdk-setup-slack` skill for installation and tokens.
2581
+ follow the `agent-sdk-setup-slack` skill for installation and tokens.
2555
2582
 
2556
2583
  ---
2557
2584
 
@@ -2793,7 +2820,7 @@ Source: /docs/hillclimbing.md
2793
2820
  Hillclimbing improves an agent one measured change at a time. Hold the inputs fixed, change one
2794
2821
  thing, and keep it only when the same run gets better without moving the behavior you froze.
2795
2822
 
2796
- A coding agent in your checkout can run this loop by following the `bdk-hillclimb` skill.
2823
+ A coding agent in your checkout can run this loop by following the `agent-sdk-hillclimb` skill.
2797
2824
 
2798
2825
  ## Run one measured round
2799
2826
 
@@ -2879,27 +2906,21 @@ manage it.
2879
2906
 
2880
2907
  ## Get Started with your Coding Agent
2881
2908
 
2882
- Paste this prompt into your coding agent. It installs the CLI, asks what your agent is for, and
2883
- scaffolds a first project from the Markdown version of these docs.
2909
+ Paste this prompt into your coding agent. It installs the CLI, asks what your agent is for,
2910
+ scaffolds and checks a first project, and tells you how to test and deploy it.
2884
2911
 
2885
2912
  ```text
2886
2913
  Set up my first Agent SDK project.
2887
2914
 
2888
- Read https://cursor.com/docs/agent-sdk.md first. Every page under
2889
- https://cursor.com/docs/agent-sdk/ is also available as Markdown when you
2890
- add .md to its URL.
2915
+ Read https://cursor.com/docs/agent-sdk.md. Add .md to any page under
2916
+ https://cursor.com/docs/agent-sdk/ to read it as Markdown.
2891
2917
 
2892
2918
  1. Check that Node is 22.13 or newer, then run:
2893
2919
  npm install --global @grok/agent-sdk
2894
- 2. Read the docs index that ships with the package:
2895
- "$(npm root -g)/@grok/agent-sdk/dist/docs/llms.txt"
2896
- 3. Run agent-sdk login, and wait while I finish the browser sign-in.
2897
- 4. Ask me what the agent should do and where people will reach it. Then
2898
- follow the bdk-create-agent skill at
2899
- "$(npm root -g)/@grok/agent-sdk/skills/create-agent/SKILL.md"
2900
- to scaffold the project with agent-sdk init.
2901
- 5. Run agent-sdk validate --dir . and one agent-sdk run turn, then show me
2902
- the reply.
2920
+ 2. Follow the agent-sdk-create-agent skill at
2921
+ "$(npm root -g)/@grok/agent-sdk/skills/create-agent/SKILL.md".
2922
+ 3. Do not deploy or push until I ask. End by telling me what the agent
2923
+ does, how to test it locally, and how to deploy it.
2903
2924
  ```
2904
2925
 
2905
2926
  ## Why Agent SDK
@@ -3206,9 +3227,9 @@ import { defineAgent } from "@grok/agent-sdk";
3206
3227
 
3207
3228
  export default defineAgent({
3208
3229
  model: {
3209
- id: "grok-4.5",
3230
+ id: "grok-4.7",
3210
3231
  params: [
3211
- { id: "effort", value: "high" },
3232
+ { id: "reasoning_effort", value: "high" },
3212
3233
  { id: "fast", value: "true" },
3213
3234
  ],
3214
3235
  }, // optional; this is the default
@@ -3219,7 +3240,7 @@ export default defineAgent({
3219
3240
 
3220
3241
  | Field | Type | Meaning |
3221
3242
  | --- | --- | --- |
3222
- | `model` | string or `{ id, params }` | Cursor model for turns. Defaults to `grok-4.5` with `effort=high` and `fast=true`. Subagents omit it to inherit. |
3243
+ | `model` | string or `{ id, params }` | Cursor model for turns. Defaults to `grok-4.7` with `reasoning_effort=high` and `fast=true`. Subagents omit it to inherit. |
3223
3244
  | `name` | string | Display name. Defaults to the package or directory name. |
3224
3245
  | `description` | string | What the agent is for. Required on subagents, where the parent model reads it to decide when to delegate. |
3225
3246
  | `instructions` | string | Inline instructions for subagents and generated configs. Prefer `instructions.md`. |
@@ -3235,9 +3256,8 @@ The `persistent` field was removed. Discovery rejects a config that still sets i
3235
3256
 
3236
3257
  ## Model
3237
3258
 
3238
- Effort and speed are params, not id suffixes, so Agent SDK rejects an id like
3239
- `grok-4.5-fast`. Use the object form shown above to set params, or a plain
3240
- string when you don't need any:
3259
+ Set effort and speed with params, not in the id. Use the object form shown above
3260
+ to set params, or a plain string when you don't need any:
3241
3261
 
3242
3262
  ```ts
3243
3263
  model: "composer-2.5",
@@ -3994,7 +4014,7 @@ agent-sdk migrate [--dir <path>] [--repo <https-url>] [--ref <git-ref>]
3994
4014
 
3995
4015
  `migrate` applies only to projects that deployed with `architecture: "v1"`
3996
4016
  during the early alpha. It starts a Cursor cloud agent on a pushed Git ref
3997
- with the bundled `bdk-migrate-v2` skill, and the agent opens a pull request
4017
+ with the bundled `agent-sdk-migrate-v2` skill, and the agent opens a pull request
3998
4018
  with the source changes. The command never deploys or changes secrets.
3999
4019
 
4000
4020
  With nothing to change, it prints `Nothing to migrate.` and exits `0`, and it exits `1` if the run ends without a pull request. `deploy` refuses a project that sets `architecture: "v1"` and points to `migrate`. See [Migrate an early-alpha project](/docs/guides/migrate.md).
@@ -4006,7 +4026,7 @@ agent-sdk skills install [--dry-run] [--json]
4006
4026
  agent-sdk skills list [--json [--fields <a,b.c>]] [--limit <n>] [--page-token <token>]
4007
4027
  ```
4008
4028
 
4009
- Package installation copies the bundled skills, `skills install` replaces the installed copies and removes stale ones, and `skills list` prints each skill's bundled and installed versions. The `bdk-cli` skill teaches agents to run `agent-sdk` safely.
4029
+ Package installation copies the bundled skills, `skills install` replaces the installed copies and removes stale ones, and `skills list` prints each skill's bundled and installed versions. The `agent-sdk-cli` skill teaches agents to run `agent-sdk` safely.
4010
4030
 
4011
4031
  ### Inspect a project {#info}
4012
4032
 
@@ -5064,7 +5084,7 @@ Keys are event types from the [event vocabulary](/docs/reference/sessions.md#str
5064
5084
  | --- | --- |
5065
5085
  | `message.received` | `{ text }` |
5066
5086
  | `turn.completed` | `{ result?, usage?, cost? }`. `usage` has `inputTokens`, `outputTokens`, `cacheReadTokens`, `cacheWriteTokens`, and optional `reasoningTokens`. `cost` has `totalUsd` and the `model` it was priced against |
5067
- | `turn.failed` | `{ message, status? }`. `status` is `"error"` or `"cancelled"` when present |
5087
+ | `turn.failed` | `{ message, status?, code? }`. `status` is `"error"` or `"cancelled"` when present. `code` is the runner's stable error code, such as a Cursor SDK `RunError.code`, when the failure supplied one |
5068
5088
  | `actions.requested` | `{ calls: [{ callId, toolName, args?, parentCallId? }], parentCallId? }`. One envelope per model step. `parentCallId` marks subagent work |
5069
5089
  | `actions.completed` | `{ results: [{ callId, toolName, output?, isError, stubbed?, parentCallId? }], parentCallId? }`. Emitted when every call in that batch has a result |
5070
5090
  | `action.result` | `{ callId, toolName, output?, isError, stubbed?, parentCallId? }`. Live per-call envelope. `stubbed` means a dry-run session answered a write without running it |
@@ -9,42 +9,42 @@
9
9
  <link rel="preload stylesheet" href="/docs/assets/style.DK0YX1WL.css" as="style">
10
10
  <link rel="preload stylesheet" href="/docs/vp-icons.css" as="style">
11
11
 
12
- <script type="module" src="/docs/assets/app.BzTUBOAD.js"></script>
12
+ <script type="module" src="/docs/assets/app.BSH__xV4.js"></script>
13
13
  <link rel="preload" href="/docs/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
14
14
  <link rel="modulepreload" href="/docs/assets/chunks/framework.BNw1pucY.js">
15
- <link rel="modulepreload" href="/docs/assets/chunks/theme.DMj_7q3B.js">
15
+ <link rel="modulepreload" href="/docs/assets/chunks/theme.DGq7D4tt.js">
16
16
  <link rel="modulepreload" href="/docs/assets/chunks/katex.DkKDou_j.js">
17
- <link rel="modulepreload" href="/docs/assets/chunks/dagre-KV5264BT.CZoGVuUf.js">
18
- <link rel="modulepreload" href="/docs/assets/chunks/cose-bilkent-S5V4N54A.DMQuNhM5.js">
19
- <link rel="modulepreload" href="/docs/assets/chunks/c4Diagram-AHTNJAMY.DnqgMVgc.js">
20
- <link rel="modulepreload" href="/docs/assets/chunks/flowDiagram-DWJPFMVM.BbNoVZYd.js">
21
- <link rel="modulepreload" href="/docs/assets/chunks/erDiagram-SMLLAGMA.QA9naWEw.js">
22
- <link rel="modulepreload" href="/docs/assets/chunks/gitGraphDiagram-UUTBAWPF.B21VMdf5.js">
23
- <link rel="modulepreload" href="/docs/assets/chunks/ganttDiagram-T4ZO3ILL.IHjDoG7r.js">
24
- <link rel="modulepreload" href="/docs/assets/chunks/infoDiagram-42DDH7IO.CQjrcthc.js">
25
- <link rel="modulepreload" href="/docs/assets/chunks/pieDiagram-DEJITSTG.qPzO1mq5.js">
26
- <link rel="modulepreload" href="/docs/assets/chunks/quadrantDiagram-34T5L4WZ.CxIvzbjX.js">
27
- <link rel="modulepreload" href="/docs/assets/chunks/xychartDiagram-5P7HB3ND.NQhMiOOL.js">
28
- <link rel="modulepreload" href="/docs/assets/chunks/requirementDiagram-MS252O5E.CqA0iJx8.js">
29
- <link rel="modulepreload" href="/docs/assets/chunks/sequenceDiagram-FGHM5R23.E--7bRLQ.js">
30
- <link rel="modulepreload" href="/docs/assets/chunks/classDiagram-6PBFFD2Q.DU5sqchW.js">
31
- <link rel="modulepreload" href="/docs/assets/chunks/classDiagram-v2-HSJHXN6E.DU5sqchW.js">
32
- <link rel="modulepreload" href="/docs/assets/chunks/stateDiagram-FHFEXIEX.C4vGu8zq.js">
33
- <link rel="modulepreload" href="/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.ECMu2BdJ.js">
34
- <link rel="modulepreload" href="/docs/assets/chunks/journeyDiagram-VCZTEJTY.BD3WaNbQ.js">
35
- <link rel="modulepreload" href="/docs/assets/chunks/timeline-definition-GMOUNBTQ.C7LgNVAL.js">
36
- <link rel="modulepreload" href="/docs/assets/chunks/mindmap-definition-QFDTVHPH.BELznv3-.js">
37
- <link rel="modulepreload" href="/docs/assets/chunks/kanban-definition-6JOO6SKY.Ca0o4Tqz.js">
38
- <link rel="modulepreload" href="/docs/assets/chunks/sankeyDiagram-XADWPNL6.XRTutBnb.js">
39
- <link rel="modulepreload" href="/docs/assets/chunks/diagram-TYMM5635.CYU9eGFu.js">
40
- <link rel="modulepreload" href="/docs/assets/chunks/diagram-MMDJMWI5.D4r13DvJ.js">
41
- <link rel="modulepreload" href="/docs/assets/chunks/blockDiagram-DXYQGD6D.xY3EX59q.js">
42
- <link rel="modulepreload" href="/docs/assets/chunks/diagram-5BDNPKRD.CLt9uOyL.js">
43
- <link rel="modulepreload" href="/docs/assets/chunks/architectureDiagram-Q4EWVU46.9m9ObyuE.js">
44
- <link rel="modulepreload" href="/docs/assets/chunks/ishikawaDiagram-UXIWVN3A.D4tPGtVo.js">
45
- <link rel="modulepreload" href="/docs/assets/chunks/vennDiagram-DHZGUBPP.HUwoZcy_.js">
46
- <link rel="modulepreload" href="/docs/assets/chunks/diagram-G4DWMVQ6.DpczEm1G.js">
47
- <link rel="modulepreload" href="/docs/assets/chunks/wardleyDiagram-NUSXRM2D.B2pSo5rB.js">
17
+ <link rel="modulepreload" href="/docs/assets/chunks/dagre-KV5264BT.Dq1daUru.js">
18
+ <link rel="modulepreload" href="/docs/assets/chunks/cose-bilkent-S5V4N54A.D5za6aH0.js">
19
+ <link rel="modulepreload" href="/docs/assets/chunks/c4Diagram-AHTNJAMY.CyLg6Ovc.js">
20
+ <link rel="modulepreload" href="/docs/assets/chunks/flowDiagram-DWJPFMVM.C58Z9uPK.js">
21
+ <link rel="modulepreload" href="/docs/assets/chunks/erDiagram-SMLLAGMA.DI4TNkye.js">
22
+ <link rel="modulepreload" href="/docs/assets/chunks/gitGraphDiagram-UUTBAWPF.B955oaFl.js">
23
+ <link rel="modulepreload" href="/docs/assets/chunks/ganttDiagram-T4ZO3ILL.DXSpW809.js">
24
+ <link rel="modulepreload" href="/docs/assets/chunks/infoDiagram-42DDH7IO.Dozj_-Gm.js">
25
+ <link rel="modulepreload" href="/docs/assets/chunks/pieDiagram-DEJITSTG.BVYvElmY.js">
26
+ <link rel="modulepreload" href="/docs/assets/chunks/quadrantDiagram-34T5L4WZ.C6Gc2mdY.js">
27
+ <link rel="modulepreload" href="/docs/assets/chunks/xychartDiagram-5P7HB3ND.haEiSxqc.js">
28
+ <link rel="modulepreload" href="/docs/assets/chunks/requirementDiagram-MS252O5E.DWa8b4cn.js">
29
+ <link rel="modulepreload" href="/docs/assets/chunks/sequenceDiagram-FGHM5R23.DlU3vVN9.js">
30
+ <link rel="modulepreload" href="/docs/assets/chunks/classDiagram-6PBFFD2Q.CsJJyx6-.js">
31
+ <link rel="modulepreload" href="/docs/assets/chunks/classDiagram-v2-HSJHXN6E.CsJJyx6-.js">
32
+ <link rel="modulepreload" href="/docs/assets/chunks/stateDiagram-FHFEXIEX.CeqJRqnU.js">
33
+ <link rel="modulepreload" href="/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.DE0BnUZh.js">
34
+ <link rel="modulepreload" href="/docs/assets/chunks/journeyDiagram-VCZTEJTY.DrqrMhCk.js">
35
+ <link rel="modulepreload" href="/docs/assets/chunks/timeline-definition-GMOUNBTQ.Cqf2kjq9.js">
36
+ <link rel="modulepreload" href="/docs/assets/chunks/mindmap-definition-QFDTVHPH.BBfpYTea.js">
37
+ <link rel="modulepreload" href="/docs/assets/chunks/kanban-definition-6JOO6SKY.Dv-LTrlw.js">
38
+ <link rel="modulepreload" href="/docs/assets/chunks/sankeyDiagram-XADWPNL6.Bi-g4ajv.js">
39
+ <link rel="modulepreload" href="/docs/assets/chunks/diagram-TYMM5635.Dx2FVhCr.js">
40
+ <link rel="modulepreload" href="/docs/assets/chunks/diagram-MMDJMWI5.BOzMEkAr.js">
41
+ <link rel="modulepreload" href="/docs/assets/chunks/blockDiagram-DXYQGD6D.Bs6XxFpe.js">
42
+ <link rel="modulepreload" href="/docs/assets/chunks/diagram-5BDNPKRD.j1YL5BKS.js">
43
+ <link rel="modulepreload" href="/docs/assets/chunks/architectureDiagram-Q4EWVU46.SlHEknkX.js">
44
+ <link rel="modulepreload" href="/docs/assets/chunks/ishikawaDiagram-UXIWVN3A.D2140OzH.js">
45
+ <link rel="modulepreload" href="/docs/assets/chunks/vennDiagram-DHZGUBPP.BeOpE_lM.js">
46
+ <link rel="modulepreload" href="/docs/assets/chunks/diagram-G4DWMVQ6.Bi1aLdhC.js">
47
+ <link rel="modulepreload" href="/docs/assets/chunks/wardleyDiagram-NUSXRM2D.BXS65dAC.js">
48
48
  <link rel="modulepreload" href="/docs/assets/chunks/virtual_mermaid-config.DDnGl6nM.js">
49
49
  <link rel="modulepreload" href="/docs/assets/quickstart.md.r-oE8nkX.lean.js">
50
50
  <script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
@@ -53,7 +53,7 @@
53
53
  <link rel="alternate" type="text/markdown" href="/docs/quickstart.md">
54
54
  </head>
55
55
  <body>
56
- <div id="app"><div class="Layout" data-v-738a160a><!--[--><!--]--><!--[--><span tabindex="-1" data-v-a98c2453></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-a98c2453>Skip to content</a><!--]--><!----><header class="VPNav" data-v-738a160a data-v-76ad4059><div class="VPNavBar" data-v-76ad4059 data-v-6fc2afcb><div class="wrapper" data-v-6fc2afcb><div class="container" data-v-6fc2afcb><div class="title" data-v-6fc2afcb><div class="VPNavBarTitle has-sidebar" data-v-6fc2afcb data-v-9e6caa3f><a class="title" href="/docs/" data-v-9e6caa3f><!--[--><!--]--><!----><span data-v-9e6caa3f>Agent SDK</span><!--[--><!--[--><!--[--><!--[--><span class="bdk-version" title="Agent SDK 0.3.0 (@grok/agent-sdk package)" data-v-a03aeddf>0.3.0</span><!--]--><!--]--><!--]--><!--]--></a></div></div><div class="content" data-v-6fc2afcb><div class="content-body" data-v-6fc2afcb><!--[--><!--]--><div class="VPNavBarSearch search" data-v-6fc2afcb><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-6fc2afcb data-v-78f72f99><span id="main-nav-aria-label" class="visually-hidden" data-v-78f72f99> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/docs/quickstart.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Quickstart</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/guides/mcp-oauth.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Guides</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/guides/github.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Integrations</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/templates/reviews.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Templates</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/reference/project-layout.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Reference</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-6fc2afcb data-v-bf7c3d0f><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-bf7c3d0f data-v-e9e166e4 data-v-74f7b0ff><span class="check" data-v-74f7b0ff><span class="icon" data-v-74f7b0ff><!--[--><span class="vpi-sun sun" data-v-e9e166e4></span><span class="vpi-moon moon" data-v-e9e166e4></span><!--]--></span></span></button></div><!----><div class="VPFlyout VPNavBarExtra extra" data-v-6fc2afcb data-v-799c9281 data-v-070c9767><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-070c9767><span class="vpi-more-horizontal icon" data-v-070c9767></span></button><div class="menu" data-v-070c9767><div class="VPMenu" data-v-070c9767 data-v-c05d27ee><!----><!--[--><!--[--><!----><div class="group" data-v-799c9281><div class="item appearance" data-v-799c9281><p class="label" data-v-799c9281>Appearance</p><div class="appearance-action" data-v-799c9281><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-799c9281 data-v-e9e166e4 data-v-74f7b0ff><span class="check" data-v-74f7b0ff><span class="icon" data-v-74f7b0ff><!--[--><span class="vpi-sun sun" data-v-e9e166e4></span><span class="vpi-moon moon" data-v-e9e166e4></span><!--]--></span></span></button></div></div></div><!----><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-6fc2afcb data-v-2caaf84e><span class="container" data-v-2caaf84e><span class="top" data-v-2caaf84e></span><span class="middle" data-v-2caaf84e></span><span class="bottom" data-v-2caaf84e></span></span></button></div></div></div></div><div class="divider" data-v-6fc2afcb><div class="divider-line" data-v-6fc2afcb></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-738a160a data-v-e0cbfd80><div class="container" data-v-e0cbfd80><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-e0cbfd80><span class="vpi-align-left menu-icon" data-v-e0cbfd80></span><span class="menu-text" data-v-e0cbfd80>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-e0cbfd80 data-v-36e0b8e9><button data-v-36e0b8e9>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-738a160a data-v-2859715e><div class="curtain" data-v-2859715e></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-2859715e><span class="visually-hidden" id="sidebar-aria-label" data-v-2859715e> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 has-active" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Getting started</h2><!----></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/changelog.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Changelog</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/quickstart.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Build a PR reviewer</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Integrations</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/github.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>GitHub</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/slack.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Slack</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/webhooks.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Webhooks</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/convert-automation.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Cursor Automations</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/opentelemetry.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>OpenTelemetry</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/gitlab.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>GitLab</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/bitbucket.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Bitbucket</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/pagerduty.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>PagerDuty</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Extensions</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/extensions.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/cloud-agents.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Cloud agents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/improve.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Self-improvement</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/jev.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Jev</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Guides</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/mcp-oauth.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>MCP</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/agent-to-agent.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Peer agents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/deployment.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Deployment</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/migrate.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Early-alpha migration</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/evals.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Evals</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/hillclimbing.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Hillclimbing</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/building-with-agents.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Build with a coding agent</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/troubleshooting.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Troubleshooting</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Templates</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/templates/reviews.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Review and triage</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/templates/agentic-owners.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Agentic Approver</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Reference</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/project-layout.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Project layout</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/agent-config.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Agent config</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/instructions.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Instructions</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/tools.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Tools</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/skills.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Skills</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/connections.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>MCP Connections</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/subagents.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Subagents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/channels.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Channels</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/schedules.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Schedules & reminders</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/hooks.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Hooks</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/memory.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Memory</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/evals.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Evals</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/artifacts.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Artifacts</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/sessions.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Sessions & streaming</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/playground.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Playground</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/cli.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>CLI</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/http-api.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>HTTP API</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/access.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Access</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/limits.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Limits</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-738a160a data-v-9f462cdf><div class="VPDoc has-sidebar has-aside" data-v-9f462cdf data-v-995f90b4><!--[--><!--]--><div class="container" data-v-995f90b4><div class="aside" data-v-995f90b4><div class="aside-curtain" data-v-995f90b4></div><div class="aside-container" data-v-995f90b4><div class="aside-content" data-v-995f90b4><div class="VPDocAside" data-v-995f90b4 data-v-10889960><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-10889960 data-v-afb61a88><div class="content" data-v-afb61a88><div class="outline-marker" data-v-afb61a88></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-afb61a88>On this page</div><ul class="VPDocOutlineItem root" data-v-afb61a88 data-v-0587367d><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-10889960></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-995f90b4><div class="content-container" data-v-995f90b4><!--[--><!--]--><main class="main" data-v-995f90b4><div style="position:relative;" class="vp-doc _docs_quickstart" data-v-995f90b4><div><h1 id="build-a-pr-reviewer-with-agent-sdk" tabindex="-1">Build a PR reviewer with Agent SDK <a class="header-anchor" href="#build-a-pr-reviewer-with-agent-sdk" aria-label="Permalink to &quot;Build a PR reviewer with Agent SDK&quot;">​</a></h1><p>You&#39;ll build a reviewer that rates each pull request as <code>trivial</code>, <code>moderate</code>, or <code>large</code>, then approves safe changes or asks for a human review.</p><p>When it&#39;s deployed, you&#39;ll manage it in <a href="https://cursor.com/dashboard/deployed-agents" target="_blank" rel="noreferrer">Deployed Agents</a>.</p><h2 id="build-it-with-a-coding-agent" tabindex="-1">Build it with a coding agent <a class="header-anchor" href="#build-it-with-a-coding-agent" aria-label="Permalink to &quot;Build it with a coding agent&quot;">​</a></h2><p>Paste this prompt into your coding agent to build the reviewer from this page. The sections after it walk through the same steps by hand.</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>Build the PR reviewer from https://cursor.com/docs/agent-sdk/quickstart.md</span></span>
56
+ <div id="app"><div class="Layout" data-v-738a160a><!--[--><!--]--><!--[--><span tabindex="-1" data-v-a98c2453></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-a98c2453>Skip to content</a><!--]--><!----><header class="VPNav" data-v-738a160a data-v-76ad4059><div class="VPNavBar" data-v-76ad4059 data-v-6fc2afcb><div class="wrapper" data-v-6fc2afcb><div class="container" data-v-6fc2afcb><div class="title" data-v-6fc2afcb><div class="VPNavBarTitle has-sidebar" data-v-6fc2afcb data-v-9e6caa3f><a class="title" href="/docs/" data-v-9e6caa3f><!--[--><!--]--><!----><span data-v-9e6caa3f>Agent SDK</span><!--[--><!--[--><!--[--><!--[--><span class="bdk-version" title="Agent SDK 0.4.0 (@grok/agent-sdk package)" data-v-a03aeddf>0.4.0</span><!--]--><!--]--><!--]--><!--]--></a></div></div><div class="content" data-v-6fc2afcb><div class="content-body" data-v-6fc2afcb><!--[--><!--]--><div class="VPNavBarSearch search" data-v-6fc2afcb><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-6fc2afcb data-v-78f72f99><span id="main-nav-aria-label" class="visually-hidden" data-v-78f72f99> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/docs/quickstart.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Quickstart</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/guides/mcp-oauth.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Guides</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/guides/github.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Integrations</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/templates/reviews.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Templates</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/reference/project-layout.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Reference</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-6fc2afcb data-v-bf7c3d0f><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-bf7c3d0f data-v-e9e166e4 data-v-74f7b0ff><span class="check" data-v-74f7b0ff><span class="icon" data-v-74f7b0ff><!--[--><span class="vpi-sun sun" data-v-e9e166e4></span><span class="vpi-moon moon" data-v-e9e166e4></span><!--]--></span></span></button></div><!----><div class="VPFlyout VPNavBarExtra extra" data-v-6fc2afcb data-v-799c9281 data-v-070c9767><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-070c9767><span class="vpi-more-horizontal icon" data-v-070c9767></span></button><div class="menu" data-v-070c9767><div class="VPMenu" data-v-070c9767 data-v-c05d27ee><!----><!--[--><!--[--><!----><div class="group" data-v-799c9281><div class="item appearance" data-v-799c9281><p class="label" data-v-799c9281>Appearance</p><div class="appearance-action" data-v-799c9281><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-799c9281 data-v-e9e166e4 data-v-74f7b0ff><span class="check" data-v-74f7b0ff><span class="icon" data-v-74f7b0ff><!--[--><span class="vpi-sun sun" data-v-e9e166e4></span><span class="vpi-moon moon" data-v-e9e166e4></span><!--]--></span></span></button></div></div></div><!----><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-6fc2afcb data-v-2caaf84e><span class="container" data-v-2caaf84e><span class="top" data-v-2caaf84e></span><span class="middle" data-v-2caaf84e></span><span class="bottom" data-v-2caaf84e></span></span></button></div></div></div></div><div class="divider" data-v-6fc2afcb><div class="divider-line" data-v-6fc2afcb></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-738a160a data-v-e0cbfd80><div class="container" data-v-e0cbfd80><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-e0cbfd80><span class="vpi-align-left menu-icon" data-v-e0cbfd80></span><span class="menu-text" data-v-e0cbfd80>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-e0cbfd80 data-v-36e0b8e9><button data-v-36e0b8e9>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-738a160a data-v-2859715e><div class="curtain" data-v-2859715e></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-2859715e><span class="visually-hidden" id="sidebar-aria-label" data-v-2859715e> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 has-active" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Getting started</h2><!----></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/changelog.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Changelog</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/quickstart.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Build a PR reviewer</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Integrations</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/github.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>GitHub</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/slack.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Slack</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/webhooks.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Webhooks</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/convert-automation.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Cursor Automations</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/opentelemetry.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>OpenTelemetry</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/gitlab.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>GitLab</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/bitbucket.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Bitbucket</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/pagerduty.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>PagerDuty</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Extensions</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/extensions.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/cloud-agents.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Cloud agents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/improve.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Self-improvement</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/jev.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Jev</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Guides</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/mcp-oauth.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>MCP</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/agent-to-agent.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Peer agents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/deployment.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Deployment</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/migrate.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Early-alpha migration</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/evals.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Evals</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/hillclimbing.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Hillclimbing</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/building-with-agents.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Build with a coding agent</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/troubleshooting.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Troubleshooting</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Templates</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/templates/reviews.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Review and triage</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/templates/agentic-owners.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Agentic Approver</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Reference</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/project-layout.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Project layout</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/agent-config.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Agent config</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/instructions.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Instructions</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/tools.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Tools</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/skills.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Skills</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/connections.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>MCP Connections</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/subagents.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Subagents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/channels.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Channels</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/schedules.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Schedules & reminders</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/hooks.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Hooks</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/memory.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Memory</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/evals.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Evals</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/artifacts.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Artifacts</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/sessions.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Sessions & streaming</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/playground.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Playground</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/cli.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>CLI</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/http-api.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>HTTP API</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/access.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Access</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/limits.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Limits</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-738a160a data-v-9f462cdf><div class="VPDoc has-sidebar has-aside" data-v-9f462cdf data-v-995f90b4><!--[--><!--]--><div class="container" data-v-995f90b4><div class="aside" data-v-995f90b4><div class="aside-curtain" data-v-995f90b4></div><div class="aside-container" data-v-995f90b4><div class="aside-content" data-v-995f90b4><div class="VPDocAside" data-v-995f90b4 data-v-10889960><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-10889960 data-v-afb61a88><div class="content" data-v-afb61a88><div class="outline-marker" data-v-afb61a88></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-afb61a88>On this page</div><ul class="VPDocOutlineItem root" data-v-afb61a88 data-v-0587367d><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-10889960></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-995f90b4><div class="content-container" data-v-995f90b4><!--[--><!--]--><main class="main" data-v-995f90b4><div style="position:relative;" class="vp-doc _docs_quickstart" data-v-995f90b4><div><h1 id="build-a-pr-reviewer-with-agent-sdk" tabindex="-1">Build a PR reviewer with Agent SDK <a class="header-anchor" href="#build-a-pr-reviewer-with-agent-sdk" aria-label="Permalink to &quot;Build a PR reviewer with Agent SDK&quot;">​</a></h1><p>You&#39;ll build a reviewer that rates each pull request as <code>trivial</code>, <code>moderate</code>, or <code>large</code>, then approves safe changes or asks for a human review.</p><p>When it&#39;s deployed, you&#39;ll manage it in <a href="https://cursor.com/dashboard/deployed-agents" target="_blank" rel="noreferrer">Deployed Agents</a>.</p><h2 id="build-it-with-a-coding-agent" tabindex="-1">Build it with a coding agent <a class="header-anchor" href="#build-it-with-a-coding-agent" aria-label="Permalink to &quot;Build it with a coding agent&quot;">​</a></h2><p>Paste this prompt into your coding agent to build the reviewer from this page. The sections after it walk through the same steps by hand.</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>Build the PR reviewer from https://cursor.com/docs/agent-sdk/quickstart.md</span></span>
57
57
  <span class="line"><span>in ./pr-reviewer. Fetch that page and follow each step in order.</span></span>
58
58
  <span class="line"><span></span></span>
59
59
  <span class="line"><span>- If agent-sdk isn&#39;t on PATH, install it with</span></span>
@@ -166,7 +166,7 @@
166
166
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> };</span></span>
167
167
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
168
168
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>With <code>agent-sdk dev</code> running, replay an open pull request. Pull access is enough:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">agent-sdk</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> github</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> replay</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> https://github.com/acme/checkout/pull/42</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --dir</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> .</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --action</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> opened</span></span></code></pre></div><p>Open the playground and confirm <code>Review acme/checkout#42</code> shows both tool calls and the verdict.</p><h2 id="deploy-the-reviewer" tabindex="-1">Deploy the reviewer <a class="header-anchor" href="#deploy-the-reviewer" aria-label="Permalink to &quot;Deploy the reviewer&quot;">​</a></h2><p>Follow <a href="./deployment.html">Deployment</a> to run <code>agent-sdk deploy</code>, then manage the reviewer in <a href="https://cursor.com/dashboard/deployed-agents" target="_blank" rel="noreferrer">Deployed Agents</a>.</p><h2 id="where-to-go-next" tabindex="-1">Where to go next <a class="header-anchor" href="#where-to-go-next" aria-label="Permalink to &quot;Where to go next&quot;">​</a></h2><ul><li>Turn these two PRs into regression checks with <a href="./evals.html">Evals</a>.</li><li>Read about typed tools in <a href="./reference/tools.html">Tools</a>.</li><li>Set up fixtures and forwarding with the <a href="./guides/github.html">GitHub guide</a>.</li></ul></div></div></main><footer class="VPDocFooter" data-v-995f90b4 data-v-8edf72db><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-8edf72db><span class="visually-hidden" id="doc-footer-aria-label" data-v-8edf72db>Pager</span><div class="pager" data-v-8edf72db><a class="VPLink link pager-link prev" href="/docs/changelog.html" data-v-8edf72db><!--[--><span class="desc" data-v-8edf72db>Previous page</span><span class="title" data-v-8edf72db>Changelog</span><!--]--></a></div><div class="pager" data-v-8edf72db><a class="VPLink link pager-link next" href="/docs/guides/github.html" data-v-8edf72db><!--[--><span class="desc" data-v-8edf72db>Next page</span><span class="title" data-v-8edf72db>GitHub</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
169
- <script>window.__VP_HASH_MAP__=JSON.parse("{\"building-with-agents.md\":\"BqJ7AAjG\",\"changelog.md\":\"BWhC6DET\",\"deployment.md\":\"BtqJrHhp\",\"evals.md\":\"Dne6VRmZ\",\"guides_agent-to-agent.md\":\"BcmSqL2z\",\"guides_bitbucket.md\":\"BiA6ZMFW\",\"guides_cloud-agents.md\":\"CiXAW6on\",\"guides_convert-automation.md\":\"BvTxsJ8J\",\"guides_github.md\":\"6jiEH7dg\",\"guides_gitlab.md\":\"DcKusOcU\",\"guides_improve.md\":\"o3WOGR7n\",\"guides_jev.md\":\"DGCzkMUN\",\"guides_mcp-oauth.md\":\"C-Sx_IPa\",\"guides_migrate.md\":\"BbhHYeCr\",\"guides_opentelemetry.md\":\"BRSktBHt\",\"guides_pagerduty.md\":\"pMXUkZZc\",\"guides_slack.md\":\"BgIGG9ur\",\"guides_webhooks.md\":\"B5DXt2v1\",\"hillclimbing.md\":\"3TkdF79A\",\"index.md\":\"DRfaoRCZ\",\"quickstart.md\":\"r-oE8nkX\",\"reference_access.md\":\"C5lblfUC\",\"reference_agent-config.md\":\"C0Tp_Fk9\",\"reference_artifacts.md\":\"BJpAI7h9\",\"reference_channels.md\":\"CPWOpdsC\",\"reference_cli.md\":\"B8GdpaRj\",\"reference_connections.md\":\"DoY4vrDH\",\"reference_evals.md\":\"DgfUtfIc\",\"reference_extensions.md\":\"DHbW6eOf\",\"reference_hooks.md\":\"CSWmOwMM\",\"reference_http-api.md\":\"C7Cb0r2J\",\"reference_instructions.md\":\"CV6Qq0UX\",\"reference_limits.md\":\"CbdtFr4T\",\"reference_memory.md\":\"CdoJISM-\",\"reference_playground.md\":\"DIUsRAcy\",\"reference_project-layout.md\":\"9DiKoE16\",\"reference_schedules.md\":\"RhQ9ZLo1\",\"reference_sessions.md\":\"NXVQt9mP\",\"reference_skills.md\":\"DzCPNPkG\",\"reference_subagents.md\":\"Dvpq2sUu\",\"reference_tools.md\":\"B2OaR1Nb\",\"templates_agentic-owners.md\":\"B6ZmKAzT\",\"templates_reviews.md\":\"dr9Xv_KM\",\"troubleshooting.md\":\"DfKKvW1R\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Agent SDK\",\"description\":\"Build and serve bots and agents from versioned Markdown and TypeScript.\",\"base\":\"/docs/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"sdkVersion\":\"0.3.0\",\"nav\":[{\"text\":\"Quickstart\",\"link\":\"/quickstart\"},{\"text\":\"Guides\",\"link\":\"/guides/mcp-oauth\"},{\"text\":\"Integrations\",\"link\":\"/guides/github\"},{\"text\":\"Templates\",\"link\":\"/templates/reviews\"},{\"text\":\"Reference\",\"link\":\"/reference/project-layout\"}],\"search\":{\"provider\":\"local\"},\"outline\":{\"level\":[2,3]},\"sidebar\":[{\"text\":\"Getting started\",\"items\":[{\"text\":\"Overview\",\"link\":\"/\"},{\"text\":\"Changelog\",\"link\":\"/changelog\"},{\"text\":\"Build a PR reviewer\",\"link\":\"/quickstart\"}]},{\"text\":\"Integrations\",\"collapsed\":false,\"items\":[{\"text\":\"GitHub\",\"link\":\"/guides/github\"},{\"text\":\"Slack\",\"link\":\"/guides/slack\"},{\"text\":\"Webhooks\",\"link\":\"/guides/webhooks\"},{\"text\":\"Cursor Automations\",\"link\":\"/guides/convert-automation\"},{\"text\":\"OpenTelemetry\",\"link\":\"/guides/opentelemetry\"},{\"text\":\"GitLab\",\"link\":\"/guides/gitlab\"},{\"text\":\"Bitbucket\",\"link\":\"/guides/bitbucket\"},{\"text\":\"PagerDuty\",\"link\":\"/guides/pagerduty\"}]},{\"text\":\"Extensions\",\"collapsed\":false,\"items\":[{\"text\":\"Overview\",\"link\":\"/reference/extensions\"},{\"text\":\"Cloud agents\",\"link\":\"/guides/cloud-agents\"},{\"text\":\"Self-improvement\",\"link\":\"/guides/improve\"},{\"text\":\"Jev\",\"link\":\"/guides/jev\"}]},{\"text\":\"Guides\",\"collapsed\":false,\"items\":[{\"text\":\"MCP\",\"link\":\"/guides/mcp-oauth\"},{\"text\":\"Peer agents\",\"link\":\"/guides/agent-to-agent\"},{\"text\":\"Deployment\",\"link\":\"/deployment\"},{\"text\":\"Early-alpha migration\",\"link\":\"/guides/migrate\"},{\"text\":\"Evals\",\"link\":\"/evals\"},{\"text\":\"Hillclimbing\",\"link\":\"/hillclimbing\"},{\"text\":\"Build with a coding agent\",\"link\":\"/building-with-agents\"},{\"text\":\"Troubleshooting\",\"link\":\"/troubleshooting\"}]},{\"text\":\"Templates\",\"collapsed\":false,\"items\":[{\"text\":\"Review and triage\",\"link\":\"/templates/reviews\"},{\"text\":\"Agentic Approver\",\"link\":\"/templates/agentic-owners\"}]},{\"text\":\"Reference\",\"collapsed\":false,\"items\":[{\"text\":\"Project layout\",\"link\":\"/reference/project-layout\"},{\"text\":\"Agent config\",\"link\":\"/reference/agent-config\"},{\"text\":\"Instructions\",\"link\":\"/reference/instructions\"},{\"text\":\"Tools\",\"link\":\"/reference/tools\"},{\"text\":\"Skills\",\"link\":\"/reference/skills\"},{\"text\":\"MCP Connections\",\"link\":\"/reference/connections\"},{\"text\":\"Subagents\",\"link\":\"/reference/subagents\"},{\"text\":\"Channels\",\"link\":\"/reference/channels\"},{\"text\":\"Schedules & reminders\",\"link\":\"/reference/schedules\"},{\"text\":\"Hooks\",\"link\":\"/reference/hooks\"},{\"text\":\"Memory\",\"link\":\"/reference/memory\"},{\"text\":\"Evals\",\"link\":\"/reference/evals\"},{\"text\":\"Artifacts\",\"link\":\"/reference/artifacts\"},{\"text\":\"Sessions & streaming\",\"link\":\"/reference/sessions\"},{\"text\":\"Playground\",\"link\":\"/reference/playground\"},{\"text\":\"CLI\",\"link\":\"/reference/cli\"},{\"text\":\"HTTP API\",\"link\":\"/reference/http-api\"},{\"text\":\"Access\",\"link\":\"/reference/access\"},{\"text\":\"Limits\",\"link\":\"/reference/limits\"}]}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
169
+ <script>window.__VP_HASH_MAP__=JSON.parse("{\"building-with-agents.md\":\"Bo3ct-rf\",\"changelog.md\":\"b6H_ea44\",\"deployment.md\":\"DJtuDVLh\",\"evals.md\":\"Dne6VRmZ\",\"guides_agent-to-agent.md\":\"DcB3nhOz\",\"guides_bitbucket.md\":\"BiA6ZMFW\",\"guides_cloud-agents.md\":\"CiXAW6on\",\"guides_convert-automation.md\":\"BvTxsJ8J\",\"guides_github.md\":\"CcuZ7keS\",\"guides_gitlab.md\":\"DcKusOcU\",\"guides_improve.md\":\"o3WOGR7n\",\"guides_jev.md\":\"DGCzkMUN\",\"guides_mcp-oauth.md\":\"GVPMKcYl\",\"guides_migrate.md\":\"B8CZxnnX\",\"guides_opentelemetry.md\":\"BRSktBHt\",\"guides_pagerduty.md\":\"pMXUkZZc\",\"guides_slack.md\":\"D7Rwyva4\",\"guides_webhooks.md\":\"B5DXt2v1\",\"hillclimbing.md\":\"M51bF-oT\",\"index.md\":\"DnJPj_B6\",\"quickstart.md\":\"r-oE8nkX\",\"reference_access.md\":\"C5lblfUC\",\"reference_agent-config.md\":\"BSNp2uJ7\",\"reference_artifacts.md\":\"BJpAI7h9\",\"reference_channels.md\":\"CPWOpdsC\",\"reference_cli.md\":\"DHm6DmYk\",\"reference_connections.md\":\"DoY4vrDH\",\"reference_evals.md\":\"DgfUtfIc\",\"reference_extensions.md\":\"DHbW6eOf\",\"reference_hooks.md\":\"vbIM394-\",\"reference_http-api.md\":\"C7Cb0r2J\",\"reference_instructions.md\":\"CV6Qq0UX\",\"reference_limits.md\":\"CbdtFr4T\",\"reference_memory.md\":\"CdoJISM-\",\"reference_playground.md\":\"DIUsRAcy\",\"reference_project-layout.md\":\"9DiKoE16\",\"reference_schedules.md\":\"Dd8_d0WG\",\"reference_sessions.md\":\"NXVQt9mP\",\"reference_skills.md\":\"DzCPNPkG\",\"reference_subagents.md\":\"Dvpq2sUu\",\"reference_tools.md\":\"B2OaR1Nb\",\"templates_agentic-owners.md\":\"B6ZmKAzT\",\"templates_reviews.md\":\"dr9Xv_KM\",\"troubleshooting.md\":\"DfKKvW1R\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Agent SDK\",\"description\":\"Build and serve bots and agents from versioned Markdown and TypeScript.\",\"base\":\"/docs/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"sdkVersion\":\"0.4.0\",\"nav\":[{\"text\":\"Quickstart\",\"link\":\"/quickstart\"},{\"text\":\"Guides\",\"link\":\"/guides/mcp-oauth\"},{\"text\":\"Integrations\",\"link\":\"/guides/github\"},{\"text\":\"Templates\",\"link\":\"/templates/reviews\"},{\"text\":\"Reference\",\"link\":\"/reference/project-layout\"}],\"search\":{\"provider\":\"local\"},\"outline\":{\"level\":[2,3]},\"sidebar\":[{\"text\":\"Getting started\",\"items\":[{\"text\":\"Overview\",\"link\":\"/\"},{\"text\":\"Changelog\",\"link\":\"/changelog\"},{\"text\":\"Build a PR reviewer\",\"link\":\"/quickstart\"}]},{\"text\":\"Integrations\",\"collapsed\":false,\"items\":[{\"text\":\"GitHub\",\"link\":\"/guides/github\"},{\"text\":\"Slack\",\"link\":\"/guides/slack\"},{\"text\":\"Webhooks\",\"link\":\"/guides/webhooks\"},{\"text\":\"Cursor Automations\",\"link\":\"/guides/convert-automation\"},{\"text\":\"OpenTelemetry\",\"link\":\"/guides/opentelemetry\"},{\"text\":\"GitLab\",\"link\":\"/guides/gitlab\"},{\"text\":\"Bitbucket\",\"link\":\"/guides/bitbucket\"},{\"text\":\"PagerDuty\",\"link\":\"/guides/pagerduty\"}]},{\"text\":\"Extensions\",\"collapsed\":false,\"items\":[{\"text\":\"Overview\",\"link\":\"/reference/extensions\"},{\"text\":\"Cloud agents\",\"link\":\"/guides/cloud-agents\"},{\"text\":\"Self-improvement\",\"link\":\"/guides/improve\"},{\"text\":\"Jev\",\"link\":\"/guides/jev\"}]},{\"text\":\"Guides\",\"collapsed\":false,\"items\":[{\"text\":\"MCP\",\"link\":\"/guides/mcp-oauth\"},{\"text\":\"Peer agents\",\"link\":\"/guides/agent-to-agent\"},{\"text\":\"Deployment\",\"link\":\"/deployment\"},{\"text\":\"Early-alpha migration\",\"link\":\"/guides/migrate\"},{\"text\":\"Evals\",\"link\":\"/evals\"},{\"text\":\"Hillclimbing\",\"link\":\"/hillclimbing\"},{\"text\":\"Build with a coding agent\",\"link\":\"/building-with-agents\"},{\"text\":\"Troubleshooting\",\"link\":\"/troubleshooting\"}]},{\"text\":\"Templates\",\"collapsed\":false,\"items\":[{\"text\":\"Review and triage\",\"link\":\"/templates/reviews\"},{\"text\":\"Agentic Approver\",\"link\":\"/templates/agentic-owners\"}]},{\"text\":\"Reference\",\"collapsed\":false,\"items\":[{\"text\":\"Project layout\",\"link\":\"/reference/project-layout\"},{\"text\":\"Agent config\",\"link\":\"/reference/agent-config\"},{\"text\":\"Instructions\",\"link\":\"/reference/instructions\"},{\"text\":\"Tools\",\"link\":\"/reference/tools\"},{\"text\":\"Skills\",\"link\":\"/reference/skills\"},{\"text\":\"MCP Connections\",\"link\":\"/reference/connections\"},{\"text\":\"Subagents\",\"link\":\"/reference/subagents\"},{\"text\":\"Channels\",\"link\":\"/reference/channels\"},{\"text\":\"Schedules & reminders\",\"link\":\"/reference/schedules\"},{\"text\":\"Hooks\",\"link\":\"/reference/hooks\"},{\"text\":\"Memory\",\"link\":\"/reference/memory\"},{\"text\":\"Evals\",\"link\":\"/reference/evals\"},{\"text\":\"Artifacts\",\"link\":\"/reference/artifacts\"},{\"text\":\"Sessions & streaming\",\"link\":\"/reference/sessions\"},{\"text\":\"Playground\",\"link\":\"/reference/playground\"},{\"text\":\"CLI\",\"link\":\"/reference/cli\"},{\"text\":\"HTTP API\",\"link\":\"/reference/http-api\"},{\"text\":\"Access\",\"link\":\"/reference/access\"},{\"text\":\"Limits\",\"link\":\"/reference/limits\"}]}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
170
170
 
171
171
  </body>
172
172
  </html>