@grok/agent-sdk 0.2.28 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +29 -29
- package/dist/bin/agent-serve.d.ts +2 -2
- package/dist/bin/agent-serve.js +3 -3
- package/dist/channels/pagerduty/api.js +1 -1
- package/dist/channels/pagerduty/pagerduty-channel.d.ts +1 -1
- package/dist/channels/pagerduty/pagerduty-channel.d.ts.map +1 -1
- package/dist/channels/pagerduty/pagerduty-channel.js +1 -1
- package/dist/channels/pagerduty/replay.d.ts +1 -1
- package/dist/channels/pagerduty/replay.js +4 -4
- package/dist/channels/slack/cli-project.js +1 -1
- package/dist/docs/404.html +2 -2
- package/dist/docs/assets/{app.DF9vlcdn.js → app.BzTUBOAD.js} +4 -4
- package/dist/docs/assets/building-with-agents.md.BqJ7AAjG.js +6 -0
- package/dist/docs/assets/{building-with-agents.md.Bf1yH2tG.lean.js → building-with-agents.md.BqJ7AAjG.lean.js} +1 -1
- package/dist/docs/assets/changelog.md.BWhC6DET.js +1 -0
- package/dist/docs/assets/changelog.md.BWhC6DET.lean.js +1 -0
- package/dist/docs/assets/chunks/@localSearchIndexroot.CWxwVoCG.js +1 -0
- package/dist/docs/assets/chunks/{VPLocalSearchBox.D8OuwKO0.js → VPLocalSearchBox.DsnRlUT5.js} +1 -1
- package/dist/docs/assets/chunks/{arc.DCq_TCYV.js → arc.DH8GOhiv.js} +1 -1
- package/dist/docs/assets/chunks/{architectureDiagram-Q4EWVU46.PWRNTPbk.js → architectureDiagram-Q4EWVU46.9m9ObyuE.js} +1 -1
- package/dist/docs/assets/chunks/{baseUniq.BeRPvRUL.js → baseUniq.BXHpx1lE.js} +1 -1
- package/dist/docs/assets/chunks/{blockDiagram-DXYQGD6D.BuRmZVSo.js → blockDiagram-DXYQGD6D.xY3EX59q.js} +1 -1
- package/dist/docs/assets/chunks/{c4Diagram-AHTNJAMY.7DKSMwuv.js → c4Diagram-AHTNJAMY.DnqgMVgc.js} +1 -1
- package/dist/docs/assets/chunks/channel.Cctv0f7X.js +1 -0
- package/dist/docs/assets/chunks/{chunk-4BX2VUAB.7VrO9-9i.js → chunk-4BX2VUAB.BjFxK2A3.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-4TB4RGXK.CHystNE2.js → chunk-4TB4RGXK.BujS_Spt.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-55IACEB6.Nuh9TbTq.js → chunk-55IACEB6.YbTjhdaM.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-EDXVE4YY.CA0EKugm.js → chunk-EDXVE4YY.DnQ8t4GC.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-FMBD7UC4.F9_mp7U8.js → chunk-FMBD7UC4.B67AwAmj.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-OYMX7WX6.CEU4QfE1.js → chunk-OYMX7WX6.DrZIAFOm.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-QZHKN3VN.B8h_x9_i.js → chunk-QZHKN3VN.BLmmydkn.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-YZCP3GAM.Btfb-rKg.js → chunk-YZCP3GAM.DaoOfw0O.js} +1 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.DU5sqchW.js +1 -0
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.DU5sqchW.js +1 -0
- package/dist/docs/assets/chunks/clone.B9rdNt6j.js +1 -0
- package/dist/docs/assets/chunks/{cose-bilkent-S5V4N54A.DKvc96Wa.js → cose-bilkent-S5V4N54A.DMQuNhM5.js} +1 -1
- package/dist/docs/assets/chunks/{dagre-KV5264BT.CMo0cy1b.js → dagre-KV5264BT.CZoGVuUf.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-5BDNPKRD.DDgMOQhB.js → diagram-5BDNPKRD.CLt9uOyL.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-G4DWMVQ6.BdJnoIsU.js → diagram-G4DWMVQ6.DpczEm1G.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-MMDJMWI5.oSvhAZaL.js → diagram-MMDJMWI5.D4r13DvJ.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-TYMM5635.C9zZLIE-.js → diagram-TYMM5635.CYU9eGFu.js} +1 -1
- package/dist/docs/assets/chunks/{erDiagram-SMLLAGMA.BNhVyccy.js → erDiagram-SMLLAGMA.QA9naWEw.js} +1 -1
- package/dist/docs/assets/chunks/{flowDiagram-DWJPFMVM.BEFLLBiU.js → flowDiagram-DWJPFMVM.BbNoVZYd.js} +1 -1
- package/dist/docs/assets/chunks/{ganttDiagram-T4ZO3ILL.BdUzXBgY.js → ganttDiagram-T4ZO3ILL.IHjDoG7r.js} +1 -1
- package/dist/docs/assets/chunks/{gitGraphDiagram-UUTBAWPF.Rd3LlOIJ.js → gitGraphDiagram-UUTBAWPF.B21VMdf5.js} +1 -1
- package/dist/docs/assets/chunks/{graph.DnJC1GpG.js → graph.DgJ4L-8V.js} +1 -1
- package/dist/docs/assets/chunks/{infoDiagram-42DDH7IO.xv0xntDJ.js → infoDiagram-42DDH7IO.CQjrcthc.js} +1 -1
- package/dist/docs/assets/chunks/{ishikawaDiagram-UXIWVN3A.BaGIlviU.js → ishikawaDiagram-UXIWVN3A.D4tPGtVo.js} +1 -1
- package/dist/docs/assets/chunks/{journeyDiagram-VCZTEJTY.Cof_h0fp.js → journeyDiagram-VCZTEJTY.BD3WaNbQ.js} +1 -1
- package/dist/docs/assets/chunks/{kanban-definition-6JOO6SKY.C5GozFuU.js → kanban-definition-6JOO6SKY.Ca0o4Tqz.js} +1 -1
- package/dist/docs/assets/chunks/{layout.zc9UShLc.js → layout.DXXqX4MQ.js} +1 -1
- package/dist/docs/assets/chunks/{linear.BoqrFVcJ.js → linear.5c61gNw4.js} +1 -1
- package/dist/docs/assets/chunks/{min.DwIfr8hG.js → min.B1-NAjHX.js} +1 -1
- package/dist/docs/assets/chunks/{mindmap-definition-QFDTVHPH.Dkq2yTtp.js → mindmap-definition-QFDTVHPH.BELznv3-.js} +1 -1
- package/dist/docs/assets/chunks/{pieDiagram-DEJITSTG.B4CpTmHK.js → pieDiagram-DEJITSTG.qPzO1mq5.js} +1 -1
- package/dist/docs/assets/chunks/{quadrantDiagram-34T5L4WZ.BqXnFC9C.js → quadrantDiagram-34T5L4WZ.CxIvzbjX.js} +1 -1
- package/dist/docs/assets/chunks/{requirementDiagram-MS252O5E.DhIN2z-E.js → requirementDiagram-MS252O5E.CqA0iJx8.js} +1 -1
- package/dist/docs/assets/chunks/{sankeyDiagram-XADWPNL6.BhxUAmg2.js → sankeyDiagram-XADWPNL6.XRTutBnb.js} +1 -1
- package/dist/docs/assets/chunks/{sequenceDiagram-FGHM5R23.BqgU7HU-.js → sequenceDiagram-FGHM5R23.E--7bRLQ.js} +1 -1
- package/dist/docs/assets/chunks/{stateDiagram-FHFEXIEX.B1BCO18N.js → stateDiagram-FHFEXIEX.C4vGu8zq.js} +1 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.ECMu2BdJ.js +1 -0
- package/dist/docs/assets/chunks/{theme.oV7rddEz.js → theme.DMj_7q3B.js} +2 -2
- package/dist/docs/assets/chunks/{timeline-definition-GMOUNBTQ.oRI8UwMC.js → timeline-definition-GMOUNBTQ.C7LgNVAL.js} +1 -1
- package/dist/docs/assets/chunks/{vennDiagram-DHZGUBPP.DmuWrIxN.js → vennDiagram-DHZGUBPP.HUwoZcy_.js} +1 -1
- package/dist/docs/assets/chunks/{wardley-RL74JXVD.CEBjM5ov.js → wardley-RL74JXVD.BxFEFYZS.js} +1 -1
- package/dist/docs/assets/chunks/{wardleyDiagram-NUSXRM2D.m5zsCOF9.js → wardleyDiagram-NUSXRM2D.B2pSo5rB.js} +1 -1
- package/dist/docs/assets/chunks/{xychartDiagram-5P7HB3ND.cPN-587n.js → xychartDiagram-5P7HB3ND.NQhMiOOL.js} +1 -1
- package/dist/docs/assets/deployment.md.BtqJrHhp.js +31 -0
- package/dist/docs/assets/{deployment.md.DDmjAVbg.lean.js → deployment.md.BtqJrHhp.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.BcmSqL2z.js} +8 -8
- package/dist/docs/assets/guides_agent-to-agent.md.BcmSqL2z.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.6jiEH7dg.js} +11 -19
- package/dist/docs/assets/{guides_github.md.CgN5sNbW.lean.js → guides_github.md.6jiEH7dg.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.Ccw4pedT.js → guides_jev.md.DGCzkMUN.js} +20 -60
- package/dist/docs/assets/{guides_jev.md.Ccw4pedT.lean.js → guides_jev.md.DGCzkMUN.lean.js} +1 -1
- package/dist/docs/assets/{guides_mcp-oauth.md.ekpWOZCC.js → guides_mcp-oauth.md.C-Sx_IPa.js} +3 -5
- package/dist/docs/assets/{guides_mcp-oauth.md.ekpWOZCC.lean.js → guides_mcp-oauth.md.C-Sx_IPa.lean.js} +1 -1
- package/dist/docs/assets/guides_migrate.md.BbhHYeCr.js +3 -0
- package/dist/docs/assets/{guides_migrate.md.RS9Eu-Xh.lean.js → guides_migrate.md.BbhHYeCr.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.BgIGG9ur.js +82 -0
- package/dist/docs/assets/{guides_slack.md.BqiGSYGX.lean.js → guides_slack.md.BgIGG9ur.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.3TkdF79A.js +5 -0
- package/dist/docs/assets/hillclimbing.md.3TkdF79A.lean.js +1 -0
- package/dist/docs/assets/index.md.DRfaoRCZ.js +20 -0
- package/dist/docs/assets/index.md.DRfaoRCZ.lean.js +1 -0
- package/dist/docs/assets/quickstart.md.r-oE8nkX.js +113 -0
- package/dist/docs/assets/{quickstart.md.DaLk4ZIF.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.CExlH_mR.lean.js → reference_access.md.C5lblfUC.lean.js} +1 -1
- package/dist/docs/assets/reference_agent-config.md.C0Tp_Fk9.js +27 -0
- package/dist/docs/assets/{reference_agent-config.md.11E_xe--.lean.js → reference_agent-config.md.C0Tp_Fk9.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.B8GdpaRj.js +83 -0
- package/dist/docs/assets/reference_cli.md.B8GdpaRj.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.DYKjGFi-.lean.js → reference_evals.md.DgfUtfIc.lean.js} +1 -1
- package/dist/docs/assets/{reference_extensions.md.pEVj72Xo.js → reference_extensions.md.DHbW6eOf.js} +6 -8
- package/dist/docs/assets/{reference_extensions.md.pEVj72Xo.lean.js → reference_extensions.md.DHbW6eOf.lean.js} +1 -1
- package/dist/docs/assets/reference_hooks.md.CSWmOwMM.js +39 -0
- package/dist/docs/assets/reference_hooks.md.CSWmOwMM.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.RhQ9ZLo1.js +45 -0
- package/dist/docs/assets/{reference_schedules.md.RC47aFm4.lean.js → reference_schedules.md.RhQ9ZLo1.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.AGJ3jDzj.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 +5 -145
- package/dist/docs/deployment.html +54 -54
- package/dist/docs/deployment.md +86 -265
- package/dist/docs/evals.html +52 -71
- package/dist/docs/evals.md +33 -127
- package/dist/docs/guides/agent-to-agent.html +43 -43
- package/dist/docs/guides/agent-to-agent.md +27 -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 +57 -159
- package/dist/docs/guides/mcp-oauth.html +38 -40
- package/dist/docs/guides/mcp-oauth.md +34 -69
- 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 -205
- 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 +55 -62
- package/dist/docs/index.md +49 -82
- package/dist/docs/llms-full.txt +2292 -5830
- package/dist/docs/llms.txt +9 -15
- package/dist/docs/quickstart.html +96 -153
- package/dist/docs/quickstart.md +93 -178
- package/dist/docs/reference/access.html +36 -36
- package/dist/docs/reference/access.md +7 -12
- package/dist/docs/reference/agent-config.html +43 -56
- package/dist/docs/reference/agent-config.md +93 -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 +233 -698
- package/dist/docs/reference/connections.html +45 -57
- package/dist/docs/reference/connections.md +83 -164
- package/dist/docs/reference/evals.html +66 -53
- package/dist/docs/reference/evals.md +97 -128
- 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 +46 -48
- 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/evals.d.ts +2 -2
- package/dist/extensions/jev/extension.d.ts +12 -2
- package/dist/extensions/jev/extension.d.ts.map +1 -1
- package/dist/extensions/jev/extension.js +4 -0
- package/dist/extensions/jev/lib/evaluate.d.ts +31 -4
- package/dist/extensions/jev/lib/evaluate.d.ts.map +1 -1
- package/dist/extensions/jev/lib/evaluate.js +18 -4
- package/dist/internal/cli/command.d.ts +1 -1
- package/dist/internal/cli/command.js +1 -1
- package/dist/internal/cli/commands/channels.js +6 -6
- package/dist/internal/cli/commands/develop.d.ts.map +1 -1
- package/dist/internal/cli/commands/develop.js +23 -14
- package/dist/internal/cli/commands/hosted.js +4 -4
- package/dist/internal/cli/commands/index.d.ts +1 -1
- package/dist/internal/cli/commands/index.d.ts.map +1 -1
- package/dist/internal/cli/commands/index.js +1 -1
- package/dist/internal/cli/commands/mcp.js +1 -1
- package/dist/internal/cli/commands/project.js +4 -4
- package/dist/internal/cli/commands/scaffold.d.ts.map +1 -1
- package/dist/internal/cli/commands/scaffold.js +9 -6
- package/dist/internal/cli/commands/serve.d.ts +1 -1
- package/dist/internal/cli/commands/serve.js +5 -5
- package/dist/internal/cli/commands/session.d.ts.map +1 -1
- package/dist/internal/cli/commands/session.js +12 -7
- package/dist/internal/cli/dispatch.d.ts +3 -3
- package/dist/internal/cli/dispatch.js +3 -3
- package/dist/internal/cli/errors.d.ts +1 -1
- package/dist/internal/cli/errors.d.ts.map +1 -1
- package/dist/internal/cli/errors.js +1 -1
- package/dist/internal/cli/flags.d.ts +2 -2
- package/dist/internal/cli/flags.d.ts.map +1 -1
- package/dist/internal/cli/flags.js +2 -2
- package/dist/internal/cli/help-command.d.ts +1 -1
- package/dist/internal/cli/help-command.js +2 -2
- package/dist/internal/cli/help.d.ts +7 -7
- package/dist/internal/cli/help.d.ts.map +1 -1
- package/dist/internal/cli/help.js +8 -8
- package/dist/internal/cli-ax.d.ts.map +1 -1
- package/dist/internal/cli-ax.js +3 -0
- package/dist/internal/cli-convert-automation.d.ts +1 -1
- package/dist/internal/cli-convert-automation.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-migrate.d.ts +1 -1
- package/dist/internal/cli-migrate.js +1 -1
- package/dist/internal/cli-pagerduty.d.ts +1 -1
- package/dist/internal/cli-pagerduty.js +1 -1
- package/dist/internal/cli-skills.js +1 -1
- package/dist/internal/convert-automation/types.d.ts +1 -1
- package/dist/internal/convert-automation/types.js +1 -1
- package/dist/internal/cursor/credentials.js +1 -1
- package/dist/internal/deploy-client.d.ts +2 -2
- package/dist/internal/deploy-client.d.ts.map +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/init-project.d.ts +7 -3
- package/dist/internal/init-project.d.ts.map +1 -1
- package/dist/internal/init-project.js +60 -12
- package/dist/internal/init-scaffold.d.ts +2 -1
- package/dist/internal/init-scaffold.d.ts.map +1 -1
- package/dist/internal/init-scaffold.js +20 -7
- package/dist/internal/peer-connections.js +1 -1
- package/dist/internal/reminder-runner.js +1 -1
- package/dist/internal/server.d.ts +1 -1
- package/dist/internal/session-cost.d.ts +4 -4
- package/dist/internal/session-cost.d.ts.map +1 -1
- package/dist/internal/session-cost.js +4 -4
- package/dist/internal/session-engine.d.ts +1 -1
- package/dist/internal/session-engine.js +2 -2
- package/dist/internal/shallow-clone.js +1 -1
- package/dist/playground/assets/index-D6mVn9og.js +62 -0
- package/dist/playground/assets/index-DlALM6gr.css +1 -0
- package/dist/playground/index.html +2 -2
- package/dist/types.d.ts +9 -22
- package/dist/types.d.ts.map +1 -1
- package/docs/README.md +49 -82
- package/docs/building-with-agents.md +11 -104
- package/docs/changelog.md +6 -146
- package/docs/deployment.md +86 -265
- package/docs/evals.md +34 -128
- package/docs/guides/agent-to-agent.md +27 -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 +57 -159
- package/docs/guides/mcp-oauth.md +34 -69
- 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 -205
- package/docs/guides/webhooks.md +64 -146
- package/docs/hillclimbing.md +41 -103
- package/docs/quickstart.md +93 -178
- package/docs/reference/access.md +7 -12
- package/docs/reference/agent-config.md +93 -176
- package/docs/reference/artifacts.md +38 -62
- package/docs/reference/channels.md +102 -151
- package/docs/reference/cli.md +233 -698
- package/docs/reference/connections.md +83 -164
- package/docs/reference/evals.md +97 -128
- 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 +3 -9
- package/skills/cli/SKILL.md +15 -15
- package/skills/create-agent/SKILL.md +20 -19
- package/skills/debug/SKILL.md +4 -4
- package/skills/deploy/SKILL.md +2 -2
- package/skills/evals/SKILL.md +8 -8
- package/skills/framework-map/SKILL.md +3 -3
- package/skills/github/SKILL.md +7 -7
- package/skills/hillclimb/SKILL.md +4 -4
- package/skills/mcp-auth/SKILL.md +3 -3
- package/skills/migrate-v2/SKILL.md +40 -41
- package/skills/otel/SKILL.md +2 -2
- package/skills/setup-slack/SKILL.md +8 -8
- package/templates/agentic-owners/README.md +5 -5
- package/templates/agentic-owners/bot/tools/record_review.ts +1 -1
- package/templates/agentic-owners/package.json +1 -1
- package/templates/agents-md/README.md +4 -4
- package/templates/agents-md/package.json +1 -1
- package/templates/code-wiki/README.md +3 -3
- package/templates/code-wiki/package.json +1 -1
- package/templates/demo/README.md +3 -3
- package/templates/demo/package.json +1 -1
- package/templates/pr-autofixer/package.json +1 -1
- package/templates/security-help/README.md +5 -5
- package/templates/security-help/package.json +1 -1
- package/templates/security-reviewer/README.md +3 -3
- package/templates/security-reviewer/package.json +1 -1
- package/templates/thermo-quality-review/README.md +4 -4
- package/templates/thermo-quality-review/package.json +1 -1
- package/templates/thermo-review/README.md +4 -4
- package/templates/thermo-review/package.json +1 -1
- package/templates/triage/README.md +3 -3
- package/templates/triage/overlays/jira/README.md +3 -3
- package/templates/triage/overlays/linear/README.md +3 -3
- package/templates/triage/package.json +1 -1
- package/dist/docs/assets/building-with-agents.md.Bf1yH2tG.js +0 -9
- package/dist/docs/assets/changelog.md.fZ-NNFeJ.js +0 -1
- package/dist/docs/assets/changelog.md.fZ-NNFeJ.lean.js +0 -1
- package/dist/docs/assets/chunks/@localSearchIndexroot.mfzjiOsL.js +0 -1
- package/dist/docs/assets/chunks/channel.goFR5lbe.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.B2yLtFja.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.B2yLtFja.js +0 -1
- package/dist/docs/assets/chunks/clone.CztV97Wu.js +0 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.CZlVHdDZ.js +0 -1
- package/dist/docs/assets/deployment.md.DDmjAVbg.js +0 -31
- package/dist/docs/assets/evals.md.OjKb7tNA.js +0 -68
- package/dist/docs/assets/evals.md.OjKb7tNA.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_grokbot-agents.md.D0PpM_Gf.js +0 -15
- package/dist/docs/assets/guides_grokbot-agents.md.D0PpM_Gf.lean.js +0 -1
- 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.BqiGSYGX.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.CVRjO09Y.js +0 -27
- package/dist/docs/assets/index.md.CVRjO09Y.lean.js +0 -1
- package/dist/docs/assets/quickstart.md.DaLk4ZIF.js +0 -170
- package/dist/docs/assets/reference_access.md.CExlH_mR.js +0 -1
- package/dist/docs/assets/reference_agent-config.md.11E_xe--.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.DQ3dCgmk.js +0 -99
- package/dist/docs/assets/reference_cli.md.DQ3dCgmk.lean.js +0 -1
- package/dist/docs/assets/reference_connections.md.BoAotr7_.js +0 -66
- package/dist/docs/assets/reference_evals.md.DYKjGFi-.js +0 -56
- 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.Da1HegjB.js +0 -8
- package/dist/docs/assets/reference_limits.md.Da1HegjB.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.AGJ3jDzj.js +0 -1
- package/dist/docs/guides/grokbot-agents.html +0 -74
- package/dist/docs/guides/grokbot-agents.md +0 -129
- package/dist/docs/guides/hooks.html +0 -113
- package/dist/docs/guides/hooks.md +0 -116
- 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/extensions/cursor-grokbot-agents/extension.d.ts +0 -71
- package/dist/extensions/cursor-grokbot-agents/extension.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/extension.js +0 -64
- package/dist/extensions/cursor-grokbot-agents/lib/agents.d.ts +0 -11
- package/dist/extensions/cursor-grokbot-agents/lib/agents.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/agents.js +0 -31
- package/dist/extensions/cursor-grokbot-agents/lib/backend.d.ts +0 -56
- package/dist/extensions/cursor-grokbot-agents/lib/backend.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/backend.js +0 -139
- package/dist/extensions/cursor-grokbot-agents/lib/contacts.d.ts +0 -28
- package/dist/extensions/cursor-grokbot-agents/lib/contacts.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/contacts.js +0 -46
- package/dist/extensions/cursor-grokbot-agents/lib/conversation.d.ts +0 -53
- package/dist/extensions/cursor-grokbot-agents/lib/conversation.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/conversation.js +0 -186
- package/dist/extensions/cursor-grokbot-agents/lib/inputs.d.ts +0 -4
- package/dist/extensions/cursor-grokbot-agents/lib/inputs.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/inputs.js +0 -15
- package/dist/extensions/cursor-grokbot-agents/lib/lock.d.ts +0 -12
- package/dist/extensions/cursor-grokbot-agents/lib/lock.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/lock.js +0 -24
- package/dist/extensions/cursor-grokbot-agents/skills/consult.md +0 -40
- package/dist/extensions/cursor-grokbot-agents/tools/ask.d.ts +0 -4
- package/dist/extensions/cursor-grokbot-agents/tools/ask.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/tools/ask.js +0 -26
- package/dist/extensions/cursor-grokbot-agents/tools/check.d.ts +0 -4
- package/dist/extensions/cursor-grokbot-agents/tools/check.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/tools/check.js +0 -21
- package/dist/extensions/cursor-grokbot-agents/tools/interrupt.d.ts +0 -4
- package/dist/extensions/cursor-grokbot-agents/tools/interrupt.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/tools/interrupt.js +0 -13
- package/dist/extensions/cursor-grokbot-agents/tools/list.d.ts +0 -4
- package/dist/extensions/cursor-grokbot-agents/tools/list.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/tools/list.js +0 -22
- package/dist/playground/assets/index-BMpVzZzC.css +0 -1
- package/dist/playground/assets/index-_3zz3yh8.js +0 -62
- package/docs/guides/grokbot-agents.md +0 -134
- 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/dist/docs/deployment.md
CHANGED
|
@@ -1,39 +1,22 @@
|
|
|
1
1
|
# Deploy an Agent SDK project
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
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
|
|
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
|
-
```
|
|
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
|
|
32
|
-
deployment URL.
|
|
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`
|
|
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
|
-
|
|
53
|
-
`defineConnection({ agent: "weather-agent" })
|
|
54
|
-
|
|
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
|
-
|
|
65
|
-
|
|
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
|
-
|
|
76
|
-
|
|
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
|
|
89
|
-
|
|
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,57 +62,35 @@ export default defineAgent({
|
|
|
104
62
|
});
|
|
105
63
|
```
|
|
106
64
|
|
|
107
|
-
|
|
108
|
-
|
|
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`
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
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.
|
|
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
|
+
Your team's egress policy limits which hosts you can list in
|
|
90
|
+
`hosting.egressDomains`. If you list a host that the policy blocks,
|
|
91
|
+
`agent-sdk deploy` fails and the error names that host. A deployment that
|
|
92
|
+
is already running keeps the policy from its last successful deploy. Ask a
|
|
93
|
+
team admin to add the host, or remove it and deploy again.
|
|
158
94
|
|
|
159
95
|
| Team egress mode | What `agent-sdk deploy` allows |
|
|
160
96
|
| --- | --- |
|
|
@@ -163,92 +99,39 @@ snapshot does not pin the addresses from that lookup.
|
|
|
163
99
|
| Defaults + team allowlist | The platform default list, plus the team list. |
|
|
164
100
|
| Team allowlist only | The team list. |
|
|
165
101
|
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
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.
|
|
102
|
+
No team list can remove the platform base, which includes Cursor's API and
|
|
103
|
+
the npm registry. `agent-sdk deploy --json` lists every allowed host under
|
|
104
|
+
`egress.effective`.
|
|
185
105
|
|
|
186
|
-
|
|
106
|
+
A team entry `*.example.com` allows `example.com`, every subdomain, and
|
|
107
|
+
narrower wildcards such as `*.api.example.com`. An agent entry
|
|
108
|
+
`*.example.com` skips the apex, so list `example.com` too when the agent
|
|
109
|
+
calls it.
|
|
187
110
|
|
|
188
|
-
|
|
111
|
+
A raw TCP host such as `db.example.com:5432` needs a team `CIDR:port` entry
|
|
112
|
+
that covers every public IPv4 address it resolves to. If your team
|
|
113
|
+
restricts egress, a PlanetScale Postgres host (`*.pg.psdb.cloud`) needs a
|
|
114
|
+
team `CIDR:port` entry for ports 5432 and 6432.
|
|
189
115
|
|
|
190
|
-
|
|
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 from **Deployed Agents** in the
|
|
207
|
-
[dashboard](https://cursor.com/dashboard) and select **Sessions**:
|
|
208
|
-
|
|
209
|
-
```bash
|
|
210
|
-
agent-sdk logs --prod --once --slug weather-agent
|
|
211
|
-
```
|
|
116
|
+
## Use the hosted agent
|
|
212
117
|
|
|
213
|
-
|
|
118
|
+
### Verify a hosted turn
|
|
214
119
|
|
|
215
120
|
```bash
|
|
121
|
+
agent-sdk session create --slug weather-agent --message "Forecast for Paris" --wait
|
|
216
122
|
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 the dashboard 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
123
|
agent-sdk session get ses_... --prod --slug weather-agent --view events
|
|
124
|
+
agent-sdk logs --prod --slug weather-agent
|
|
234
125
|
```
|
|
235
126
|
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
`session create`. `agent-sdk session get ses_... --prod --slug weather-agent --web`
|
|
241
|
-
opens the session in the dashboard 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.
|
|
127
|
+
Without `--wait`, the command returns before the session exists, so the
|
|
128
|
+
output has no `sessionId` yet. A long turn can show `running` with no logs
|
|
129
|
+
for several minutes. If the event count keeps going up, the turn is still
|
|
130
|
+
working.
|
|
245
131
|
|
|
246
132
|
### Send work to the deployment
|
|
247
133
|
|
|
248
|
-
|
|
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:
|
|
134
|
+
Call a custom route on the stable alias URL with the alias token:
|
|
252
135
|
|
|
253
136
|
```bash
|
|
254
137
|
curl -X POST "$AGENT_ALIAS_URL/v1/channels/tickets/ticket" \
|
|
@@ -257,115 +140,53 @@ curl -X POST "$AGENT_ALIAS_URL/v1/channels/tickets/ticket" \
|
|
|
257
140
|
-d '{"ticketId":"ENG-142","message":"CSV export returns 500"}'
|
|
258
141
|
```
|
|
259
142
|
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
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).
|
|
143
|
+
See [Route responses](/docs/reference/channels.md#route-responses) for what the
|
|
144
|
+
caller gets back. To confirm the work started, run
|
|
145
|
+
`agent-sdk session list --prod --slug weather-agent`.
|
|
268
146
|
|
|
269
147
|
### Protect the alias token
|
|
270
148
|
|
|
271
|
-
The first deploy prints the alias token once.
|
|
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.
|
|
275
|
-
|
|
276
|
-
`deployment --json` can include short-lived access headers, so treat
|
|
277
|
-
that output as a credential too.
|
|
149
|
+
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.
|
|
278
150
|
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
signature. That opens the custom channel path, not the built-in session
|
|
282
|
-
or tool APIs. See [Webhooks](/docs/guides/webhooks.md).
|
|
151
|
+
Use [`publicEndpoint()`](/docs/guides/webhooks.md) only for a webhook provider
|
|
152
|
+
that can't send the token and whose signature the channel verifies.
|
|
283
153
|
|
|
284
154
|
## Update the deployment
|
|
285
155
|
|
|
286
|
-
Push the new ref and deploy the same slug.
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
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.
|
|
156
|
+
Push the new ref and deploy the same slug. Each redeploy replaces the
|
|
157
|
+
watched repositories, so pass every `--cursor-events-repo` value again, or
|
|
158
|
+
the deployment watches only its GitHub source repository. Run
|
|
159
|
+
`agent-sdk deployment get weather-agent` to check a rollout.
|
|
301
160
|
|
|
302
161
|
## Keep state across replacements
|
|
303
162
|
|
|
304
|
-
|
|
305
|
-
|
|
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).
|
|
163
|
+
Sessions, `ctx.host.kv`, and `ctx.host.files` survive restarts and
|
|
164
|
+
redeploys. Anything else the agent writes to disk can disappear.
|
|
311
165
|
|
|
312
166
|
## Self-host securely
|
|
313
167
|
|
|
314
|
-
Run Agent SDK under Node 22.13 or newer, never Bun. One
|
|
315
|
-
|
|
316
|
-
state root keeps sessions across restarts.
|
|
168
|
+
Run Agent SDK under Node 22.13 or newer, never Bun. One process can serve
|
|
169
|
+
every agent under a directory:
|
|
317
170
|
|
|
318
|
-
```
|
|
171
|
+
```bash
|
|
319
172
|
export CURSOR_API_KEY="<cursor-api-key>"
|
|
320
|
-
export
|
|
173
|
+
export AGENT_SDK_BEARER_TOKEN="$(openssl rand -hex 32)"
|
|
321
174
|
|
|
322
175
|
agent-sdk serve \
|
|
323
176
|
--dir /srv/agents \
|
|
324
177
|
--host 127.0.0.1 \
|
|
325
178
|
--port 3000 \
|
|
326
|
-
--state-root /var/lib/
|
|
327
|
-
--bearer-token "$
|
|
179
|
+
--state-root /var/lib/agent-sdk \
|
|
180
|
+
--bearer-token "$AGENT_SDK_BEARER_TOKEN"
|
|
328
181
|
```
|
|
329
182
|
|
|
330
|
-
Before
|
|
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.
|
|
183
|
+
Before you expose the host:
|
|
358
184
|
|
|
359
|
-
|
|
185
|
+
- Put TLS or an authenticating proxy in front of the server.
|
|
186
|
+
- Keep `--bearer-token` unless a proxy authenticates every caller.
|
|
187
|
+
- Keep `--state-root` on a backed-up persistent volume outside the
|
|
188
|
+
repository.
|
|
189
|
+
- Turn on schedules in only one process per project.
|
|
360
190
|
|
|
361
|
-
|
|
362
|
-
|
|
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
|
|
191
|
+
In a container, use `--host 0.0.0.0` behind an authenticating network
|
|
192
|
+
boundary.
|