@grok/agent-sdk 0.2.29 → 0.3.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 (396) hide show
  1. package/dist/channels/slack/cli-project.js +1 -1
  2. package/dist/docs/404.html +2 -2
  3. package/dist/docs/assets/{app.DMrZKFjI.js → app.BzTUBOAD.js} +4 -4
  4. package/dist/docs/assets/building-with-agents.md.BqJ7AAjG.js +6 -0
  5. package/dist/docs/assets/{building-with-agents.md.Bf1yH2tG.lean.js → building-with-agents.md.BqJ7AAjG.lean.js} +1 -1
  6. package/dist/docs/assets/changelog.md.BWhC6DET.js +1 -0
  7. package/dist/docs/assets/changelog.md.BWhC6DET.lean.js +1 -0
  8. package/dist/docs/assets/chunks/@localSearchIndexroot.CWxwVoCG.js +1 -0
  9. package/dist/docs/assets/chunks/{VPLocalSearchBox.DQvuw1KA.js → VPLocalSearchBox.DsnRlUT5.js} +1 -1
  10. package/dist/docs/assets/chunks/{arc.ahOG-Qza.js → arc.DH8GOhiv.js} +1 -1
  11. package/dist/docs/assets/chunks/{architectureDiagram-Q4EWVU46.BcgfYNO_.js → architectureDiagram-Q4EWVU46.9m9ObyuE.js} +1 -1
  12. package/dist/docs/assets/chunks/{baseUniq.DeIYZrWh.js → baseUniq.BXHpx1lE.js} +1 -1
  13. package/dist/docs/assets/chunks/{blockDiagram-DXYQGD6D.HjJ2goMX.js → blockDiagram-DXYQGD6D.xY3EX59q.js} +1 -1
  14. package/dist/docs/assets/chunks/{c4Diagram-AHTNJAMY.C1QTb9GM.js → c4Diagram-AHTNJAMY.DnqgMVgc.js} +1 -1
  15. package/dist/docs/assets/chunks/channel.Cctv0f7X.js +1 -0
  16. package/dist/docs/assets/chunks/{chunk-4BX2VUAB.UuZiDiVp.js → chunk-4BX2VUAB.BjFxK2A3.js} +1 -1
  17. package/dist/docs/assets/chunks/{chunk-4TB4RGXK.5A3YmkhI.js → chunk-4TB4RGXK.BujS_Spt.js} +1 -1
  18. package/dist/docs/assets/chunks/{chunk-55IACEB6.B4uf1yYV.js → chunk-55IACEB6.YbTjhdaM.js} +1 -1
  19. package/dist/docs/assets/chunks/{chunk-EDXVE4YY.CoXBce8t.js → chunk-EDXVE4YY.DnQ8t4GC.js} +1 -1
  20. package/dist/docs/assets/chunks/{chunk-FMBD7UC4.DnC5NO4e.js → chunk-FMBD7UC4.B67AwAmj.js} +1 -1
  21. package/dist/docs/assets/chunks/{chunk-OYMX7WX6.CzfHCeIi.js → chunk-OYMX7WX6.DrZIAFOm.js} +1 -1
  22. package/dist/docs/assets/chunks/{chunk-QZHKN3VN.C6tcwkVd.js → chunk-QZHKN3VN.BLmmydkn.js} +1 -1
  23. package/dist/docs/assets/chunks/{chunk-YZCP3GAM._oboyZ1A.js → chunk-YZCP3GAM.DaoOfw0O.js} +1 -1
  24. package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.DU5sqchW.js +1 -0
  25. package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.DU5sqchW.js +1 -0
  26. package/dist/docs/assets/chunks/clone.B9rdNt6j.js +1 -0
  27. package/dist/docs/assets/chunks/{cose-bilkent-S5V4N54A.BfPVKeId.js → cose-bilkent-S5V4N54A.DMQuNhM5.js} +1 -1
  28. package/dist/docs/assets/chunks/{dagre-KV5264BT.CLMLc0lD.js → dagre-KV5264BT.CZoGVuUf.js} +1 -1
  29. package/dist/docs/assets/chunks/{diagram-5BDNPKRD.C7OF7UfH.js → diagram-5BDNPKRD.CLt9uOyL.js} +1 -1
  30. package/dist/docs/assets/chunks/{diagram-G4DWMVQ6.Dpao0Bl1.js → diagram-G4DWMVQ6.DpczEm1G.js} +1 -1
  31. package/dist/docs/assets/chunks/{diagram-MMDJMWI5.DLnM9eLp.js → diagram-MMDJMWI5.D4r13DvJ.js} +1 -1
  32. package/dist/docs/assets/chunks/{diagram-TYMM5635.BcpVgA_M.js → diagram-TYMM5635.CYU9eGFu.js} +1 -1
  33. package/dist/docs/assets/chunks/{erDiagram-SMLLAGMA.CsL5JuCV.js → erDiagram-SMLLAGMA.QA9naWEw.js} +1 -1
  34. package/dist/docs/assets/chunks/{flowDiagram-DWJPFMVM.MFihq9AF.js → flowDiagram-DWJPFMVM.BbNoVZYd.js} +1 -1
  35. package/dist/docs/assets/chunks/{ganttDiagram-T4ZO3ILL.CJeLodyG.js → ganttDiagram-T4ZO3ILL.IHjDoG7r.js} +1 -1
  36. package/dist/docs/assets/chunks/{gitGraphDiagram-UUTBAWPF.1HhlE45Z.js → gitGraphDiagram-UUTBAWPF.B21VMdf5.js} +1 -1
  37. package/dist/docs/assets/chunks/{graph.BS02KkWA.js → graph.DgJ4L-8V.js} +1 -1
  38. package/dist/docs/assets/chunks/{infoDiagram-42DDH7IO.fp5gvytQ.js → infoDiagram-42DDH7IO.CQjrcthc.js} +1 -1
  39. package/dist/docs/assets/chunks/{ishikawaDiagram-UXIWVN3A.C6Wk1V4I.js → ishikawaDiagram-UXIWVN3A.D4tPGtVo.js} +1 -1
  40. package/dist/docs/assets/chunks/{journeyDiagram-VCZTEJTY.qJt4uJ_H.js → journeyDiagram-VCZTEJTY.BD3WaNbQ.js} +1 -1
  41. package/dist/docs/assets/chunks/{kanban-definition-6JOO6SKY.z2tG9kly.js → kanban-definition-6JOO6SKY.Ca0o4Tqz.js} +1 -1
  42. package/dist/docs/assets/chunks/{layout.BPCkdejr.js → layout.DXXqX4MQ.js} +1 -1
  43. package/dist/docs/assets/chunks/{linear.CL3TC3u7.js → linear.5c61gNw4.js} +1 -1
  44. package/dist/docs/assets/chunks/{min.SPrSp704.js → min.B1-NAjHX.js} +1 -1
  45. package/dist/docs/assets/chunks/{mindmap-definition-QFDTVHPH.DgrQRFZW.js → mindmap-definition-QFDTVHPH.BELznv3-.js} +1 -1
  46. package/dist/docs/assets/chunks/{pieDiagram-DEJITSTG.Ba7yxiW2.js → pieDiagram-DEJITSTG.qPzO1mq5.js} +1 -1
  47. package/dist/docs/assets/chunks/{quadrantDiagram-34T5L4WZ.Bvskad4p.js → quadrantDiagram-34T5L4WZ.CxIvzbjX.js} +1 -1
  48. package/dist/docs/assets/chunks/{requirementDiagram-MS252O5E.Ce70ugV9.js → requirementDiagram-MS252O5E.CqA0iJx8.js} +1 -1
  49. package/dist/docs/assets/chunks/{sankeyDiagram-XADWPNL6.BJ5OEULO.js → sankeyDiagram-XADWPNL6.XRTutBnb.js} +1 -1
  50. package/dist/docs/assets/chunks/{sequenceDiagram-FGHM5R23.C8a1hDs6.js → sequenceDiagram-FGHM5R23.E--7bRLQ.js} +1 -1
  51. package/dist/docs/assets/chunks/{stateDiagram-FHFEXIEX.D2D8A5CK.js → stateDiagram-FHFEXIEX.C4vGu8zq.js} +1 -1
  52. package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.ECMu2BdJ.js +1 -0
  53. package/dist/docs/assets/chunks/{theme.DRciHmS1.js → theme.DMj_7q3B.js} +2 -2
  54. package/dist/docs/assets/chunks/{timeline-definition-GMOUNBTQ.C4ePrY8-.js → timeline-definition-GMOUNBTQ.C7LgNVAL.js} +1 -1
  55. package/dist/docs/assets/chunks/{vennDiagram-DHZGUBPP.Dzso6dEA.js → vennDiagram-DHZGUBPP.HUwoZcy_.js} +1 -1
  56. package/dist/docs/assets/chunks/{wardley-RL74JXVD.djgXR0ar.js → wardley-RL74JXVD.BxFEFYZS.js} +1 -1
  57. package/dist/docs/assets/chunks/{wardleyDiagram-NUSXRM2D.Bf2ICxjh.js → wardleyDiagram-NUSXRM2D.B2pSo5rB.js} +1 -1
  58. package/dist/docs/assets/chunks/{xychartDiagram-5P7HB3ND.DEH4BcVJ.js → xychartDiagram-5P7HB3ND.NQhMiOOL.js} +1 -1
  59. package/dist/docs/assets/deployment.md.BtqJrHhp.js +31 -0
  60. package/dist/docs/assets/{deployment.md.KW0Ni_rY.lean.js → deployment.md.BtqJrHhp.lean.js} +1 -1
  61. package/dist/docs/assets/evals.md.Dne6VRmZ.js +49 -0
  62. package/dist/docs/assets/evals.md.Dne6VRmZ.lean.js +1 -0
  63. package/dist/docs/assets/{guides_agent-to-agent.md.D1D5f6Jc.js → guides_agent-to-agent.md.BcmSqL2z.js} +8 -8
  64. package/dist/docs/assets/guides_agent-to-agent.md.BcmSqL2z.lean.js +1 -0
  65. package/dist/docs/assets/{guides_bitbucket.md.DkjkBRU8.js → guides_bitbucket.md.BiA6ZMFW.js} +27 -27
  66. package/dist/docs/assets/{guides_bitbucket.md.DkjkBRU8.lean.js → guides_bitbucket.md.BiA6ZMFW.lean.js} +1 -1
  67. package/dist/docs/assets/guides_cloud-agents.md.CiXAW6on.js +9 -0
  68. package/dist/docs/assets/{guides_cloud-agents.md.Ceyjv0ul.lean.js → guides_cloud-agents.md.CiXAW6on.lean.js} +1 -1
  69. package/dist/docs/assets/guides_convert-automation.md.BvTxsJ8J.js +26 -0
  70. package/dist/docs/assets/{guides_convert-automation.md.BjraCvok.lean.js → guides_convert-automation.md.BvTxsJ8J.lean.js} +1 -1
  71. package/dist/docs/assets/{guides_github.md.CgN5sNbW.js → guides_github.md.6jiEH7dg.js} +11 -19
  72. package/dist/docs/assets/{guides_github.md.CgN5sNbW.lean.js → guides_github.md.6jiEH7dg.lean.js} +1 -1
  73. package/dist/docs/assets/{guides_gitlab.md.DCE0p7_w.js → guides_gitlab.md.DcKusOcU.js} +63 -73
  74. package/dist/docs/assets/{guides_gitlab.md.DCE0p7_w.lean.js → guides_gitlab.md.DcKusOcU.lean.js} +1 -1
  75. package/dist/docs/assets/guides_improve.md.o3WOGR7n.js +16 -0
  76. package/dist/docs/assets/{guides_improve.md.BFYtrtLE.lean.js → guides_improve.md.o3WOGR7n.lean.js} +1 -1
  77. package/dist/docs/assets/{guides_jev.md.CEqLgjj9.js → guides_jev.md.DGCzkMUN.js} +20 -60
  78. package/dist/docs/assets/{guides_jev.md.CEqLgjj9.lean.js → guides_jev.md.DGCzkMUN.lean.js} +1 -1
  79. package/dist/docs/assets/{guides_mcp-oauth.md.DrGY92u4.js → guides_mcp-oauth.md.C-Sx_IPa.js} +3 -5
  80. package/dist/docs/assets/{guides_mcp-oauth.md.DrGY92u4.lean.js → guides_mcp-oauth.md.C-Sx_IPa.lean.js} +1 -1
  81. package/dist/docs/assets/guides_migrate.md.BbhHYeCr.js +3 -0
  82. package/dist/docs/assets/{guides_migrate.md.RS9Eu-Xh.lean.js → guides_migrate.md.BbhHYeCr.lean.js} +1 -1
  83. package/dist/docs/assets/guides_opentelemetry.md.BRSktBHt.js +26 -0
  84. package/dist/docs/assets/guides_opentelemetry.md.BRSktBHt.lean.js +1 -0
  85. package/dist/docs/assets/guides_pagerduty.md.pMXUkZZc.js +61 -0
  86. package/dist/docs/assets/guides_pagerduty.md.pMXUkZZc.lean.js +1 -0
  87. package/dist/docs/assets/guides_slack.md.BgIGG9ur.js +82 -0
  88. package/dist/docs/assets/{guides_slack.md.BwXHURvY.lean.js → guides_slack.md.BgIGG9ur.lean.js} +1 -1
  89. package/dist/docs/assets/{guides_webhooks.md.BJk63ZTs.js → guides_webhooks.md.B5DXt2v1.js} +7 -7
  90. package/dist/docs/assets/{guides_webhooks.md.BJk63ZTs.lean.js → guides_webhooks.md.B5DXt2v1.lean.js} +1 -1
  91. package/dist/docs/assets/hillclimbing.md.3TkdF79A.js +5 -0
  92. package/dist/docs/assets/hillclimbing.md.3TkdF79A.lean.js +1 -0
  93. package/dist/docs/assets/index.md.DRfaoRCZ.js +20 -0
  94. package/dist/docs/assets/{index.md.CAruw_rp.lean.js → index.md.DRfaoRCZ.lean.js} +1 -1
  95. package/dist/docs/assets/quickstart.md.r-oE8nkX.js +113 -0
  96. package/dist/docs/assets/{quickstart.md.CljDaJBi.lean.js → quickstart.md.r-oE8nkX.lean.js} +1 -1
  97. package/dist/docs/assets/reference_access.md.C5lblfUC.js +1 -0
  98. package/dist/docs/assets/reference_access.md.C5lblfUC.lean.js +1 -0
  99. package/dist/docs/assets/reference_agent-config.md.C0Tp_Fk9.js +27 -0
  100. package/dist/docs/assets/{reference_agent-config.md.Ck29qYNj.lean.js → reference_agent-config.md.C0Tp_Fk9.lean.js} +1 -1
  101. package/dist/docs/assets/reference_artifacts.md.BJpAI7h9.js +17 -0
  102. package/dist/docs/assets/{reference_artifacts.md.C-hKR2hp.lean.js → reference_artifacts.md.BJpAI7h9.lean.js} +1 -1
  103. package/dist/docs/assets/reference_channels.md.CPWOpdsC.js +21 -0
  104. package/dist/docs/assets/{reference_channels.md.DsJfGSBJ.lean.js → reference_channels.md.CPWOpdsC.lean.js} +1 -1
  105. package/dist/docs/assets/reference_cli.md.B8GdpaRj.js +83 -0
  106. package/dist/docs/assets/reference_cli.md.B8GdpaRj.lean.js +1 -0
  107. package/dist/docs/assets/reference_connections.md.DoY4vrDH.js +54 -0
  108. package/dist/docs/assets/{reference_connections.md.BoAotr7_.lean.js → reference_connections.md.DoY4vrDH.lean.js} +1 -1
  109. package/dist/docs/assets/reference_evals.md.DgfUtfIc.js +69 -0
  110. package/dist/docs/assets/{reference_evals.md.2BXeMiO2.lean.js → reference_evals.md.DgfUtfIc.lean.js} +1 -1
  111. package/dist/docs/assets/{reference_extensions.md.DI5X5x8p.js → reference_extensions.md.DHbW6eOf.js} +6 -8
  112. package/dist/docs/assets/{reference_extensions.md.DI5X5x8p.lean.js → reference_extensions.md.DHbW6eOf.lean.js} +1 -1
  113. package/dist/docs/assets/reference_hooks.md.CSWmOwMM.js +39 -0
  114. package/dist/docs/assets/reference_hooks.md.CSWmOwMM.lean.js +1 -0
  115. package/dist/docs/assets/reference_http-api.md.C7Cb0r2J.js +7 -0
  116. package/dist/docs/assets/{reference_http-api.md._RWELr3d.lean.js → reference_http-api.md.C7Cb0r2J.lean.js} +1 -1
  117. package/dist/docs/assets/reference_instructions.md.CV6Qq0UX.js +14 -0
  118. package/dist/docs/assets/reference_instructions.md.CV6Qq0UX.lean.js +1 -0
  119. package/dist/docs/assets/reference_limits.md.CbdtFr4T.js +8 -0
  120. package/dist/docs/assets/reference_limits.md.CbdtFr4T.lean.js +1 -0
  121. package/dist/docs/assets/reference_memory.md.CdoJISM-.js +3 -0
  122. package/dist/docs/assets/{reference_memory.md.Dd7cyV9V.lean.js → reference_memory.md.CdoJISM-.lean.js} +1 -1
  123. package/dist/docs/assets/reference_playground.md.DIUsRAcy.js +1 -0
  124. package/dist/docs/assets/{reference_playground.md.CQiJk9CM.lean.js → reference_playground.md.DIUsRAcy.lean.js} +1 -1
  125. package/dist/docs/assets/reference_project-layout.md.9DiKoE16.js +26 -0
  126. package/dist/docs/assets/reference_project-layout.md.9DiKoE16.lean.js +1 -0
  127. package/dist/docs/assets/reference_schedules.md.RhQ9ZLo1.js +45 -0
  128. package/dist/docs/assets/{reference_schedules.md.RC47aFm4.lean.js → reference_schedules.md.RhQ9ZLo1.lean.js} +1 -1
  129. package/dist/docs/assets/reference_sessions.md.NXVQt9mP.js +22 -0
  130. package/dist/docs/assets/{reference_sessions.md.C7KFhWXV.lean.js → reference_sessions.md.NXVQt9mP.lean.js} +1 -1
  131. package/dist/docs/assets/{reference_skills.md.Dej2zQxi.js → reference_skills.md.DzCPNPkG.js} +4 -4
  132. package/dist/docs/assets/{reference_skills.md.Dej2zQxi.lean.js → reference_skills.md.DzCPNPkG.lean.js} +1 -1
  133. package/dist/docs/assets/reference_subagents.md.Dvpq2sUu.js +10 -0
  134. package/dist/docs/assets/{reference_subagents.md.CAhvW4yS.lean.js → reference_subagents.md.Dvpq2sUu.lean.js} +1 -1
  135. package/dist/docs/assets/reference_tools.md.B2OaR1Nb.js +62 -0
  136. package/dist/docs/assets/{reference_tools.md.DQr7Fnhu.lean.js → reference_tools.md.B2OaR1Nb.lean.js} +1 -1
  137. package/dist/docs/assets/templates_agentic-owners.md.B6ZmKAzT.js +13 -0
  138. package/dist/docs/assets/{templates_agentic-owners.md.Dh2nDSqg.lean.js → templates_agentic-owners.md.B6ZmKAzT.lean.js} +1 -1
  139. package/dist/docs/assets/templates_reviews.md.dr9Xv_KM.js +10 -0
  140. package/dist/docs/assets/templates_reviews.md.dr9Xv_KM.lean.js +1 -0
  141. package/dist/docs/assets/troubleshooting.md.DfKKvW1R.js +3 -0
  142. package/dist/docs/assets/{troubleshooting.md.CGOdNVAL.lean.js → troubleshooting.md.DfKKvW1R.lean.js} +1 -1
  143. package/dist/docs/building-with-agents.html +41 -44
  144. package/dist/docs/building-with-agents.md +11 -104
  145. package/dist/docs/changelog.html +37 -37
  146. package/dist/docs/changelog.md +5 -155
  147. package/dist/docs/deployment.html +54 -54
  148. package/dist/docs/deployment.md +83 -262
  149. package/dist/docs/evals.html +52 -71
  150. package/dist/docs/evals.md +33 -129
  151. package/dist/docs/guides/agent-to-agent.html +43 -43
  152. package/dist/docs/guides/agent-to-agent.md +27 -64
  153. package/dist/docs/guides/bitbucket.html +62 -62
  154. package/dist/docs/guides/bitbucket.md +73 -134
  155. package/dist/docs/guides/cloud-agents.html +37 -37
  156. package/dist/docs/guides/cloud-agents.md +23 -53
  157. package/dist/docs/guides/convert-automation.html +39 -56
  158. package/dist/docs/guides/convert-automation.md +31 -115
  159. package/dist/docs/guides/github.html +46 -54
  160. package/dist/docs/guides/github.md +49 -131
  161. package/dist/docs/guides/gitlab.html +98 -108
  162. package/dist/docs/guides/gitlab.md +104 -184
  163. package/dist/docs/guides/improve.html +38 -43
  164. package/dist/docs/guides/improve.md +24 -90
  165. package/dist/docs/guides/jev.html +55 -95
  166. package/dist/docs/guides/jev.md +53 -160
  167. package/dist/docs/guides/mcp-oauth.html +38 -40
  168. package/dist/docs/guides/mcp-oauth.md +33 -67
  169. package/dist/docs/guides/migrate.html +38 -43
  170. package/dist/docs/guides/migrate.md +56 -130
  171. package/dist/docs/guides/opentelemetry.html +41 -43
  172. package/dist/docs/guides/opentelemetry.md +32 -27
  173. package/dist/docs/guides/pagerduty.html +50 -49
  174. package/dist/docs/guides/pagerduty.md +65 -199
  175. package/dist/docs/guides/slack.html +51 -57
  176. package/dist/docs/guides/slack.md +76 -204
  177. package/dist/docs/guides/webhooks.html +42 -42
  178. package/dist/docs/guides/webhooks.md +64 -146
  179. package/dist/docs/hashmap.json +1 -1
  180. package/dist/docs/hillclimbing.html +40 -42
  181. package/dist/docs/hillclimbing.md +40 -102
  182. package/dist/docs/index.html +55 -61
  183. package/dist/docs/index.md +49 -83
  184. package/dist/docs/llms-full.txt +2262 -5721
  185. package/dist/docs/llms.txt +9 -14
  186. package/dist/docs/quickstart.html +95 -152
  187. package/dist/docs/quickstart.md +91 -180
  188. package/dist/docs/reference/access.html +36 -36
  189. package/dist/docs/reference/access.md +7 -12
  190. package/dist/docs/reference/agent-config.html +43 -56
  191. package/dist/docs/reference/agent-config.md +91 -174
  192. package/dist/docs/reference/artifacts.html +38 -39
  193. package/dist/docs/reference/artifacts.md +38 -62
  194. package/dist/docs/reference/channels.html +38 -39
  195. package/dist/docs/reference/channels.md +102 -151
  196. package/dist/docs/reference/cli.html +68 -84
  197. package/dist/docs/reference/cli.md +232 -697
  198. package/dist/docs/reference/connections.html +45 -57
  199. package/dist/docs/reference/connections.md +83 -164
  200. package/dist/docs/reference/evals.html +47 -54
  201. package/dist/docs/reference/evals.md +75 -141
  202. package/dist/docs/reference/extensions.html +41 -43
  203. package/dist/docs/reference/extensions.md +37 -70
  204. package/dist/docs/reference/hooks.html +40 -52
  205. package/dist/docs/reference/hooks.md +62 -133
  206. package/dist/docs/reference/http-api.html +38 -42
  207. package/dist/docs/reference/http-api.md +66 -118
  208. package/dist/docs/reference/instructions.html +39 -39
  209. package/dist/docs/reference/instructions.md +19 -29
  210. package/dist/docs/reference/limits.html +38 -38
  211. package/dist/docs/reference/limits.md +9 -21
  212. package/dist/docs/reference/memory.html +37 -38
  213. package/dist/docs/reference/memory.md +38 -75
  214. package/dist/docs/reference/playground.html +36 -36
  215. package/dist/docs/reference/playground.md +14 -22
  216. package/dist/docs/reference/project-layout.html +49 -48
  217. package/dist/docs/reference/project-layout.md +38 -84
  218. package/dist/docs/reference/schedules.html +46 -48
  219. package/dist/docs/reference/schedules.md +59 -90
  220. package/dist/docs/reference/sessions.html +37 -37
  221. package/dist/docs/reference/sessions.md +66 -113
  222. package/dist/docs/reference/skills.html +39 -39
  223. package/dist/docs/reference/skills.md +11 -31
  224. package/dist/docs/reference/subagents.html +37 -37
  225. package/dist/docs/reference/subagents.md +17 -31
  226. package/dist/docs/reference/tools.html +47 -64
  227. package/dist/docs/reference/tools.md +48 -130
  228. package/dist/docs/templates/agentic-owners.html +38 -38
  229. package/dist/docs/templates/agentic-owners.md +50 -74
  230. package/dist/docs/templates/reviews.html +69 -0
  231. package/dist/docs/templates/reviews.md +71 -0
  232. package/dist/docs/troubleshooting.html +38 -36
  233. package/dist/docs/troubleshooting.md +48 -101
  234. package/dist/internal/cli-deploy.js +1 -1
  235. package/dist/internal/cli-docs.js +1 -1
  236. package/dist/internal/cli-images.js +1 -1
  237. package/dist/internal/cli-skills.js +1 -1
  238. package/dist/internal/cursor/credentials.js +1 -1
  239. package/dist/internal/deploy-manifest.d.ts +1 -0
  240. package/dist/internal/deploy-manifest.d.ts.map +1 -1
  241. package/dist/internal/deploy-manifest.js +0 -1
  242. package/dist/internal/discovery/agent-config.d.ts +2 -6
  243. package/dist/internal/discovery/agent-config.d.ts.map +1 -1
  244. package/dist/internal/discovery/agent-config.js +8 -25
  245. package/dist/internal/discovery/agent.d.ts.map +1 -1
  246. package/dist/internal/discovery/agent.js +2 -3
  247. package/dist/internal/discovery/project.d.ts.map +1 -1
  248. package/dist/internal/discovery/project.js +15 -0
  249. package/dist/internal/init-project.d.ts.map +1 -1
  250. package/dist/internal/init-project.js +7 -5
  251. package/dist/internal/reminder-runner.js +1 -1
  252. package/dist/internal/session-engine.js +1 -1
  253. package/dist/internal/shallow-clone.js +1 -1
  254. package/dist/playground/assets/index-D6mVn9og.js +62 -0
  255. package/dist/playground/assets/index-DlALM6gr.css +1 -0
  256. package/dist/playground/index.html +2 -2
  257. package/dist/types.d.ts +4 -17
  258. package/dist/types.d.ts.map +1 -1
  259. package/docs/README.md +49 -83
  260. package/docs/building-with-agents.md +11 -104
  261. package/docs/changelog.md +6 -156
  262. package/docs/deployment.md +83 -262
  263. package/docs/evals.md +34 -130
  264. package/docs/guides/agent-to-agent.md +27 -64
  265. package/docs/guides/bitbucket.md +73 -134
  266. package/docs/guides/cloud-agents.md +23 -53
  267. package/docs/guides/convert-automation.md +31 -115
  268. package/docs/guides/github.md +49 -131
  269. package/docs/guides/gitlab.md +104 -184
  270. package/docs/guides/improve.md +24 -90
  271. package/docs/guides/jev.md +53 -160
  272. package/docs/guides/mcp-oauth.md +33 -67
  273. package/docs/guides/migrate.md +56 -130
  274. package/docs/guides/opentelemetry.md +37 -27
  275. package/docs/guides/pagerduty.md +68 -200
  276. package/docs/guides/slack.md +76 -204
  277. package/docs/guides/webhooks.md +64 -146
  278. package/docs/hillclimbing.md +41 -103
  279. package/docs/quickstart.md +91 -180
  280. package/docs/reference/access.md +7 -12
  281. package/docs/reference/agent-config.md +91 -174
  282. package/docs/reference/artifacts.md +38 -62
  283. package/docs/reference/channels.md +102 -151
  284. package/docs/reference/cli.md +232 -697
  285. package/docs/reference/connections.md +83 -164
  286. package/docs/reference/evals.md +75 -141
  287. package/docs/reference/extensions.md +37 -70
  288. package/docs/reference/hooks.md +61 -132
  289. package/docs/reference/http-api.md +66 -118
  290. package/docs/reference/instructions.md +20 -30
  291. package/docs/reference/limits.md +10 -22
  292. package/docs/reference/memory.md +38 -75
  293. package/docs/reference/playground.md +14 -22
  294. package/docs/reference/project-layout.md +38 -84
  295. package/docs/reference/schedules.md +59 -90
  296. package/docs/reference/sessions.md +66 -113
  297. package/docs/reference/skills.md +12 -32
  298. package/docs/reference/subagents.md +17 -31
  299. package/docs/reference/tools.md +48 -130
  300. package/docs/templates/agentic-owners.md +50 -74
  301. package/docs/templates/reviews.md +76 -0
  302. package/docs/troubleshooting.md +48 -101
  303. package/package.json +2 -2
  304. package/skills/deploy/SKILL.md +1 -1
  305. package/skills/migrate-v2/SKILL.md +0 -1
  306. package/dist/docs/assets/building-with-agents.md.Bf1yH2tG.js +0 -9
  307. package/dist/docs/assets/changelog.md.DrLFQUlu.js +0 -1
  308. package/dist/docs/assets/changelog.md.DrLFQUlu.lean.js +0 -1
  309. package/dist/docs/assets/chunks/@localSearchIndexroot.Dpd_wxVU.js +0 -1
  310. package/dist/docs/assets/chunks/channel._fZX_hvU.js +0 -1
  311. package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.eClS1Q0E.js +0 -1
  312. package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.eClS1Q0E.js +0 -1
  313. package/dist/docs/assets/chunks/clone.W1Phdw9P.js +0 -1
  314. package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.77yf4kRr.js +0 -1
  315. package/dist/docs/assets/deployment.md.KW0Ni_rY.js +0 -31
  316. package/dist/docs/assets/evals.md.DiljU__Z.js +0 -68
  317. package/dist/docs/assets/evals.md.DiljU__Z.lean.js +0 -1
  318. package/dist/docs/assets/guides_agent-to-agent.md.D1D5f6Jc.lean.js +0 -1
  319. package/dist/docs/assets/guides_cloud-agents.md.Ceyjv0ul.js +0 -9
  320. package/dist/docs/assets/guides_convert-automation.md.BjraCvok.js +0 -43
  321. package/dist/docs/assets/guides_hooks.md.BjeEiM7s.js +0 -54
  322. package/dist/docs/assets/guides_hooks.md.BjeEiM7s.lean.js +0 -1
  323. package/dist/docs/assets/guides_improve.md.BFYtrtLE.js +0 -21
  324. package/dist/docs/assets/guides_migrate.md.RS9Eu-Xh.js +0 -8
  325. package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.js +0 -28
  326. package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.lean.js +0 -1
  327. package/dist/docs/assets/guides_pagerduty.md.mnKXe9U0.js +0 -60
  328. package/dist/docs/assets/guides_pagerduty.md.mnKXe9U0.lean.js +0 -1
  329. package/dist/docs/assets/guides_slack.md.BwXHURvY.js +0 -88
  330. package/dist/docs/assets/hillclimbing.md.By61f3uq.js +0 -7
  331. package/dist/docs/assets/hillclimbing.md.By61f3uq.lean.js +0 -1
  332. package/dist/docs/assets/index.md.CAruw_rp.js +0 -26
  333. package/dist/docs/assets/quickstart.md.CljDaJBi.js +0 -170
  334. package/dist/docs/assets/reference_access.md.CEtibb4i.js +0 -1
  335. package/dist/docs/assets/reference_access.md.CEtibb4i.lean.js +0 -1
  336. package/dist/docs/assets/reference_agent-config.md.Ck29qYNj.js +0 -40
  337. package/dist/docs/assets/reference_artifacts.md.C-hKR2hp.js +0 -18
  338. package/dist/docs/assets/reference_channels.md.DsJfGSBJ.js +0 -22
  339. package/dist/docs/assets/reference_cli.md.BkdLRbXg.js +0 -99
  340. package/dist/docs/assets/reference_cli.md.BkdLRbXg.lean.js +0 -1
  341. package/dist/docs/assets/reference_connections.md.BoAotr7_.js +0 -66
  342. package/dist/docs/assets/reference_evals.md.2BXeMiO2.js +0 -76
  343. package/dist/docs/assets/reference_hooks.md.B-bwJuiG.js +0 -51
  344. package/dist/docs/assets/reference_hooks.md.B-bwJuiG.lean.js +0 -1
  345. package/dist/docs/assets/reference_http-api.md._RWELr3d.js +0 -11
  346. package/dist/docs/assets/reference_instructions.md.yL2hXLnl.js +0 -14
  347. package/dist/docs/assets/reference_instructions.md.yL2hXLnl.lean.js +0 -1
  348. package/dist/docs/assets/reference_limits.md.BCCnvt3o.js +0 -8
  349. package/dist/docs/assets/reference_limits.md.BCCnvt3o.lean.js +0 -1
  350. package/dist/docs/assets/reference_memory.md.Dd7cyV9V.js +0 -4
  351. package/dist/docs/assets/reference_playground.md.CQiJk9CM.js +0 -1
  352. package/dist/docs/assets/reference_project-layout.md.BamcPDUn.js +0 -25
  353. package/dist/docs/assets/reference_project-layout.md.BamcPDUn.lean.js +0 -1
  354. package/dist/docs/assets/reference_prompt.md.BMjm1Jp3.js +0 -9
  355. package/dist/docs/assets/reference_prompt.md.BMjm1Jp3.lean.js +0 -1
  356. package/dist/docs/assets/reference_schedules.md.RC47aFm4.js +0 -47
  357. package/dist/docs/assets/reference_sessions.md.C7KFhWXV.js +0 -22
  358. package/dist/docs/assets/reference_subagents.md.CAhvW4yS.js +0 -10
  359. package/dist/docs/assets/reference_tools.md.DQr7Fnhu.js +0 -79
  360. package/dist/docs/assets/templates_agentic-owners.md.Dh2nDSqg.js +0 -13
  361. package/dist/docs/assets/templates_security-reviewer.md.DnwXdnB5.js +0 -3
  362. package/dist/docs/assets/templates_security-reviewer.md.DnwXdnB5.lean.js +0 -1
  363. package/dist/docs/assets/templates_thermo-quality-review.md.MJIdHkzE.js +0 -3
  364. package/dist/docs/assets/templates_thermo-quality-review.md.MJIdHkzE.lean.js +0 -1
  365. package/dist/docs/assets/templates_thermo-review.md.DfN1OFOl.js +0 -3
  366. package/dist/docs/assets/templates_thermo-review.md.DfN1OFOl.lean.js +0 -1
  367. package/dist/docs/assets/templates_triage.md.BYWMloV4.js +0 -9
  368. package/dist/docs/assets/templates_triage.md.BYWMloV4.lean.js +0 -1
  369. package/dist/docs/assets/troubleshooting.md.CGOdNVAL.js +0 -1
  370. package/dist/docs/guides/hooks.html +0 -113
  371. package/dist/docs/guides/hooks.md +0 -116
  372. package/dist/docs/package/skills/create-agent/SKILL.md +0 -178
  373. package/dist/docs/package/skills/evals/SKILL.md +0 -145
  374. package/dist/docs/package/skills/github/SKILL.md +0 -133
  375. package/dist/docs/package/skills/hillclimb/SKILL.md +0 -63
  376. package/dist/docs/package/skills/mcp-auth/SKILL.md +0 -60
  377. package/dist/docs/package/skills/migrate-v2/SKILL.md +0 -394
  378. package/dist/docs/package/skills/setup-slack/SKILL.md +0 -136
  379. package/dist/docs/reference/prompt.html +0 -68
  380. package/dist/docs/reference/prompt.md +0 -47
  381. package/dist/docs/templates/security-reviewer.html +0 -62
  382. package/dist/docs/templates/security-reviewer.md +0 -81
  383. package/dist/docs/templates/thermo-quality-review.html +0 -62
  384. package/dist/docs/templates/thermo-quality-review.md +0 -75
  385. package/dist/docs/templates/thermo-review.html +0 -62
  386. package/dist/docs/templates/thermo-review.md +0 -75
  387. package/dist/docs/templates/triage.html +0 -68
  388. package/dist/docs/templates/triage.md +0 -101
  389. package/dist/playground/assets/index-Cl9zvmmf.js +0 -62
  390. package/dist/playground/assets/index-F8b5WvWi.css +0 -1
  391. package/docs/guides/hooks.md +0 -121
  392. package/docs/reference/prompt.md +0 -52
  393. package/docs/templates/security-reviewer.md +0 -86
  394. package/docs/templates/thermo-quality-review.md +0 -80
  395. package/docs/templates/thermo-review.md +0 -80
  396. package/docs/templates/triage.md +0 -106
