@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.
- package/dist/channels/slack/cli-project.js +1 -1
- package/dist/channels/slack/slack-channel.d.ts.map +1 -1
- package/dist/channels/slack/slack-channel.js +27 -14
- package/dist/docs/404.html +2 -2
- package/dist/docs/assets/{app.DMrZKFjI.js → app.BSH__xV4.js} +4 -4
- package/dist/docs/assets/building-with-agents.md.Bo3ct-rf.js +6 -0
- package/dist/docs/assets/{building-with-agents.md.Bf1yH2tG.lean.js → building-with-agents.md.Bo3ct-rf.lean.js} +1 -1
- package/dist/docs/assets/changelog.md.b6H_ea44.js +1 -0
- package/dist/docs/assets/changelog.md.b6H_ea44.lean.js +1 -0
- package/dist/docs/assets/chunks/@localSearchIndexroot.CiRGcfZg.js +1 -0
- package/dist/docs/assets/chunks/{VPLocalSearchBox.DQvuw1KA.js → VPLocalSearchBox.Cadl7A0k.js} +1 -1
- package/dist/docs/assets/chunks/{arc.ahOG-Qza.js → arc.K7t9nNY6.js} +1 -1
- package/dist/docs/assets/chunks/{architectureDiagram-Q4EWVU46.BcgfYNO_.js → architectureDiagram-Q4EWVU46.SlHEknkX.js} +1 -1
- package/dist/docs/assets/chunks/{baseUniq.DeIYZrWh.js → baseUniq.DJLRMLkz.js} +1 -1
- package/dist/docs/assets/chunks/{blockDiagram-DXYQGD6D.HjJ2goMX.js → blockDiagram-DXYQGD6D.Bs6XxFpe.js} +1 -1
- package/dist/docs/assets/chunks/{c4Diagram-AHTNJAMY.C1QTb9GM.js → c4Diagram-AHTNJAMY.CyLg6Ovc.js} +1 -1
- package/dist/docs/assets/chunks/channel.CVTdqYx0.js +1 -0
- package/dist/docs/assets/chunks/{chunk-4BX2VUAB.UuZiDiVp.js → chunk-4BX2VUAB.DTQ4TinT.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-4TB4RGXK.5A3YmkhI.js → chunk-4TB4RGXK.Es84IgcH.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-55IACEB6.B4uf1yYV.js → chunk-55IACEB6.Clm3cGPQ.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-EDXVE4YY.CoXBce8t.js → chunk-EDXVE4YY.DE4CRkS5.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-FMBD7UC4.DnC5NO4e.js → chunk-FMBD7UC4.Bf8HCvqp.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-OYMX7WX6.CzfHCeIi.js → chunk-OYMX7WX6.eub-7nSx.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-QZHKN3VN.C6tcwkVd.js → chunk-QZHKN3VN.WyP9VAS_.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-YZCP3GAM._oboyZ1A.js → chunk-YZCP3GAM.LO9ohhDE.js} +1 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.CsJJyx6-.js +1 -0
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.CsJJyx6-.js +1 -0
- package/dist/docs/assets/chunks/clone.Dk8KvtOB.js +1 -0
- package/dist/docs/assets/chunks/{cose-bilkent-S5V4N54A.BfPVKeId.js → cose-bilkent-S5V4N54A.D5za6aH0.js} +1 -1
- package/dist/docs/assets/chunks/{dagre-KV5264BT.CLMLc0lD.js → dagre-KV5264BT.Dq1daUru.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-5BDNPKRD.C7OF7UfH.js → diagram-5BDNPKRD.j1YL5BKS.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-G4DWMVQ6.Dpao0Bl1.js → diagram-G4DWMVQ6.Bi1aLdhC.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-MMDJMWI5.DLnM9eLp.js → diagram-MMDJMWI5.BOzMEkAr.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-TYMM5635.BcpVgA_M.js → diagram-TYMM5635.Dx2FVhCr.js} +1 -1
- package/dist/docs/assets/chunks/{erDiagram-SMLLAGMA.CsL5JuCV.js → erDiagram-SMLLAGMA.DI4TNkye.js} +1 -1
- package/dist/docs/assets/chunks/{flowDiagram-DWJPFMVM.MFihq9AF.js → flowDiagram-DWJPFMVM.C58Z9uPK.js} +1 -1
- package/dist/docs/assets/chunks/{ganttDiagram-T4ZO3ILL.CJeLodyG.js → ganttDiagram-T4ZO3ILL.DXSpW809.js} +1 -1
- package/dist/docs/assets/chunks/{gitGraphDiagram-UUTBAWPF.1HhlE45Z.js → gitGraphDiagram-UUTBAWPF.B955oaFl.js} +1 -1
- package/dist/docs/assets/chunks/{graph.BS02KkWA.js → graph.BQXhKtxS.js} +1 -1
- package/dist/docs/assets/chunks/{infoDiagram-42DDH7IO.fp5gvytQ.js → infoDiagram-42DDH7IO.Dozj_-Gm.js} +1 -1
- package/dist/docs/assets/chunks/{ishikawaDiagram-UXIWVN3A.C6Wk1V4I.js → ishikawaDiagram-UXIWVN3A.D2140OzH.js} +1 -1
- package/dist/docs/assets/chunks/{journeyDiagram-VCZTEJTY.qJt4uJ_H.js → journeyDiagram-VCZTEJTY.DrqrMhCk.js} +1 -1
- package/dist/docs/assets/chunks/{kanban-definition-6JOO6SKY.z2tG9kly.js → kanban-definition-6JOO6SKY.Dv-LTrlw.js} +1 -1
- package/dist/docs/assets/chunks/{layout.BPCkdejr.js → layout.CGtHp49X.js} +1 -1
- package/dist/docs/assets/chunks/{linear.CL3TC3u7.js → linear.CHZLYB52.js} +1 -1
- package/dist/docs/assets/chunks/{min.SPrSp704.js → min.D4Vt3eIy.js} +1 -1
- package/dist/docs/assets/chunks/{mindmap-definition-QFDTVHPH.DgrQRFZW.js → mindmap-definition-QFDTVHPH.BBfpYTea.js} +1 -1
- package/dist/docs/assets/chunks/{pieDiagram-DEJITSTG.Ba7yxiW2.js → pieDiagram-DEJITSTG.BVYvElmY.js} +1 -1
- package/dist/docs/assets/chunks/{quadrantDiagram-34T5L4WZ.Bvskad4p.js → quadrantDiagram-34T5L4WZ.C6Gc2mdY.js} +1 -1
- package/dist/docs/assets/chunks/{requirementDiagram-MS252O5E.Ce70ugV9.js → requirementDiagram-MS252O5E.DWa8b4cn.js} +1 -1
- package/dist/docs/assets/chunks/{sankeyDiagram-XADWPNL6.BJ5OEULO.js → sankeyDiagram-XADWPNL6.Bi-g4ajv.js} +1 -1
- package/dist/docs/assets/chunks/{sequenceDiagram-FGHM5R23.C8a1hDs6.js → sequenceDiagram-FGHM5R23.DlU3vVN9.js} +1 -1
- package/dist/docs/assets/chunks/{stateDiagram-FHFEXIEX.D2D8A5CK.js → stateDiagram-FHFEXIEX.CeqJRqnU.js} +1 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.DE0BnUZh.js +1 -0
- package/dist/docs/assets/chunks/{theme.DRciHmS1.js → theme.DGq7D4tt.js} +2 -2
- package/dist/docs/assets/chunks/{timeline-definition-GMOUNBTQ.C4ePrY8-.js → timeline-definition-GMOUNBTQ.Cqf2kjq9.js} +1 -1
- package/dist/docs/assets/chunks/{vennDiagram-DHZGUBPP.Dzso6dEA.js → vennDiagram-DHZGUBPP.BeOpE_lM.js} +1 -1
- package/dist/docs/assets/chunks/{wardley-RL74JXVD.djgXR0ar.js → wardley-RL74JXVD.FMQXA-6q.js} +1 -1
- package/dist/docs/assets/chunks/{wardleyDiagram-NUSXRM2D.Bf2ICxjh.js → wardleyDiagram-NUSXRM2D.BXS65dAC.js} +1 -1
- package/dist/docs/assets/chunks/{xychartDiagram-5P7HB3ND.DEH4BcVJ.js → xychartDiagram-5P7HB3ND.haEiSxqc.js} +1 -1
- package/dist/docs/assets/deployment.md.DJtuDVLh.js +31 -0
- package/dist/docs/assets/{deployment.md.KW0Ni_rY.lean.js → deployment.md.DJtuDVLh.lean.js} +1 -1
- package/dist/docs/assets/evals.md.Dne6VRmZ.js +49 -0
- package/dist/docs/assets/evals.md.Dne6VRmZ.lean.js +1 -0
- package/dist/docs/assets/{guides_agent-to-agent.md.D1D5f6Jc.js → guides_agent-to-agent.md.DcB3nhOz.js} +8 -8
- package/dist/docs/assets/guides_agent-to-agent.md.DcB3nhOz.lean.js +1 -0
- package/dist/docs/assets/{guides_bitbucket.md.DkjkBRU8.js → guides_bitbucket.md.BiA6ZMFW.js} +27 -27
- package/dist/docs/assets/{guides_bitbucket.md.DkjkBRU8.lean.js → guides_bitbucket.md.BiA6ZMFW.lean.js} +1 -1
- package/dist/docs/assets/guides_cloud-agents.md.CiXAW6on.js +9 -0
- package/dist/docs/assets/{guides_cloud-agents.md.Ceyjv0ul.lean.js → guides_cloud-agents.md.CiXAW6on.lean.js} +1 -1
- package/dist/docs/assets/guides_convert-automation.md.BvTxsJ8J.js +26 -0
- package/dist/docs/assets/{guides_convert-automation.md.BjraCvok.lean.js → guides_convert-automation.md.BvTxsJ8J.lean.js} +1 -1
- package/dist/docs/assets/{guides_github.md.CgN5sNbW.js → guides_github.md.CcuZ7keS.js} +11 -19
- package/dist/docs/assets/{guides_github.md.CgN5sNbW.lean.js → guides_github.md.CcuZ7keS.lean.js} +1 -1
- package/dist/docs/assets/{guides_gitlab.md.DCE0p7_w.js → guides_gitlab.md.DcKusOcU.js} +63 -73
- package/dist/docs/assets/{guides_gitlab.md.DCE0p7_w.lean.js → guides_gitlab.md.DcKusOcU.lean.js} +1 -1
- package/dist/docs/assets/guides_improve.md.o3WOGR7n.js +16 -0
- package/dist/docs/assets/{guides_improve.md.BFYtrtLE.lean.js → guides_improve.md.o3WOGR7n.lean.js} +1 -1
- package/dist/docs/assets/{guides_jev.md.CEqLgjj9.js → guides_jev.md.DGCzkMUN.js} +20 -60
- package/dist/docs/assets/{guides_jev.md.CEqLgjj9.lean.js → guides_jev.md.DGCzkMUN.lean.js} +1 -1
- package/dist/docs/assets/{guides_mcp-oauth.md.DrGY92u4.js → guides_mcp-oauth.md.GVPMKcYl.js} +3 -5
- package/dist/docs/assets/{guides_mcp-oauth.md.DrGY92u4.lean.js → guides_mcp-oauth.md.GVPMKcYl.lean.js} +1 -1
- package/dist/docs/assets/guides_migrate.md.B8CZxnnX.js +3 -0
- package/dist/docs/assets/{guides_migrate.md.RS9Eu-Xh.lean.js → guides_migrate.md.B8CZxnnX.lean.js} +1 -1
- package/dist/docs/assets/guides_opentelemetry.md.BRSktBHt.js +26 -0
- package/dist/docs/assets/guides_opentelemetry.md.BRSktBHt.lean.js +1 -0
- package/dist/docs/assets/guides_pagerduty.md.pMXUkZZc.js +61 -0
- package/dist/docs/assets/guides_pagerduty.md.pMXUkZZc.lean.js +1 -0
- package/dist/docs/assets/guides_slack.md.D7Rwyva4.js +82 -0
- package/dist/docs/assets/{guides_slack.md.BwXHURvY.lean.js → guides_slack.md.D7Rwyva4.lean.js} +1 -1
- package/dist/docs/assets/{guides_webhooks.md.BJk63ZTs.js → guides_webhooks.md.B5DXt2v1.js} +7 -7
- package/dist/docs/assets/{guides_webhooks.md.BJk63ZTs.lean.js → guides_webhooks.md.B5DXt2v1.lean.js} +1 -1
- package/dist/docs/assets/hillclimbing.md.M51bF-oT.js +5 -0
- package/dist/docs/assets/hillclimbing.md.M51bF-oT.lean.js +1 -0
- package/dist/docs/assets/index.md.DnJPj_B6.js +14 -0
- package/dist/docs/assets/index.md.DnJPj_B6.lean.js +1 -0
- package/dist/docs/assets/quickstart.md.r-oE8nkX.js +113 -0
- package/dist/docs/assets/{quickstart.md.CljDaJBi.lean.js → quickstart.md.r-oE8nkX.lean.js} +1 -1
- package/dist/docs/assets/reference_access.md.C5lblfUC.js +1 -0
- package/dist/docs/assets/reference_access.md.C5lblfUC.lean.js +1 -0
- package/dist/docs/assets/reference_agent-config.md.BSNp2uJ7.js +27 -0
- package/dist/docs/assets/{reference_agent-config.md.Ck29qYNj.lean.js → reference_agent-config.md.BSNp2uJ7.lean.js} +1 -1
- package/dist/docs/assets/reference_artifacts.md.BJpAI7h9.js +17 -0
- package/dist/docs/assets/{reference_artifacts.md.C-hKR2hp.lean.js → reference_artifacts.md.BJpAI7h9.lean.js} +1 -1
- package/dist/docs/assets/reference_channels.md.CPWOpdsC.js +21 -0
- package/dist/docs/assets/{reference_channels.md.DsJfGSBJ.lean.js → reference_channels.md.CPWOpdsC.lean.js} +1 -1
- package/dist/docs/assets/reference_cli.md.DHm6DmYk.js +83 -0
- package/dist/docs/assets/reference_cli.md.DHm6DmYk.lean.js +1 -0
- package/dist/docs/assets/reference_connections.md.DoY4vrDH.js +54 -0
- package/dist/docs/assets/{reference_connections.md.BoAotr7_.lean.js → reference_connections.md.DoY4vrDH.lean.js} +1 -1
- package/dist/docs/assets/reference_evals.md.DgfUtfIc.js +69 -0
- package/dist/docs/assets/{reference_evals.md.2BXeMiO2.lean.js → reference_evals.md.DgfUtfIc.lean.js} +1 -1
- package/dist/docs/assets/{reference_extensions.md.DI5X5x8p.js → reference_extensions.md.DHbW6eOf.js} +6 -8
- package/dist/docs/assets/{reference_extensions.md.DI5X5x8p.lean.js → reference_extensions.md.DHbW6eOf.lean.js} +1 -1
- package/dist/docs/assets/reference_hooks.md.vbIM394-.js +39 -0
- package/dist/docs/assets/reference_hooks.md.vbIM394-.lean.js +1 -0
- package/dist/docs/assets/reference_http-api.md.C7Cb0r2J.js +7 -0
- package/dist/docs/assets/{reference_http-api.md._RWELr3d.lean.js → reference_http-api.md.C7Cb0r2J.lean.js} +1 -1
- package/dist/docs/assets/reference_instructions.md.CV6Qq0UX.js +14 -0
- package/dist/docs/assets/reference_instructions.md.CV6Qq0UX.lean.js +1 -0
- package/dist/docs/assets/reference_limits.md.CbdtFr4T.js +8 -0
- package/dist/docs/assets/reference_limits.md.CbdtFr4T.lean.js +1 -0
- package/dist/docs/assets/reference_memory.md.CdoJISM-.js +3 -0
- package/dist/docs/assets/{reference_memory.md.Dd7cyV9V.lean.js → reference_memory.md.CdoJISM-.lean.js} +1 -1
- package/dist/docs/assets/reference_playground.md.DIUsRAcy.js +1 -0
- package/dist/docs/assets/{reference_playground.md.CQiJk9CM.lean.js → reference_playground.md.DIUsRAcy.lean.js} +1 -1
- package/dist/docs/assets/reference_project-layout.md.9DiKoE16.js +26 -0
- package/dist/docs/assets/reference_project-layout.md.9DiKoE16.lean.js +1 -0
- package/dist/docs/assets/reference_schedules.md.Dd8_d0WG.js +45 -0
- package/dist/docs/assets/{reference_schedules.md.RC47aFm4.lean.js → reference_schedules.md.Dd8_d0WG.lean.js} +1 -1
- package/dist/docs/assets/reference_sessions.md.NXVQt9mP.js +22 -0
- package/dist/docs/assets/{reference_sessions.md.C7KFhWXV.lean.js → reference_sessions.md.NXVQt9mP.lean.js} +1 -1
- package/dist/docs/assets/{reference_skills.md.Dej2zQxi.js → reference_skills.md.DzCPNPkG.js} +4 -4
- package/dist/docs/assets/{reference_skills.md.Dej2zQxi.lean.js → reference_skills.md.DzCPNPkG.lean.js} +1 -1
- package/dist/docs/assets/reference_subagents.md.Dvpq2sUu.js +10 -0
- package/dist/docs/assets/{reference_subagents.md.CAhvW4yS.lean.js → reference_subagents.md.Dvpq2sUu.lean.js} +1 -1
- package/dist/docs/assets/reference_tools.md.B2OaR1Nb.js +62 -0
- package/dist/docs/assets/{reference_tools.md.DQr7Fnhu.lean.js → reference_tools.md.B2OaR1Nb.lean.js} +1 -1
- package/dist/docs/assets/templates_agentic-owners.md.B6ZmKAzT.js +13 -0
- package/dist/docs/assets/{templates_agentic-owners.md.Dh2nDSqg.lean.js → templates_agentic-owners.md.B6ZmKAzT.lean.js} +1 -1
- package/dist/docs/assets/templates_reviews.md.dr9Xv_KM.js +10 -0
- package/dist/docs/assets/templates_reviews.md.dr9Xv_KM.lean.js +1 -0
- package/dist/docs/assets/troubleshooting.md.DfKKvW1R.js +3 -0
- package/dist/docs/assets/{troubleshooting.md.CGOdNVAL.lean.js → troubleshooting.md.DfKKvW1R.lean.js} +1 -1
- package/dist/docs/building-with-agents.html +41 -44
- package/dist/docs/building-with-agents.md +11 -104
- package/dist/docs/changelog.html +37 -37
- package/dist/docs/changelog.md +14 -145
- package/dist/docs/deployment.html +54 -54
- package/dist/docs/deployment.md +97 -270
- package/dist/docs/evals.html +52 -71
- package/dist/docs/evals.md +33 -129
- package/dist/docs/guides/agent-to-agent.html +43 -43
- package/dist/docs/guides/agent-to-agent.md +29 -64
- package/dist/docs/guides/bitbucket.html +62 -62
- package/dist/docs/guides/bitbucket.md +73 -134
- package/dist/docs/guides/cloud-agents.html +37 -37
- package/dist/docs/guides/cloud-agents.md +23 -53
- package/dist/docs/guides/convert-automation.html +39 -56
- package/dist/docs/guides/convert-automation.md +31 -115
- package/dist/docs/guides/github.html +46 -54
- package/dist/docs/guides/github.md +49 -131
- package/dist/docs/guides/gitlab.html +98 -108
- package/dist/docs/guides/gitlab.md +104 -184
- package/dist/docs/guides/improve.html +38 -43
- package/dist/docs/guides/improve.md +24 -90
- package/dist/docs/guides/jev.html +55 -95
- package/dist/docs/guides/jev.md +53 -160
- package/dist/docs/guides/mcp-oauth.html +38 -40
- package/dist/docs/guides/mcp-oauth.md +33 -67
- package/dist/docs/guides/migrate.html +38 -43
- package/dist/docs/guides/migrate.md +56 -130
- package/dist/docs/guides/opentelemetry.html +41 -43
- package/dist/docs/guides/opentelemetry.md +32 -27
- package/dist/docs/guides/pagerduty.html +50 -49
- package/dist/docs/guides/pagerduty.md +65 -199
- package/dist/docs/guides/slack.html +51 -57
- package/dist/docs/guides/slack.md +76 -204
- package/dist/docs/guides/webhooks.html +42 -42
- package/dist/docs/guides/webhooks.md +64 -146
- package/dist/docs/hashmap.json +1 -1
- package/dist/docs/hillclimbing.html +40 -42
- package/dist/docs/hillclimbing.md +40 -102
- package/dist/docs/index.html +49 -61
- package/dist/docs/index.md +42 -82
- package/dist/docs/llms-full.txt +2272 -5711
- package/dist/docs/llms.txt +9 -14
- package/dist/docs/quickstart.html +95 -152
- package/dist/docs/quickstart.md +91 -180
- package/dist/docs/reference/access.html +36 -36
- package/dist/docs/reference/access.md +7 -12
- package/dist/docs/reference/agent-config.html +45 -58
- package/dist/docs/reference/agent-config.md +92 -176
- package/dist/docs/reference/artifacts.html +38 -39
- package/dist/docs/reference/artifacts.md +38 -62
- package/dist/docs/reference/channels.html +38 -39
- package/dist/docs/reference/channels.md +102 -151
- package/dist/docs/reference/cli.html +68 -84
- package/dist/docs/reference/cli.md +232 -697
- package/dist/docs/reference/connections.html +45 -57
- package/dist/docs/reference/connections.md +83 -164
- package/dist/docs/reference/evals.html +47 -54
- package/dist/docs/reference/evals.md +75 -141
- package/dist/docs/reference/extensions.html +41 -43
- package/dist/docs/reference/extensions.md +37 -70
- package/dist/docs/reference/hooks.html +40 -52
- package/dist/docs/reference/hooks.md +62 -133
- package/dist/docs/reference/http-api.html +38 -42
- package/dist/docs/reference/http-api.md +66 -118
- package/dist/docs/reference/instructions.html +39 -39
- package/dist/docs/reference/instructions.md +19 -29
- package/dist/docs/reference/limits.html +38 -38
- package/dist/docs/reference/limits.md +9 -21
- package/dist/docs/reference/memory.html +37 -38
- package/dist/docs/reference/memory.md +38 -75
- package/dist/docs/reference/playground.html +36 -36
- package/dist/docs/reference/playground.md +14 -22
- package/dist/docs/reference/project-layout.html +49 -48
- package/dist/docs/reference/project-layout.md +38 -84
- package/dist/docs/reference/schedules.html +44 -46
- package/dist/docs/reference/schedules.md +59 -90
- package/dist/docs/reference/sessions.html +37 -37
- package/dist/docs/reference/sessions.md +66 -113
- package/dist/docs/reference/skills.html +39 -39
- package/dist/docs/reference/skills.md +11 -31
- package/dist/docs/reference/subagents.html +37 -37
- package/dist/docs/reference/subagents.md +17 -31
- package/dist/docs/reference/tools.html +47 -64
- package/dist/docs/reference/tools.md +48 -130
- package/dist/docs/templates/agentic-owners.html +38 -38
- package/dist/docs/templates/agentic-owners.md +50 -74
- package/dist/docs/templates/reviews.html +69 -0
- package/dist/docs/templates/reviews.md +71 -0
- package/dist/docs/troubleshooting.html +38 -36
- package/dist/docs/troubleshooting.md +48 -101
- package/dist/filesystem.d.ts +7 -320
- package/dist/filesystem.d.ts.map +1 -1
- package/dist/filesystem.js +10 -691
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/internal/authored-alias-hooks.d.ts +6 -0
- package/dist/internal/authored-alias-hooks.d.ts.map +1 -1
- package/dist/internal/authored-alias-hooks.js +12 -0
- package/dist/internal/authored-loaders.js +10 -1
- package/dist/internal/cli/commands/scaffold.js +1 -1
- package/dist/internal/cli-deploy.js +1 -1
- package/dist/internal/cli-docs.js +1 -1
- package/dist/internal/cli-images.js +1 -1
- package/dist/internal/cli-skills.js +1 -1
- package/dist/internal/continuation-session-ids.d.ts +15 -0
- package/dist/internal/continuation-session-ids.d.ts.map +1 -0
- package/dist/internal/continuation-session-ids.js +43 -0
- package/dist/internal/cursor/credentials.js +1 -1
- package/dist/internal/deploy-manifest.d.ts +1 -0
- package/dist/internal/deploy-manifest.d.ts.map +1 -1
- package/dist/internal/deploy-manifest.js +0 -1
- package/dist/internal/discovery/agent-config.d.ts +2 -6
- package/dist/internal/discovery/agent-config.d.ts.map +1 -1
- package/dist/internal/discovery/agent-config.js +8 -25
- package/dist/internal/discovery/agent.d.ts.map +1 -1
- package/dist/internal/discovery/agent.js +2 -3
- package/dist/internal/discovery/project.d.ts.map +1 -1
- package/dist/internal/discovery/project.js +15 -0
- package/dist/internal/filesystem/walk.d.ts +1 -5
- package/dist/internal/filesystem/walk.d.ts.map +1 -1
- package/dist/internal/filesystem/walk.js +1 -9
- package/dist/internal/hosted-catch-protocol.d.ts +3 -3
- package/dist/internal/hosted-catch-protocol.js +3 -3
- package/dist/internal/hosted-fetch.d.ts +7 -0
- package/dist/internal/hosted-fetch.d.ts.map +1 -0
- package/dist/internal/hosted-fetch.js +26 -0
- package/dist/internal/init-project.d.ts.map +1 -1
- package/dist/internal/init-project.js +7 -5
- package/dist/internal/install-cursor-skills.d.ts +5 -6
- package/dist/internal/install-cursor-skills.d.ts.map +1 -1
- package/dist/internal/install-cursor-skills.js +19 -4
- package/dist/internal/mcp-endpoint.js +4 -4
- package/dist/internal/model-config.d.ts.map +1 -1
- package/dist/internal/model-config.js +11 -4
- package/dist/internal/platform-timers.d.ts +3 -7
- package/dist/internal/platform-timers.d.ts.map +1 -1
- package/dist/internal/platform-timers.js +10 -51
- package/dist/internal/reminder-runner.js +1 -1
- package/dist/internal/server.d.ts.map +1 -1
- package/dist/internal/server.js +6 -1
- package/dist/internal/session-engine.d.ts +3 -0
- package/dist/internal/session-engine.d.ts.map +1 -1
- package/dist/internal/session-engine.js +13 -4
- package/dist/internal/shallow-clone.js +1 -1
- package/dist/playground/assets/index-Bno25Cg0.css +1 -0
- package/dist/playground/assets/index-SGKsaznh.js +62 -0
- package/dist/playground/index.html +2 -2
- package/dist/types.d.ts +6 -17
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +2 -2
- package/docs/README.md +42 -82
- package/docs/building-with-agents.md +11 -104
- package/docs/changelog.md +15 -146
- package/docs/deployment.md +97 -270
- package/docs/evals.md +34 -130
- package/docs/guides/agent-to-agent.md +29 -64
- package/docs/guides/bitbucket.md +73 -134
- package/docs/guides/cloud-agents.md +23 -53
- package/docs/guides/convert-automation.md +31 -115
- package/docs/guides/github.md +49 -131
- package/docs/guides/gitlab.md +104 -184
- package/docs/guides/improve.md +24 -90
- package/docs/guides/jev.md +53 -160
- package/docs/guides/mcp-oauth.md +33 -67
- package/docs/guides/migrate.md +56 -130
- package/docs/guides/opentelemetry.md +37 -27
- package/docs/guides/pagerduty.md +68 -200
- package/docs/guides/slack.md +76 -204
- package/docs/guides/webhooks.md +64 -146
- package/docs/hillclimbing.md +41 -103
- package/docs/quickstart.md +91 -180
- package/docs/reference/access.md +7 -12
- package/docs/reference/agent-config.md +92 -176
- package/docs/reference/artifacts.md +38 -62
- package/docs/reference/channels.md +102 -151
- package/docs/reference/cli.md +232 -697
- package/docs/reference/connections.md +83 -164
- package/docs/reference/evals.md +75 -141
- package/docs/reference/extensions.md +37 -70
- package/docs/reference/hooks.md +61 -132
- package/docs/reference/http-api.md +66 -118
- package/docs/reference/instructions.md +20 -30
- package/docs/reference/limits.md +10 -22
- package/docs/reference/memory.md +38 -75
- package/docs/reference/playground.md +14 -22
- package/docs/reference/project-layout.md +38 -84
- package/docs/reference/schedules.md +59 -90
- package/docs/reference/sessions.md +66 -113
- package/docs/reference/skills.md +12 -32
- package/docs/reference/subagents.md +17 -31
- package/docs/reference/tools.md +48 -130
- package/docs/templates/agentic-owners.md +50 -74
- package/docs/templates/reviews.md +76 -0
- package/docs/troubleshooting.md +48 -101
- package/package.json +4 -4
- package/skills/cli/SKILL.md +1 -1
- package/skills/create-agent/SKILL.md +61 -7
- package/skills/debug/SKILL.md +1 -1
- package/skills/deploy/SKILL.md +3 -3
- package/skills/evals/SKILL.md +1 -1
- package/skills/framework-map/SKILL.md +2 -2
- package/skills/github/SKILL.md +1 -1
- package/skills/hillclimb/SKILL.md +1 -1
- package/skills/mcp-auth/SKILL.md +1 -1
- package/skills/migrate-v2/SKILL.md +2 -3
- package/skills/otel/SKILL.md +1 -1
- package/skills/setup-slack/SKILL.md +2 -2
- package/dist/docs/assets/building-with-agents.md.Bf1yH2tG.js +0 -9
- package/dist/docs/assets/changelog.md.DrLFQUlu.js +0 -1
- package/dist/docs/assets/changelog.md.DrLFQUlu.lean.js +0 -1
- package/dist/docs/assets/chunks/@localSearchIndexroot.Dpd_wxVU.js +0 -1
- package/dist/docs/assets/chunks/channel._fZX_hvU.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.eClS1Q0E.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.eClS1Q0E.js +0 -1
- package/dist/docs/assets/chunks/clone.W1Phdw9P.js +0 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.77yf4kRr.js +0 -1
- package/dist/docs/assets/deployment.md.KW0Ni_rY.js +0 -31
- package/dist/docs/assets/evals.md.DiljU__Z.js +0 -68
- package/dist/docs/assets/evals.md.DiljU__Z.lean.js +0 -1
- package/dist/docs/assets/guides_agent-to-agent.md.D1D5f6Jc.lean.js +0 -1
- package/dist/docs/assets/guides_cloud-agents.md.Ceyjv0ul.js +0 -9
- package/dist/docs/assets/guides_convert-automation.md.BjraCvok.js +0 -43
- package/dist/docs/assets/guides_hooks.md.BjeEiM7s.js +0 -54
- package/dist/docs/assets/guides_hooks.md.BjeEiM7s.lean.js +0 -1
- package/dist/docs/assets/guides_improve.md.BFYtrtLE.js +0 -21
- package/dist/docs/assets/guides_migrate.md.RS9Eu-Xh.js +0 -8
- package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.js +0 -28
- package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.lean.js +0 -1
- package/dist/docs/assets/guides_pagerduty.md.mnKXe9U0.js +0 -60
- package/dist/docs/assets/guides_pagerduty.md.mnKXe9U0.lean.js +0 -1
- package/dist/docs/assets/guides_slack.md.BwXHURvY.js +0 -88
- package/dist/docs/assets/hillclimbing.md.By61f3uq.js +0 -7
- package/dist/docs/assets/hillclimbing.md.By61f3uq.lean.js +0 -1
- package/dist/docs/assets/index.md.CAruw_rp.js +0 -26
- package/dist/docs/assets/index.md.CAruw_rp.lean.js +0 -1
- package/dist/docs/assets/quickstart.md.CljDaJBi.js +0 -170
- package/dist/docs/assets/reference_access.md.CEtibb4i.js +0 -1
- package/dist/docs/assets/reference_access.md.CEtibb4i.lean.js +0 -1
- package/dist/docs/assets/reference_agent-config.md.Ck29qYNj.js +0 -40
- package/dist/docs/assets/reference_artifacts.md.C-hKR2hp.js +0 -18
- package/dist/docs/assets/reference_channels.md.DsJfGSBJ.js +0 -22
- package/dist/docs/assets/reference_cli.md.BkdLRbXg.js +0 -99
- package/dist/docs/assets/reference_cli.md.BkdLRbXg.lean.js +0 -1
- package/dist/docs/assets/reference_connections.md.BoAotr7_.js +0 -66
- package/dist/docs/assets/reference_evals.md.2BXeMiO2.js +0 -76
- package/dist/docs/assets/reference_hooks.md.B-bwJuiG.js +0 -51
- package/dist/docs/assets/reference_hooks.md.B-bwJuiG.lean.js +0 -1
- package/dist/docs/assets/reference_http-api.md._RWELr3d.js +0 -11
- package/dist/docs/assets/reference_instructions.md.yL2hXLnl.js +0 -14
- package/dist/docs/assets/reference_instructions.md.yL2hXLnl.lean.js +0 -1
- package/dist/docs/assets/reference_limits.md.BCCnvt3o.js +0 -8
- package/dist/docs/assets/reference_limits.md.BCCnvt3o.lean.js +0 -1
- package/dist/docs/assets/reference_memory.md.Dd7cyV9V.js +0 -4
- package/dist/docs/assets/reference_playground.md.CQiJk9CM.js +0 -1
- package/dist/docs/assets/reference_project-layout.md.BamcPDUn.js +0 -25
- package/dist/docs/assets/reference_project-layout.md.BamcPDUn.lean.js +0 -1
- package/dist/docs/assets/reference_prompt.md.BMjm1Jp3.js +0 -9
- package/dist/docs/assets/reference_prompt.md.BMjm1Jp3.lean.js +0 -1
- package/dist/docs/assets/reference_schedules.md.RC47aFm4.js +0 -47
- package/dist/docs/assets/reference_sessions.md.C7KFhWXV.js +0 -22
- package/dist/docs/assets/reference_subagents.md.CAhvW4yS.js +0 -10
- package/dist/docs/assets/reference_tools.md.DQr7Fnhu.js +0 -79
- package/dist/docs/assets/templates_agentic-owners.md.Dh2nDSqg.js +0 -13
- package/dist/docs/assets/templates_security-reviewer.md.DnwXdnB5.js +0 -3
- package/dist/docs/assets/templates_security-reviewer.md.DnwXdnB5.lean.js +0 -1
- package/dist/docs/assets/templates_thermo-quality-review.md.MJIdHkzE.js +0 -3
- package/dist/docs/assets/templates_thermo-quality-review.md.MJIdHkzE.lean.js +0 -1
- package/dist/docs/assets/templates_thermo-review.md.DfN1OFOl.js +0 -3
- package/dist/docs/assets/templates_thermo-review.md.DfN1OFOl.lean.js +0 -1
- package/dist/docs/assets/templates_triage.md.BYWMloV4.js +0 -9
- package/dist/docs/assets/templates_triage.md.BYWMloV4.lean.js +0 -1
- package/dist/docs/assets/troubleshooting.md.CGOdNVAL.js +0 -1
- package/dist/docs/guides/hooks.html +0 -113
- package/dist/docs/guides/hooks.md +0 -116
- package/dist/docs/package/skills/create-agent/SKILL.md +0 -178
- package/dist/docs/package/skills/evals/SKILL.md +0 -145
- package/dist/docs/package/skills/github/SKILL.md +0 -133
- package/dist/docs/package/skills/hillclimb/SKILL.md +0 -63
- package/dist/docs/package/skills/mcp-auth/SKILL.md +0 -60
- package/dist/docs/package/skills/migrate-v2/SKILL.md +0 -394
- package/dist/docs/package/skills/setup-slack/SKILL.md +0 -136
- package/dist/docs/reference/prompt.html +0 -68
- package/dist/docs/reference/prompt.md +0 -47
- package/dist/docs/templates/security-reviewer.html +0 -62
- package/dist/docs/templates/security-reviewer.md +0 -81
- package/dist/docs/templates/thermo-quality-review.html +0 -62
- package/dist/docs/templates/thermo-quality-review.md +0 -75
- package/dist/docs/templates/thermo-review.html +0 -62
- package/dist/docs/templates/thermo-review.md +0 -75
- package/dist/docs/templates/triage.html +0 -68
- package/dist/docs/templates/triage.md +0 -101
- package/dist/internal/filesystem/errors.d.ts +0 -64
- package/dist/internal/filesystem/errors.d.ts.map +0 -1
- package/dist/internal/filesystem/errors.js +0 -180
- package/dist/internal/filesystem/merge.d.ts +0 -34
- package/dist/internal/filesystem/merge.d.ts.map +0 -1
- package/dist/internal/filesystem/merge.js +0 -154
- package/dist/playground/assets/index-Cl9zvmmf.js +0 -62
- package/dist/playground/assets/index-F8b5WvWi.css +0 -1
- package/docs/guides/hooks.md +0 -121
- package/docs/reference/prompt.md +0 -52
- package/docs/templates/security-reviewer.md +0 -86
- package/docs/templates/thermo-quality-review.md +0 -80
- package/docs/templates/thermo-review.md +0 -80
- package/docs/templates/triage.md +0 -106
package/docs/deployment.md
CHANGED
|
@@ -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
|
-
|
|
9
|
-
|
|
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
|
|
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
|
-
```
|
|
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
|
|
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`
|
|
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
|
-
|
|
58
|
-
`defineConnection({ agent: "weather-agent" })
|
|
59
|
-
|
|
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
|
-
|
|
70
|
-
|
|
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
|
-
|
|
81
|
-
|
|
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
|
|
94
|
-
|
|
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,151 +67,82 @@ export default defineAgent({
|
|
|
109
67
|
});
|
|
110
68
|
```
|
|
111
69
|
|
|
112
|
-
|
|
113
|
-
|
|
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`
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
that
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
| No mode set | Every host in `hosting.egressDomains`. |
|
|
167
|
-
| Allow all network access | Every host in `hosting.egressDomains`. The bot stays limited to that list. |
|
|
168
|
-
| Defaults + team allowlist | The platform default list, plus the team list. |
|
|
169
|
-
| Team allowlist only | The team list. |
|
|
170
|
-
|
|
171
|
-
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.
|
|
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
|
+
### How egress works
|
|
95
|
+
|
|
96
|
+
A deployed agent can only reach hosts on its egress list. A call to any other
|
|
97
|
+
host fails, usually as a connection reset or a 403 from the proxy. Here's how
|
|
98
|
+
the egress allowlist gets built:
|
|
99
|
+
|
|
100
|
+
1. **Agent SDK Platform Egress:** Some hosts are required for the Agent SDK to
|
|
101
|
+
work, including the Cursor API.
|
|
102
|
+
2. **Your Agent's Egress:** The hosts defined in `hosting.egressDomains`, plus
|
|
103
|
+
any hosts that your mounted extensions add. If your Cursor team enables the
|
|
104
|
+
team-wide egress policy, then each of these hosts must also be on the
|
|
105
|
+
team's egress allowlist. If one isn't, `agent-sdk deploy` fails and names
|
|
106
|
+
the host, and the agent that's already running doesn't change.
|
|
107
|
+
3. **Channel Egress:** Each channel adds the hosts it needs by itself, and the
|
|
108
|
+
team allowlist doesn't apply to them. A Slack app adds `slack.com` and
|
|
109
|
+
`files.slack.com`. A GitHub or GitLab binding on a self-hosted instance
|
|
110
|
+
adds that host. MCP connections don't add anything, so be sure to declare
|
|
111
|
+
their hosts yourself in `hosting.egressDomains`.
|
|
112
|
+
|
|
113
|
+
Cursor saves your agent's list when you deploy, so an egress change only takes
|
|
114
|
+
effect after you deploy again. To check your declared and extension hosts
|
|
115
|
+
first, run `agent-sdk info --dir .`.
|
|
116
|
+
|
|
117
|
+
A team entry `*.example.com` allows `example.com`, every subdomain, and
|
|
118
|
+
narrower wildcards such as `*.api.example.com`. An agent entry
|
|
119
|
+
`*.example.com` skips the apex, so list `example.com` too when the agent
|
|
120
|
+
calls it.
|
|
121
|
+
|
|
122
|
+
A raw TCP host such as `db.example.com:5432` needs a team `CIDR:port` entry
|
|
123
|
+
that covers every public IPv4 address it resolves to. If your team
|
|
124
|
+
restricts egress, a PlanetScale Postgres host (`*.pg.psdb.cloud`) needs a
|
|
125
|
+
team `CIDR:port` entry for ports 5432 and 6432.
|
|
190
126
|
|
|
191
127
|
## Use the hosted agent
|
|
192
128
|
|
|
193
129
|
### Verify a hosted turn
|
|
194
130
|
|
|
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
|
-
```
|
|
217
|
-
|
|
218
|
-
Then follow the turn:
|
|
219
|
-
|
|
220
131
|
```bash
|
|
132
|
+
agent-sdk session create --slug weather-agent --message "Forecast for Paris" --wait
|
|
221
133
|
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
134
|
agent-sdk session get ses_... --prod --slug weather-agent --view events
|
|
135
|
+
agent-sdk logs --prod --slug weather-agent
|
|
239
136
|
```
|
|
240
137
|
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
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.
|
|
138
|
+
Without `--wait`, the command returns before the session exists, so the
|
|
139
|
+
output has no `sessionId` yet. A long turn can show `running` with no logs
|
|
140
|
+
for several minutes. If the event count keeps going up, the turn is still
|
|
141
|
+
working.
|
|
250
142
|
|
|
251
143
|
### Send work to the deployment
|
|
252
144
|
|
|
253
|
-
|
|
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:
|
|
145
|
+
Call a custom route on the stable alias URL with the alias token:
|
|
257
146
|
|
|
258
147
|
```bash
|
|
259
148
|
curl -X POST "$AGENT_ALIAS_URL/v1/channels/tickets/ticket" \
|
|
@@ -262,65 +151,35 @@ curl -X POST "$AGENT_ALIAS_URL/v1/channels/tickets/ticket" \
|
|
|
262
151
|
-d '{"ticketId":"ENG-142","message":"CSV export returns 500"}'
|
|
263
152
|
```
|
|
264
153
|
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
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).
|
|
154
|
+
See [Route responses](./reference/channels.md#route-responses) for what the
|
|
155
|
+
caller gets back. To confirm the work started, run
|
|
156
|
+
`agent-sdk session list --prod --slug weather-agent`.
|
|
273
157
|
|
|
274
158
|
### Protect the alias token
|
|
275
159
|
|
|
276
|
-
The first deploy prints the alias token once.
|
|
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.
|
|
160
|
+
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.
|
|
280
161
|
|
|
281
|
-
|
|
282
|
-
that
|
|
283
|
-
|
|
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).
|
|
162
|
+
Use [`publicEndpoint()`](./guides/webhooks.md) only for a webhook provider
|
|
163
|
+
that can't send the token and whose signature the channel verifies.
|
|
288
164
|
|
|
289
165
|
## Update the deployment
|
|
290
166
|
|
|
291
|
-
Push the new ref and deploy the same slug.
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
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.
|
|
167
|
+
Push the new ref and deploy the same slug. Each redeploy replaces the
|
|
168
|
+
watched repositories, so pass every `--cursor-events-repo` value again, or
|
|
169
|
+
the deployment watches only its GitHub source repository. Run
|
|
170
|
+
`agent-sdk deployment get weather-agent` to check a rollout.
|
|
306
171
|
|
|
307
172
|
## Keep state across replacements
|
|
308
173
|
|
|
309
|
-
|
|
310
|
-
|
|
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).
|
|
174
|
+
Sessions, `ctx.host.kv`, and `ctx.host.files` survive restarts and
|
|
175
|
+
redeploys. Anything else the agent writes to disk can disappear.
|
|
316
176
|
|
|
317
177
|
## Self-host securely
|
|
318
178
|
|
|
319
|
-
Run Agent SDK under Node 22.13 or newer, never Bun. One
|
|
320
|
-
|
|
321
|
-
state root keeps sessions across restarts.
|
|
179
|
+
Run Agent SDK under Node 22.13 or newer, never Bun. One process can serve
|
|
180
|
+
every agent under a directory:
|
|
322
181
|
|
|
323
|
-
```
|
|
182
|
+
```bash
|
|
324
183
|
export CURSOR_API_KEY="<cursor-api-key>"
|
|
325
184
|
export AGENT_SDK_BEARER_TOKEN="$(openssl rand -hex 32)"
|
|
326
185
|
|
|
@@ -332,45 +191,13 @@ agent-sdk serve \
|
|
|
332
191
|
--bearer-token "$AGENT_SDK_BEARER_TOKEN"
|
|
333
192
|
```
|
|
334
193
|
|
|
335
|
-
Before
|
|
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.
|
|
194
|
+
Before you expose the host:
|
|
363
195
|
|
|
364
|
-
|
|
196
|
+
- Put TLS or an authenticating proxy in front of the server.
|
|
197
|
+
- Keep `--bearer-token` unless a proxy authenticates every caller.
|
|
198
|
+
- Keep `--state-root` on a backed-up persistent volume outside the
|
|
199
|
+
repository.
|
|
200
|
+
- Turn on schedules in only one process per project.
|
|
365
201
|
|
|
366
|
-
|
|
367
|
-
|
|
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
|
|
202
|
+
In a container, use `--host 0.0.0.0` behind an authenticating network
|
|
203
|
+
boundary.
|