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