@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/guides/migrate.md
CHANGED
|
@@ -5,172 +5,98 @@ description: "Move a hosted Agent SDK architecture v1 project to v2 through a re
|
|
|
5
5
|
|
|
6
6
|
# Migrate an early-alpha project to architecture v2
|
|
7
7
|
|
|
8
|
-
Use this guide only for Agent SDK
|
|
9
|
-
early alpha.
|
|
10
|
-
and need no migration.
|
|
8
|
+
Use this guide only for an Agent SDK project deployed on architecture v1 during
|
|
9
|
+
the early alpha. Every other project already runs on v2.
|
|
11
10
|
|
|
12
11
|
## Check whether your project needs migration
|
|
13
12
|
|
|
14
|
-
|
|
13
|
+
Your project needs migration if any of these is true:
|
|
15
14
|
|
|
16
|
-
- `package.json` depends on
|
|
17
|
-
|
|
15
|
+
- `package.json` depends on `@cursor/july`.
|
|
16
|
+
- A script or CI job runs the early-alpha CLI.
|
|
17
|
+
- The agent sets `architecture: "v1"` or `runtime: "grokbot"`.
|
|
18
|
+
- The project has `bot/storage.ts` or `agent/storage.ts`.
|
|
19
|
+
- An SCM channel credential is a literal value.
|
|
20
|
+
- Code uses a `/v1` continuation selector.
|
|
21
|
+
- A reminder uses an anonymous `run` or `until` function.
|
|
22
|
+
- A peer connection reads its URL from a `*_MCP_URL` secret.
|
|
23
|
+
- `agent-sdk deployment get <slug>` doesn't print `architecture: v2`.
|
|
18
24
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
```
|
|
25
|
+
`agent-sdk migrate` checks the source for these signals and prints
|
|
26
|
+
`Nothing to migrate.` when it finds none. It doesn't check scripts, CI jobs, or
|
|
27
|
+
the hosted deployment.
|
|
23
28
|
|
|
24
|
-
|
|
29
|
+
To swap the early-alpha package, run:
|
|
25
30
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
Stop when none of these is true. An existing `agent/` project root can remain
|
|
31
|
-
in place; Agent SDK still loads it even though current examples use `bot/`.
|
|
31
|
+
```bash
|
|
32
|
+
npm uninstall @cursor/july
|
|
33
|
+
npm install __BDK_PACKAGE__@latest
|
|
34
|
+
```
|
|
32
35
|
|
|
33
|
-
|
|
34
|
-
no migration work. The check looks for an `@cursor/july` dependency,
|
|
35
|
-
`architecture: "v1"`, `bot/storage.ts` or `agent/storage.ts`,
|
|
36
|
-
`runtime: "grokbot"`, a literal SCM credential, a `/v1` continuation selector,
|
|
37
|
-
an anonymous reminder, and a `*_MCP_URL` peer connection. When any of those is
|
|
38
|
-
present, or a project file cannot be read, the command starts the agent. It
|
|
39
|
-
does not read the hosted deployment. Run `agent-sdk deployment get <slug>` when you still
|
|
40
|
-
need to see whether that copy is on v1.
|
|
36
|
+
An existing `agent/` folder still works.
|
|
41
37
|
|
|
42
38
|
## Start the migration
|
|
43
39
|
|
|
44
|
-
Commit and push the source
|
|
45
|
-
pushed
|
|
46
|
-
and waits for the agent to open a pull request. It does not deploy the project.
|
|
40
|
+
Commit and push the source first. `agent-sdk migrate` starts a Cursor cloud
|
|
41
|
+
agent on that pushed ref, and the agent opens a pull request without deploying.
|
|
47
42
|
|
|
48
43
|
```bash
|
|
49
44
|
agent-sdk login
|
|
50
45
|
agent-sdk migrate --dir .
|
|
51
46
|
```
|
|
52
47
|
|
|
53
|
-
|
|
54
|
-
path
|
|
55
|
-
|
|
56
|
-
```bash
|
|
57
|
-
agent-sdk migrate \
|
|
58
|
-
--dir ./bots/triage \
|
|
59
|
-
--repo https://github.com/acme/agents \
|
|
60
|
-
--ref migrate-triage-v2 \
|
|
61
|
-
--path bots/triage
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
Use `--no-wait` to print the cloud agent URL and return while it works. Use
|
|
65
|
-
`--json` for machine-readable status. The
|
|
66
|
-
[CLI reference](../reference/cli.md#migrate) covers every flag, output, and
|
|
67
|
-
exit status.
|
|
68
|
-
|
|
69
|
-
## Use the coding-agent skill directly
|
|
70
|
-
|
|
71
|
-
You can instead ask a coding agent working in the project checkout to follow
|
|
72
|
-
the bundled
|
|
73
|
-
[`bdk-migrate-v2` skill](../../skills/migrate-v2/SKILL.md). The skill owns the
|
|
74
|
-
code changes, capability checks, local verification, and deployment handoff.
|
|
48
|
+
To migrate a pushed source outside your checkout, pass `--repo`, `--ref`, and
|
|
49
|
+
`--path`. The [CLI reference](../reference/cli.md#migrate) lists every flag.
|
|
75
50
|
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
If the project depends on a v1 capability without a supported v2 path, the
|
|
80
|
-
skill tells the coding agent to stop and name the blocker instead of removing
|
|
81
|
-
the behavior.
|
|
51
|
+
You can also ask a coding agent in your checkout to follow the bundled `agent-sdk-migrate-v2` skill. If the project
|
|
52
|
+
relies on a v1 capability that has no v2 path, the agent stops and names the
|
|
53
|
+
blocker.
|
|
82
54
|
|
|
83
55
|
## Review the pull request
|
|
84
56
|
|
|
85
|
-
Before
|
|
86
|
-
|
|
87
|
-
- Uses `@grok/agent-sdk` and `agent-sdk`, and removes the v1 architecture opt-in.
|
|
88
|
-
|
|
89
|
-
- Moves durable state to `ctx.host.kv` or `ctx.host.files`, reads secrets
|
|
90
|
-
inside the handler that needs them, and accounts for hosted HTTP routes
|
|
91
|
-
returning `202`.
|
|
92
|
-
|
|
93
|
-
- Names SCM channel secrets instead of reading them: every
|
|
94
|
-
`githubChannel({ credentials })` field and the GitLab or Bitbucket
|
|
95
|
-
`webhookSecret` is `{ secretName: "NAME" }`. `agent-sdk validate` reports each
|
|
96
|
-
field still written as a literal or `() => process.env.NAME` getter, as a
|
|
97
|
-
warning while `architecture: "v1"` is set and as an error once it is
|
|
98
|
-
removed. The [GitHub guide](./github.md#other-hosts) explains the named
|
|
99
|
-
form.
|
|
100
|
-
|
|
101
|
-
- Rewrites each peer call that took its URL from a secret or environment
|
|
102
|
-
variable, such as `BUILDER_MCP_URL`, to
|
|
103
|
-
`defineConnection({ agent: "<slug>" })` under `bot/mcp-connections/`
|
|
104
|
-
(or `agent/mcp-connections/` when the project root is `agent/`).
|
|
105
|
-
Confirm the slug before you merge. The pull request lists each secret the
|
|
106
|
-
rewrite left unused, and it leaves a TODO where it could not determine
|
|
107
|
-
the slug.
|
|
57
|
+
Before you merge, check that the pull request:
|
|
108
58
|
|
|
109
|
-
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
59
|
+
- Uses `@grok/agent-sdk` and `agent-sdk`, and removes `architecture: "v1"`.
|
|
60
|
+
- Moves durable state to `ctx.host.kv` or `ctx.host.files`, reads secrets inside
|
|
61
|
+
the handler that needs them, and expects hosted routes to return `202`.
|
|
62
|
+
- Passes every SCM credential as `{ secretName: "NAME" }`. `agent-sdk validate`
|
|
63
|
+
warns about a literal or `process.env` getter while `architecture: "v1"` is
|
|
64
|
+
set, and fails once you remove it.
|
|
65
|
+
- Replaces each peer URL secret, such as `BUILDER_MCP_URL`, with
|
|
66
|
+
`defineConnection({ agent: "<slug>" })`. Check each slug and any TODO the
|
|
67
|
+
agent left.
|
|
68
|
+
- Lists unsupported behavior, follow-ups, and the checks it ran or handed off.
|
|
116
69
|
|
|
117
70
|
## Choose a cutover
|
|
118
71
|
|
|
119
72
|
| Cutover | What happens | Choose it when |
|
|
120
73
|
| --- | --- | --- |
|
|
121
|
-
| Same slug |
|
|
122
|
-
| New slug |
|
|
74
|
+
| Same slug | v2 copies the v1 secrets and replaces v1 once it starts. You can't undo it, and it deletes v1's hosted sessions, KV, files, and eval runs. | A short outage and an empty v2 state are fine. |
|
|
75
|
+
| New slug | v1 keeps serving while you test v2. Move senders to the new URL, then delete v1. | You use Slack, webhooks, or hosted state. |
|
|
123
76
|
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
events. If the CLI reports that same-slug replacement is unavailable, use a
|
|
127
|
-
new slug.
|
|
77
|
+
With a new slug, point the trial at a test repository so the two deployments
|
|
78
|
+
don't both act on the same events.
|
|
128
79
|
|
|
129
80
|
## Deploy after merge
|
|
130
81
|
|
|
131
82
|
Deploy from the merged, pushed ref. Reuse every `--cursor-events-repo` value
|
|
132
|
-
from
|
|
133
|
-
`hosting.egressDomains`. `agent-sdk deploy` has no `--allow-domain` flag.
|
|
83
|
+
from v1, and move every `--allow-domain` value into `hosting.egressDomains`.
|
|
134
84
|
|
|
135
85
|
```bash
|
|
136
|
-
agent-sdk validate --dir .
|
|
137
86
|
agent-sdk deploy --dir . --slug <existing-or-new-slug>
|
|
138
87
|
```
|
|
139
88
|
|
|
140
|
-
|
|
141
|
-
alone. Run `agent-sdk deploy --dir <agent folder>` one time for each agent. One
|
|
142
|
-
`agent-sdk deploy` on the parent folder prints those commands and does not deploy.
|
|
143
|
-
Do not use `agent-sdk deploy --all`. Repeat `agent-sdk slack create --env prod` for each
|
|
144
|
-
agent folder. The Slack app slug is the folder name.
|
|
145
|
-
|
|
146
|
-
When the pull request calls another agent with
|
|
147
|
-
`defineConnection({ agent: "<slug>" })`, deploy the caller and that peer
|
|
148
|
-
on `@grok/agent-sdk` 0.2.18 or newer. Both deployments must belong to the
|
|
149
|
-
same team, and the caller reaches the peer once the peer deployment is
|
|
150
|
-
running. The connection file is already in the merged source, so unset
|
|
151
|
-
each URL secret the pull request lists after both deploys:
|
|
89
|
+
Then follow the checklist that `agent-sdk migrate` printed:
|
|
152
90
|
|
|
153
|
-
|
|
154
|
-
agent-sdk
|
|
155
|
-
|
|
91
|
+
1. Deploy each agent folder separately by running
|
|
92
|
+
`agent-sdk deploy --dir <agent-folder>` once for each one.
|
|
93
|
+
2. For each Slack agent, run
|
|
94
|
+
`agent-sdk slack create --env prod --dir <agent-folder>`. Then uninstall the
|
|
95
|
+
old app and invite the new bot to its channels.
|
|
96
|
+
3. For a [peer connection](./agent-to-agent.md), deploy both agents to the same
|
|
97
|
+
team. Then delete each peer URL secret the pull request lists with
|
|
98
|
+
`agent-sdk secret delete <slug> NAME`.
|
|
99
|
+
4. For a new slug, add each secret with `agent-sdk secret set <slug> NAME`. It
|
|
100
|
+
applies without a redeploy.
|
|
156
101
|
|
|
157
|
-
|
|
158
|
-
agent folder, `agent-sdk slack create --env prod --dir <agent-folder>` for each Slack
|
|
159
|
-
agent, `agent-sdk secret delete` for peer URL secrets the pull request lists, and
|
|
160
|
-
`agent-sdk secret list` / `agent-sdk secret set` when the slug is new. Slack setup
|
|
161
|
-
redeploys the deployment by itself. `agent-sdk secret set` takes effect on the
|
|
162
|
-
next request. Neither step needs another deploy.
|
|
163
|
-
|
|
164
|
-
After the deployment starts, follow that checklist for Slack, webhook callers,
|
|
165
|
-
peer connections, and secrets, then verify a hosted turn. The
|
|
166
|
-
[deployment guide](../deployment.md) covers the managed hosting workflow.
|
|
167
|
-
|
|
168
|
-
## Related
|
|
169
|
-
|
|
170
|
-
- [CLI reference](../reference/cli.md#migrate): migration flags, output, and
|
|
171
|
-
exit status
|
|
172
|
-
- [`bdk-migrate-v2` skill](../../skills/migrate-v2/SKILL.md): the coding
|
|
173
|
-
procedure and complete capability matrix
|
|
174
|
-
- [Peer agents](./agent-to-agent.md): how a deployed caller reaches another
|
|
175
|
-
agent by slug
|
|
176
|
-
- [Deployment](../deployment.md): deploy and verify the reviewed project
|
|
102
|
+
Finally, [verify a hosted turn](../deployment.md).
|
|
@@ -1,6 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "OpenTelemetry"
|
|
3
|
+
description: "Export traces, metrics, and logs to an OTLP collector and tag them per turn."
|
|
4
|
+
---
|
|
5
|
+
|
|
1
6
|
# OpenTelemetry
|
|
2
7
|
|
|
3
|
-
Agent SDK sends traces, metrics, and logs to an OTLP collector when
|
|
8
|
+
Agent SDK sends traces, metrics, and logs to an OTLP collector when you
|
|
9
|
+
set the `OTEL_*` variables. Record your own with `@opentelemetry/api`.
|
|
4
10
|
|
|
5
11
|
```bash
|
|
6
12
|
export OTEL_EXPORTER_OTLP_ENDPOINT=https://otel.example.com
|
|
@@ -9,7 +15,14 @@ export OTEL_SERVICE_NAME=incident-agent
|
|
|
9
15
|
agent-sdk serve --dir . --dev
|
|
10
16
|
```
|
|
11
17
|
|
|
12
|
-
|
|
18
|
+
- The default protocol is `http/protobuf`. `http/json` also works, and
|
|
19
|
+
`grpc` logs a warning and falls back to `http/protobuf`.
|
|
20
|
+
- Metrics use delta temporality. Grafana Cloud and Prometheus reject
|
|
21
|
+
delta, so set `OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE=cumulative`
|
|
22
|
+
when you export to either one.
|
|
23
|
+
- If you don't set an endpoint, Agent SDK doesn't export anything.
|
|
24
|
+
- You can create a meter, tracer, or logger at the top of
|
|
25
|
+
`bot/agent.ts`, and it will use Agent SDK's providers.
|
|
13
26
|
|
|
14
27
|
## Variables
|
|
15
28
|
|
|
@@ -46,9 +59,9 @@ export default defineAgent({
|
|
|
46
59
|
});
|
|
47
60
|
```
|
|
48
61
|
|
|
49
|
-
`
|
|
62
|
+
`service.name` is fixed by the first export, so redeploy to change it.
|
|
50
63
|
|
|
51
|
-
##
|
|
64
|
+
## Record and tag
|
|
52
65
|
|
|
53
66
|
```ts
|
|
54
67
|
import { metrics, trace } from "@opentelemetry/api";
|
|
@@ -62,9 +75,13 @@ const logger = logs.getLogger("incident-agent");
|
|
|
62
75
|
lookups.add(1, { "cursor.conversation.id": currentConversationId() });
|
|
63
76
|
```
|
|
64
77
|
|
|
65
|
-
|
|
78
|
+
Spans started during a turn get `cursor.conversation.id`, and a metric
|
|
79
|
+
gets it only when you set it.
|
|
66
80
|
|
|
67
|
-
|
|
81
|
+
To tag a whole turn, call `ctx.telemetry` from a tool. Spans in the
|
|
82
|
+
turn get the trace keys, Agent SDK's log records get the log keys, and
|
|
83
|
+
`cursor.token.usage` gets the metric keys. Outside a tool, use
|
|
84
|
+
`telemetry` from `@grok/agent-sdk/telemetry`.
|
|
68
85
|
|
|
69
86
|
```ts
|
|
70
87
|
async execute({ key }, ctx) {
|
|
@@ -75,37 +92,30 @@ async execute({ key }, ctx) {
|
|
|
75
92
|
}
|
|
76
93
|
```
|
|
77
94
|
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
```ts
|
|
81
|
-
import { telemetry } from "@grok/agent-sdk/telemetry";
|
|
82
|
-
|
|
83
|
-
telemetry.setTraceAttributes({ "work.item": ticket });
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
The global methods read the active context. Outside a turn they do nothing. Tags stay in this process. They are not written on the `baggage` header.
|
|
95
|
+
Grafana renames a `.` in a metric key to `_`.
|
|
87
96
|
|
|
88
97
|
```promql
|
|
89
98
|
sum by (work_item) (cursor_token_usage_total)
|
|
90
99
|
```
|
|
91
100
|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
`ctx.host.otel` is deprecated, still runs this release, and logs one warning per process. `setAttributes` writes one map onto spans and token usage, and the calls above replace it.
|
|
97
|
-
|
|
98
|
-
Trace and log keys are accepted as written. A log record keeps a key Agent SDK already set. `setMetricAttributes` rejects `cursor.token.type`, `agent_sdk.channel`, `cursor.tool.name`, `cursor.tool.kind`, `cursor.tool.status`, `agent_sdk.turn_status`, `agent_sdk.subagent_name`, `agent_sdk.sdk_agent_id`, and `agent_sdk.sdk_agent_url`. The call throws and leaves the runtime value in place.
|
|
99
|
-
|
|
100
|
-
Prompt text and tool payloads stay off log records unless `OTEL_LOGS_EXPORTER=otlp` and `OTEL_LOG_USER_PROMPTS` or `OTEL_LOG_TOOL_CONTENT` is set.
|
|
101
|
+
- Each distinct metric value is a new series, so never use a per-turn
|
|
102
|
+
ID, a secret, an email, or a raw user ID.
|
|
103
|
+
- A session holds up to 32 keys of each kind, with keys up to 128
|
|
104
|
+
characters and values up to 256.
|
|
101
105
|
|
|
102
106
|
## Limits
|
|
103
107
|
|
|
104
|
-
|
|
108
|
+
- Agent SDK doesn't support custom span processors, samplers, views,
|
|
109
|
+
your own OpenTelemetry SDK, or library auto-instrumentation. It reads
|
|
110
|
+
`OTEL_TRACES_SAMPLER` and `OTEL_METRIC_EXPORT_INTERVAL` once at
|
|
111
|
+
startup, so restart the process after you change either one.
|
|
112
|
+
- Import Agent SDK before any other OpenTelemetry setup. Otherwise the
|
|
113
|
+
turn's tags may not reach your spans.
|
|
105
114
|
|
|
106
115
|
## Migrating from serve({ otel })
|
|
107
116
|
|
|
108
|
-
`serve({ otel })
|
|
117
|
+
Delete `serve({ otel })`, `bot/otel.ts`, `bot/instrumentation.ts`, and
|
|
118
|
+
any `defineOtel` call. Set these variables instead.
|
|
109
119
|
|
|
110
120
|
| Old option | Set this instead |
|
|
111
121
|
| --- | --- |
|
|
@@ -129,7 +139,7 @@ Custom span processors, samplers, views, your own SDK, library auto-instrumentat
|
|
|
129
139
|
| `logs.toolContent` | `OTEL_LOGS_EXPORTER=otlp` and `OTEL_LOG_TOOL_CONTENT=1` |
|
|
130
140
|
| `otel: false` | No endpoint, or `OTEL_SDK_DISABLED=true` |
|
|
131
141
|
|
|
132
|
-
|
|
142
|
+
Set the hosted values after deploy:
|
|
133
143
|
|
|
134
144
|
```bash
|
|
135
145
|
agent-sdk secret set my-agent OTEL_SERVICE_NAME OTEL_EXPORTER_OTLP_ENDPOINT OTEL_EXPORTER_OTLP_HEADERS
|