@@ -5,40 +5,23 @@ description: "Deploy an Agent SDK project from Git with Cursor-managed hosting,
5
5
 
6
6
  # Deploy an Agent SDK project
7
7
 
8
- Deploying an Agent SDK project from a pushed Git ref creates a
9
- stable service. Cursor-managed hosting builds the selected ref and operates the
10
- runtime; self-hosting gives you control of the network, process, and filesystem.
11
-
12
- ## Choose managed hosting or self-hosting
13
-
14
- | Option | Use it when | You manage |
15
- | --- | --- | --- |
16
- | Cursor-managed hosting | You want the shortest path from Git to a running agent | Source, declared egress, secrets, and agent behavior |
17
- | Self-hosting | You need your own network, proxy, filesystem, or process controls | The Node process, TLS, auth, secrets, state, monitoring, and upgrades |
18
-
19
- The rest of this guide starts with managed hosting. The
20
- [self-host recipe](#self-host-securely) uses the same project and HTTP
21
- API.
8
+ Deploy a pushed Git ref as a stable service on Cursor-managed hosting, or
9
+ self-host it when you need your own network or process controls.
22
10
 
23
11
  ## Deploy from Git
24
12
 
25
- Commit and push the exact ref you want to run, then sign in, validate,
26
- and deploy. The preferred CLI is `agent-sdk`.
13
+ Commit and push the ref you want to run, then deploy it:
27
14
 
28
- ```text
15
+ ```bash
29
16
  cd my-agent
30
17
  agent-sdk login
31
- agent-sdk whoami
32
18
  agent-sdk validate
33
19
  agent-sdk deploy
34
20
  ```
35
21
 
36
- The deploy command waits until the runtime is running and prints the stable
37
- deployment URL. Open [Deployed Agents](https://cursor.com/dashboard/deployed-agents) to see the agent and manage it.
22
+ The command waits until the agent is running and prints its URL. Open [Deployed Agents](https://cursor.com/dashboard/deployed-agents) to see the agent and manage it.
38
23
 
39
- `deploy` reads from Git; it does not upload your working tree. Inside a
40
- checkout, it infers the HTTPS origin, current ref, agent path, and slug.
41
- Pass them explicitly when the checkout is not the source you want:
24
+ `deploy` builds the pushed ref, so uncommitted changes don't ship. Pass the source when the checkout is not the one you want:
42
25
 
43
26
  ```text
44
27
  agent-sdk deploy \
@@ -48,54 +31,29 @@ agent-sdk deploy \
48
31
  --slug weather-agent
49
32
  ```
50
33
 
51
- The source repository must be available through the team's repository
52
- integration, and a nested `--path` must contain an installable Agent SDK
53
- project.
54
-
55
34
  ### Connect deployed peers
56
35
 
57
- A team-owned deployment can call another agent deployed by the same team with
58
- `defineConnection({ agent: "weather-agent" })`. Deploy the specialist and the
59
- caller; Cursor-managed hosting resolves the slug and authenticates the call,
60
- so you don't configure a peer URL, header, or secret.
61
-
62
- Redeploy the caller after adding or changing a peer connection. An agent last
63
- deployed before hosted peer connections became available also needs one
64
- redeploy. See [Peer agents](./guides/agent-to-agent.md) for delegation,
65
- session affinity, and local development.
36
+ To call another agent your team deployed, add
37
+ `defineConnection({ agent: "weather-agent" })` to the caller and redeploy
38
+ it. See [Peer agents](./guides/agent-to-agent.md).
66
39
 
67
40
  ### Privacy Mode
68
41
 
69
- A hosted deployment stores a snapshot of its source repository, along
70
- with the sessions, KV, files, and logs the agent creates for your team.
71
- Whether managed hosting is available depends on the privacy setting
72
- that applies to you, which is your team's setting when the team
73
- enforces one:
42
+ Managed hosting stores your repository and the agent's data, so it depends
43
+ on your privacy setting:
74
44
 
75
45
  | Privacy setting | Managed hosting |
76
46
  | --- | --- |
77
47
  | Privacy Mode | Available. Cursor stores deployment data the same way it does without Privacy Mode, and the agent's model requests get the same Privacy Mode handling as your other Cursor requests. |
78
48
  | Privacy Mode (Legacy) | Not available. `deploy`, a hosted session, and an eval run all refuse. |
79
49
 
80
- `deploy` refuses because a deployment stores a snapshot of your
81
- repository. A hosted session refuses, and Cursor does not store the
82
- message. An eval run refuses because it stores prompts and replies.
83
- Switch to Privacy Mode, or ask a team admin when your team enforces
84
- this setting.
85
-
86
- The stored data includes the [memory](./reference/memory.md) journal,
87
- which `agent-sdk init` turns on. The journal holds user messages and the
88
- agent's replies. With Privacy Mode, Cursor stores it only to run your
89
- agent and doesn't train on it.
50
+ Switch to Privacy Mode, or ask a team admin when your team enforces the
51
+ setting.
90
52
 
91
53
  ## Add egress and secrets
92
54
 
93
- Declare the external hosts and secret names the agent needs. Mounted
94
- extensions add the ones they declare, so list only what your own code
95
- calls; `agent-sdk info --dir .` shows the combined list and what each mount
96
- adds. Deploy the agent, then set each value at the hidden prompt.
97
- The next task uses the new value. You do not deploy again to apply
98
- that value.
55
+ Declare the hosts and secret names your code calls. `agent-sdk info --dir .`
56
+ shows them combined with what mounted extensions add.
99
57
 
100
58
  ```ts
101
59
  // bot/agent.ts
@@ -109,57 +67,35 @@ export default defineAgent({
109
67
  });
110
68
  ```
111
69
 
112
- ```text
113
- agent-sdk deploy --dir . --slug weather-agent
70
+ After you deploy, set each value at the hidden prompt. The next task uses
71
+ the new value without another deploy.
72
+
73
+ ```bash
114
74
  agent-sdk secret set weather-agent WEATHER_API_KEY
115
75
  agent-sdk secret list weather-agent
116
76
  ```
117
77
 
118
- Commit secret names, never values. `secret set` accepts names and reads
119
- values without echoing them; `secret list` returns names and creation
120
- times only. Do not pass `NAME=VALUE`, print a secret to verify it, or
121
- put names beginning with reserved `CURSOR_` in `secretNames`.
122
-
123
- A hosted deployment receives its secrets per request, after its modules
124
- are loaded, so code that reads `process.env` while a module is still
125
- loading sees nothing. Read a secret inside the handler, tool, or callback
126
- that needs it, and give an MCP connection its credential as a `${NAME}`
127
- template, which resolves when the connection opens. See
128
- [credentials in headers and env](./reference/connections.md#credentials-in-headers-and-env).
129
-
130
- `agent-sdk deploy` runs the top-level code in your files one time to build
131
- the snapshot. No secrets exist at that time. The snapshot keeps those
132
- values.
133
-
134
- SCM webhook channels go one step further and name their secrets in the
135
- channel definition, as `{ secretName: "GITHUB_WEBHOOK_SECRET" }`, so the
136
- platform can verify each delivery's signature before any compute starts.
137
- `validate` rejects a literal or getter there. The
138
- [GitHub guide](./guides/github.md#other-hosts) shows the named form.
139
-
140
- Enter egress hosts without schemes or paths. An HTTPS host needs no port;
141
- add one, as `clickhouse.example.com:9440`, only for a protocol the proxy
142
- reads no hostname from. The
143
- [Host MCP OAuth guide](./guides/mcp-oauth.md) covers OAuth-backed MCP
144
- servers on a hosted agent.
145
-
146
- Your team egress policy limits `hosting.egressDomains`. `agent-sdk deploy` fails
147
- when a requested host is outside that policy, and the bot that is already
148
- running keeps the policy from its last successful deploy. A bot that lists
149
- no egress hosts receives only the platform base. Architecture v2 stores
150
- that decision on the release, from the hosts the release itself declares.
151
- The server reads those hosts from the engine once the release is healthy.
152
- It does not use a host list sent by the CLI, the portal, or MCP. An older
153
- client that omits the optional field is marked the same way. A new release
154
- with no stored set for that team does not start. On a shared release each
155
- installing team has its own stored set. A release written before this change
156
- keeps its previous behavior.
157
-
158
- A PlanetScale Postgres host (`*.pg.psdb.cloud`) has no port in the
159
- declaration. Under a restricted team mode it is a snapshot key for ports
160
- 5432 and 6432, using the team `CIDR:port` entries that cover every
161
- resolved address. An address outside those entries blocks the deploy. The
162
- snapshot does not pin the addresses from that lookup.
78
+ Commit secret names, never values. Don't pass `NAME=VALUE` to `secret set`
79
+ or use a name that starts with `CURSOR_`.
80
+
81
+ Hosted secrets arrive after your modules load, so read each one inside the
82
+ handler, tool, or callback that needs it. Give an MCP connection a
83
+ [`${NAME}` template](./reference/connections.md#credentials-in-headers-and-env)
84
+ instead.
85
+
86
+ SCM channels take each credential as a named secret, such as
87
+ `{ secretName: "GITHUB_WEBHOOK_SECRET" }`. The channel reads the environment
88
+ variable with that name locally and the deployment secret on Cursor hosting.
89
+ On Cursor hosting, Cursor rejects a badly signed delivery before it reaches your agent. `validate`
90
+ fails on a literal or a getter.
91
+
92
+ 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.
93
+
94
+ Your team's egress policy limits which hosts you can list in
95
+ `hosting.egressDomains`. If you list a host that the policy blocks,
96
+ `agent-sdk deploy` fails and the error names that host. A deployment that
97
+ is already running keeps the policy from its last successful deploy. Ask a
98
+ team admin to add the host, or remove it and deploy again.
163
99
 
164
100
  | Team egress mode | What `agent-sdk deploy` allows |
165
101
  | --- | --- |
@@ -168,92 +104,39 @@ snapshot does not pin the addresses from that lookup.
168
104
  | Defaults + team allowlist | The platform default list, plus the team list. |
169
105
  | Team allowlist only | The team list. |
170
106
 
171
- The platform base is always allowed. A team list cannot remove it. The base
172
- is a small set of exact hosts and a few wildcards the pod needs to install
173
- and run: Cursor API hosts, npm and Yarn registries, Slack, Origin, and the
174
- artifact and Agent Store buckets. `agent-sdk deploy --json` includes those hosts
175
- on `egress.effective`, together with the hosts the team policy allowed.
176
- `agent-sdk deployment --json` includes `egressAllowedDomains`, the hosts from
177
- `hosting.egressDomains` that the last successful deploy allowed.
178
-
179
- A team entry `*.example.com` allows `example.com`, any subdomain, and a
180
- narrower wildcard such as `*.api.example.com`. A bot entry `*.example.com`
181
- does not add `example.com`. List the apex on the bot when the bot calls it.
182
-
183
- A raw TCP host such as `db.example.com:5432` is allowed only when the team
184
- list has a public IPv4 `CIDR:port` entry that contains every address that
185
- name resolves to, on the same port. Private addresses and IPv6 are refused.
186
- When deploy blocks hosts, the error names each host, the team mode, and two
187
- fixes: ask a team admin to add the hosts (admins get the settings link
188
- directly), or remove the hosts from `hosting.egressDomains` and deploy
189
- again.
107
+ No team list can remove the platform base, which includes Cursor's API and
108
+ the npm registry. `agent-sdk deploy --json` lists every allowed host under
109
+ `egress.effective`.
190
110
 
191
- ## Use the hosted agent
111
+ A team entry `*.example.com` allows `example.com`, every subdomain, and
112
+ narrower wildcards such as `*.api.example.com`. An agent entry
113
+ `*.example.com` skips the apex, so list `example.com` too when the agent
114
+ calls it.
192
115
 
193
- ### Verify a hosted turn
116
+ A raw TCP host such as `db.example.com:5432` needs a team `CIDR:port` entry
117
+ that covers every public IPv4 address it resolves to. If your team
118
+ restricts egress, a PlanetScale Postgres host (`*.pg.psdb.cloud`) needs a
119
+ team `CIDR:port` entry for ports 5432 and 6432.
194
120
 
195
- After `deploy` reports `running`, message the deployment from the CLI:
196
-
197
- ```bash
198
- agent-sdk session create --slug weather-agent \
199
- --message "Forecast for Paris" --wait
200
- ```
201
-
202
- The deployment accepts the turn as a delivery and creates the session when
203
- the turn starts. `--wait` polls the delivery until it names the session,
204
- then prints the `sessionId`. Without `--wait`, the output has a
205
- `deliveryId` and `workflowId` but no `sessionId` yet. Add `--read-only` to
206
- check a deployment without side effects: read tools run and write tools are
207
- stubbed.
208
-
209
- You can also find the session in the deployment's recent output, which
210
- prints a `==> ses_... (http) <==` header for each session, or open the
211
- deployment in
212
- [Deployed Agents](https://cursor.com/dashboard/deployed-agents) and select **Sessions**:
213
-
214
- ```bash
215
- agent-sdk logs --prod --once --slug weather-agent
216
- ```
121
+ ## Use the hosted agent
217
122
 
218
- Then follow the turn:
123
+ ### Verify a hosted turn
219
124
 
220
125
  ```bash
126
+ agent-sdk session create --slug weather-agent --message "Forecast for Paris" --wait
221
127
  agent-sdk session get ses_... --prod --slug weather-agent
222
- ```
223
-
224
- The command lists each hosted run with its status and log lines. When the
225
- deployment stored process output, a `Process output:` section prints that
226
- output. `agent-sdk logs --prod` prints the same process output that [Deployed Agents](https://cursor.com/dashboard/deployed-agents) shows
227
- for a persistent deployment, under `==> process-output <==`. Pass the session
228
- ID to also print that session's process output under `Session process output:`
229
- and a `tool <name>` line for each tool call. While the turn is still working, the session command reports how
230
- many events have arrived and prints `Turn running; runs may lag behind events.`
231
- Rerun it until the latest run shows a final status such as `finished`. A
232
- high-effort turn can take several minutes, and its run can show no logs
233
- until it ends, so a growing event count is the progress signal.
234
-
235
- To see which tools the bot called, print the hosted events:
236
-
237
- ```bash
238
128
  agent-sdk session get ses_... --prod --slug weather-agent --view events
129
+ agent-sdk logs --prod --slug weather-agent
239
130
  ```
240
131
 
241
- Each tool call is an `actions.requested` or `action.result` event. The tool
242
- name is `toolName`.
243
-
244
- To continue the same conversation, pass `--session ses_...` to
245
- `session create`. `agent-sdk session get ses_... --prod --slug weather-agent --web`
246
- opens the session in the [Deployed Agents](https://cursor.com/dashboard/deployed-agents) playground. Hosted deployments don't
247
- support `agent-sdk chat`, `tool call`, `--view cost`, or `mcp`; use
248
- `session create`, `logs --prod`, `session list --prod`, and
249
- `session get --prod` instead.
132
+ Without `--wait`, the command returns before the session exists, so the
133
+ output has no `sessionId` yet. A long turn can show `running` with no logs
134
+ for several minutes. If the event count keeps going up, the turn is still
135
+ working.
250
136
 
251
137
  ### Send work to the deployment
252
138
 
253
- A hosted agent wakes from its channels: Slack mentions and DMs, SCM
254
- events, and custom channel routes. External HTTP clients call a custom
255
- route on the stable alias URL and send the alias token on every
256
- request:
139
+ Call a custom route on the stable alias URL with the alias token:
257
140
 
258
141
  ```bash
259
142
  curl -X POST "$AGENT_ALIAS_URL/v1/channels/tickets/ticket" \
@@ -262,65 +145,35 @@ curl -X POST "$AGENT_ALIAS_URL/v1/channels/tickets/ticket" \
262
145
  -d '{"ticketId":"ENG-142","message":"CSV export returns 500"}'
263
146
  ```
264
147
 
265
- The deployment answers `202 Accepted` with an empty body as soon as the
266
- request arrives, then runs the route's handler, so the caller never
267
- receives a session ID or a result. Deliver results from the channel, as
268
- described in [Route responses](./reference/channels.md#route-responses).
269
-
270
- To confirm the work started, find the new session with
271
- `agent-sdk logs --prod` and follow it with `agent-sdk session get --prod`, as in
272
- [Verify a hosted turn](#verify-a-hosted-turn).
148
+ See [Route responses](./reference/channels.md#route-responses) for what the
149
+ caller gets back. To confirm the work started, run
150
+ `agent-sdk session list --prod --slug weather-agent`.
273
151
 
274
152
  ### Protect the alias token
275
153
 
276
- The first deploy prints the alias token once. Store it outside terminal
277
- transcripts; it cannot be retrieved later. If it is lost or exposed,
278
- `agent-sdk deployment rotate-token weather-agent` replaces it and invalidates the
279
- old value.
280
-
281
- `deployment --json` can include short-lived access headers, so treat
282
- that output as a credential too.
154
+ The first deploy prints the alias token once. If it leaks or you lose it, run `agent-sdk deployment rotate-token weather-agent`. Output from `deployment --json` can include access headers, so guard it the same way.
283
155
 
284
- For a custom webhook whose provider cannot send the alias token, use
285
- `publicEndpoint()` only when the channel verifies the provider
286
- signature. That opens the custom channel path, not the built-in session
287
- or tool APIs. See [Webhooks](./guides/webhooks.md).
156
+ Use [`publicEndpoint()`](./guides/webhooks.md) only for a webhook provider
157
+ that can't send the token and whose signature the channel verifies.
288
158
 
289
159
  ## Update the deployment
290
160
 
291
- Push the new ref and deploy the same slug. The stable URL remains while
292
- the new generation replaces the previous one.
293
-
294
- ```text
295
- agent-sdk deploy --dir . --slug weather-agent
296
- ```
297
-
298
- A redeploy replaces its source, its watched repositories, and any egress
299
- domains supplied through CLI flags. Pass every `--cursor-events-repo` value
300
- again; without the flag, the deployment watches its GitHub source repository.
301
- Keep source-controlled egress in the `hosting` block when possible.
302
-
303
- Use `agent-sdk deployment get weather-agent` to inspect a rollout.
304
- The [CLI reference](./reference/cli.md#deploy) owns `--no-wait`,
305
- multi-agent deployment, stop, and delete behavior.
161
+ Push the new ref and deploy the same slug. Each redeploy replaces the
162
+ watched repositories, so pass every `--cursor-events-repo` value again, or
163
+ the deployment watches only its GitHub source repository. Run
164
+ `agent-sdk deployment get weather-agent` to check a rollout.
306
165
 
307
166
  ## Keep state across replacements
308
167
 
309
- Managed hosting persists framework-owned session, KV, and file state
310
- across normal runtime replacements. Files written elsewhere on the
311
- runtime's local filesystem are disposable; use `ctx.host.kv` or
312
- `ctx.host.files` for durable application state.
313
-
314
- On architecture v2, the default, reminders take a prompt or a named
315
- handler. See [Reminders](./reference/schedules.md#reminders).
168
+ Sessions, `ctx.host.kv`, and `ctx.host.files` survive restarts and
169
+ redeploys. Anything else the agent writes to disk can disappear.
316
170
 
317
171
  ## Self-host securely
318
172
 
319
- Run Agent SDK under Node 22.13 or newer, never Bun. One supervised
320
- process can serve every agent under a directory while a persistent
321
- state root keeps sessions across restarts.
173
+ Run Agent SDK under Node 22.13 or newer, never Bun. One process can serve
174
+ every agent under a directory:
322
175
 
323
- ```text
176
+ ```bash
324
177
  export CURSOR_API_KEY="<cursor-api-key>"
325
178
  export AGENT_SDK_BEARER_TOKEN="$(openssl rand -hex 32)"
326
179
 
@@ -332,45 +185,13 @@ agent-sdk serve \
332
185
  --bearer-token "$AGENT_SDK_BEARER_TOKEN"
333
186
  ```
334
187
 
335
- Before exposing the host:
336
-
337
- - Put TLS or an authenticating proxy in front of the loopback server.
338
-
339
- - Keep `--bearer-token` on shared hosts. Use `--allow-anonymous` only
340
- behind a proxy that authenticates every caller.
341
-
342
- - Mount `--state-root` on a persistent volume outside the agent
343
- repository and back it up.
344
-
345
- - Inject credentials at startup instead of baking them into an image.
346
-
347
- - Run the process under a supervisor and enable schedules on exactly
348
- one serving process per project.
349
-
350
- Containers use the same command with `--host 0.0.0.0`, a mounted state
351
- volume, and an authenticating network boundary. The
352
- [Channels reference](./reference/channels.md#auth-policies) covers
353
- per-caller and channel-specific auth.
354
-
355
- ## Observability
356
-
357
- Use `agent-sdk logs --prod` for a hosted session's process output, and
358
- `agent-sdk session get <sessionId> --prod` for its runs. Add `--view events` to
359
- print the tool calls. [OpenTelemetry](./guides/opentelemetry.md) covers traces and
360
- metrics, and
361
- [session traces](./reference/sessions.md#inspect-a-saved-event-stream)
362
- cover a local conversation.
188
+ Before you expose the host:
363
189
 
364
- ## Related
190
+ - Put TLS or an authenticating proxy in front of the server.
191
+ - Keep `--bearer-token` unless a proxy authenticates every caller.
192
+ - Keep `--state-root` on a backed-up persistent volume outside the
193
+ repository.
194
+ - Turn on schedules in only one process per project.
365
195
 
366
- - [Early-alpha migration](./guides/migrate.md): move a hosted architecture
367
- v1 project to v2 through a reviewed pull request
368
- - [CLI reference](./reference/cli.md#deploy): inspect, update, stop,
369
- delete, and rotate deployments
370
- - [GitHub](./guides/github.md): Cursor-event repositories and direct
371
- webhook delivery
372
- - [Slack](./guides/slack.md): provision a dedicated hosted Slack app
373
- - [Host MCP OAuth](./guides/mcp-oauth.md): reach OAuth-backed MCP
374
- servers from a hosted agent
375
- - [Troubleshooting](./troubleshooting.md): diagnose failed or stale
376
- deployments
196
+ In a container, use `--host 0.0.0.0` behind an authenticating network
197
+ boundary.