@grok/agent-sdk 0.2.29 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/channels/slack/cli-project.js +1 -1
- package/dist/docs/404.html +2 -2
- package/dist/docs/assets/{app.DMrZKFjI.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.DQvuw1KA.js → VPLocalSearchBox.DsnRlUT5.js} +1 -1
- package/dist/docs/assets/chunks/{arc.ahOG-Qza.js → arc.DH8GOhiv.js} +1 -1
- package/dist/docs/assets/chunks/{architectureDiagram-Q4EWVU46.BcgfYNO_.js → architectureDiagram-Q4EWVU46.9m9ObyuE.js} +1 -1
- package/dist/docs/assets/chunks/{baseUniq.DeIYZrWh.js → baseUniq.BXHpx1lE.js} +1 -1
- package/dist/docs/assets/chunks/{blockDiagram-DXYQGD6D.HjJ2goMX.js → blockDiagram-DXYQGD6D.xY3EX59q.js} +1 -1
- package/dist/docs/assets/chunks/{c4Diagram-AHTNJAMY.C1QTb9GM.js → c4Diagram-AHTNJAMY.DnqgMVgc.js} +1 -1
- package/dist/docs/assets/chunks/channel.Cctv0f7X.js +1 -0
- package/dist/docs/assets/chunks/{chunk-4BX2VUAB.UuZiDiVp.js → chunk-4BX2VUAB.BjFxK2A3.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-4TB4RGXK.5A3YmkhI.js → chunk-4TB4RGXK.BujS_Spt.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-55IACEB6.B4uf1yYV.js → chunk-55IACEB6.YbTjhdaM.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-EDXVE4YY.CoXBce8t.js → chunk-EDXVE4YY.DnQ8t4GC.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-FMBD7UC4.DnC5NO4e.js → chunk-FMBD7UC4.B67AwAmj.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-OYMX7WX6.CzfHCeIi.js → chunk-OYMX7WX6.DrZIAFOm.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-QZHKN3VN.C6tcwkVd.js → chunk-QZHKN3VN.BLmmydkn.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-YZCP3GAM._oboyZ1A.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.BfPVKeId.js → cose-bilkent-S5V4N54A.DMQuNhM5.js} +1 -1
- package/dist/docs/assets/chunks/{dagre-KV5264BT.CLMLc0lD.js → dagre-KV5264BT.CZoGVuUf.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-5BDNPKRD.C7OF7UfH.js → diagram-5BDNPKRD.CLt9uOyL.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-G4DWMVQ6.Dpao0Bl1.js → diagram-G4DWMVQ6.DpczEm1G.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-MMDJMWI5.DLnM9eLp.js → diagram-MMDJMWI5.D4r13DvJ.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-TYMM5635.BcpVgA_M.js → diagram-TYMM5635.CYU9eGFu.js} +1 -1
- package/dist/docs/assets/chunks/{erDiagram-SMLLAGMA.CsL5JuCV.js → erDiagram-SMLLAGMA.QA9naWEw.js} +1 -1
- package/dist/docs/assets/chunks/{flowDiagram-DWJPFMVM.MFihq9AF.js → flowDiagram-DWJPFMVM.BbNoVZYd.js} +1 -1
- package/dist/docs/assets/chunks/{ganttDiagram-T4ZO3ILL.CJeLodyG.js → ganttDiagram-T4ZO3ILL.IHjDoG7r.js} +1 -1
- package/dist/docs/assets/chunks/{gitGraphDiagram-UUTBAWPF.1HhlE45Z.js → gitGraphDiagram-UUTBAWPF.B21VMdf5.js} +1 -1
- package/dist/docs/assets/chunks/{graph.BS02KkWA.js → graph.DgJ4L-8V.js} +1 -1
- package/dist/docs/assets/chunks/{infoDiagram-42DDH7IO.fp5gvytQ.js → infoDiagram-42DDH7IO.CQjrcthc.js} +1 -1
- package/dist/docs/assets/chunks/{ishikawaDiagram-UXIWVN3A.C6Wk1V4I.js → ishikawaDiagram-UXIWVN3A.D4tPGtVo.js} +1 -1
- package/dist/docs/assets/chunks/{journeyDiagram-VCZTEJTY.qJt4uJ_H.js → journeyDiagram-VCZTEJTY.BD3WaNbQ.js} +1 -1
- package/dist/docs/assets/chunks/{kanban-definition-6JOO6SKY.z2tG9kly.js → kanban-definition-6JOO6SKY.Ca0o4Tqz.js} +1 -1
- package/dist/docs/assets/chunks/{layout.BPCkdejr.js → layout.DXXqX4MQ.js} +1 -1
- package/dist/docs/assets/chunks/{linear.CL3TC3u7.js → linear.5c61gNw4.js} +1 -1
- package/dist/docs/assets/chunks/{min.SPrSp704.js → min.B1-NAjHX.js} +1 -1
- package/dist/docs/assets/chunks/{mindmap-definition-QFDTVHPH.DgrQRFZW.js → mindmap-definition-QFDTVHPH.BELznv3-.js} +1 -1
- package/dist/docs/assets/chunks/{pieDiagram-DEJITSTG.Ba7yxiW2.js → pieDiagram-DEJITSTG.qPzO1mq5.js} +1 -1
- package/dist/docs/assets/chunks/{quadrantDiagram-34T5L4WZ.Bvskad4p.js → quadrantDiagram-34T5L4WZ.CxIvzbjX.js} +1 -1
- package/dist/docs/assets/chunks/{requirementDiagram-MS252O5E.Ce70ugV9.js → requirementDiagram-MS252O5E.CqA0iJx8.js} +1 -1
- package/dist/docs/assets/chunks/{sankeyDiagram-XADWPNL6.BJ5OEULO.js → sankeyDiagram-XADWPNL6.XRTutBnb.js} +1 -1
- package/dist/docs/assets/chunks/{sequenceDiagram-FGHM5R23.C8a1hDs6.js → sequenceDiagram-FGHM5R23.E--7bRLQ.js} +1 -1
- package/dist/docs/assets/chunks/{stateDiagram-FHFEXIEX.D2D8A5CK.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.DRciHmS1.js → theme.DMj_7q3B.js} +2 -2
- package/dist/docs/assets/chunks/{timeline-definition-GMOUNBTQ.C4ePrY8-.js → timeline-definition-GMOUNBTQ.C7LgNVAL.js} +1 -1
- package/dist/docs/assets/chunks/{vennDiagram-DHZGUBPP.Dzso6dEA.js → vennDiagram-DHZGUBPP.HUwoZcy_.js} +1 -1
- package/dist/docs/assets/chunks/{wardley-RL74JXVD.djgXR0ar.js → wardley-RL74JXVD.BxFEFYZS.js} +1 -1
- package/dist/docs/assets/chunks/{wardleyDiagram-NUSXRM2D.Bf2ICxjh.js → wardleyDiagram-NUSXRM2D.B2pSo5rB.js} +1 -1
- package/dist/docs/assets/chunks/{xychartDiagram-5P7HB3ND.DEH4BcVJ.js → xychartDiagram-5P7HB3ND.NQhMiOOL.js} +1 -1
- package/dist/docs/assets/deployment.md.BtqJrHhp.js +31 -0
- package/dist/docs/assets/{deployment.md.KW0Ni_rY.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.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.C-Sx_IPa.js} +3 -5
- package/dist/docs/assets/{guides_mcp-oauth.md.DrGY92u4.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.BwXHURvY.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.CAruw_rp.lean.js → index.md.DRfaoRCZ.lean.js} +1 -1
- 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.C0Tp_Fk9.js +27 -0
- package/dist/docs/assets/{reference_agent-config.md.Ck29qYNj.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.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.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.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 +5 -155
- package/dist/docs/deployment.html +54 -54
- package/dist/docs/deployment.md +83 -262
- 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 +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 +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 +55 -61
- package/dist/docs/index.md +49 -83
- package/dist/docs/llms-full.txt +2262 -5721
- 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 +43 -56
- package/dist/docs/reference/agent-config.md +91 -174
- 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 +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/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/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/init-project.d.ts.map +1 -1
- package/dist/internal/init-project.js +7 -5
- package/dist/internal/reminder-runner.js +1 -1
- package/dist/internal/session-engine.js +1 -1
- 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 +4 -17
- package/dist/types.d.ts.map +1 -1
- package/docs/README.md +49 -83
- package/docs/building-with-agents.md +11 -104
- package/docs/changelog.md +6 -156
- package/docs/deployment.md +83 -262
- package/docs/evals.md +34 -130
- 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 +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 +91 -174
- 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 +2 -2
- package/skills/deploy/SKILL.md +1 -1
- package/skills/migrate-v2/SKILL.md +0 -1
- 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/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/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/webhooks.md
CHANGED
|
@@ -6,19 +6,18 @@ description: "Receive provider events, keep one conversation per domain object,
|
|
|
6
6
|
# Webhook agents
|
|
7
7
|
|
|
8
8
|
A custom channel turns an event from another system into an agent
|
|
9
|
-
conversation
|
|
10
|
-
Use one when the built-in [HTTP API](../reference/http-api.md)
|
|
9
|
+
conversation and sends the result back to the system that started it.
|
|
10
|
+
Use one when the built-in [HTTP API](../reference/http-api.md) doesn't
|
|
11
11
|
match the provider's payload, conversation key, or reply path.
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
A file at `bot/channels/<id>.ts` mounts its routes under
|
|
14
14
|
`/<slug>/v1/channels/<id>`.
|
|
15
15
|
|
|
16
16
|
## Receive a webhook and send the answer back
|
|
17
17
|
|
|
18
|
-
When a ticket system sends a new message, this
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
comment on the ticket.
|
|
18
|
+
When a ticket system sends a new message, this route starts a turn and
|
|
19
|
+
answers right away. The agent keeps working after the HTTP request ends,
|
|
20
|
+
and its answer appears as a comment on the ticket.
|
|
22
21
|
|
|
23
22
|
```ts
|
|
24
23
|
// bot/channels/tickets.ts
|
|
@@ -61,22 +60,20 @@ export default defineChannel<TicketState>({
|
|
|
61
60
|
});
|
|
62
61
|
```
|
|
63
62
|
|
|
64
|
-
`postTicketComment`
|
|
65
|
-
|
|
66
|
-
|
|
63
|
+
`postTicketComment` wraps the ticket provider's SDK. The write lives in
|
|
64
|
+
the event handler, so the webhook request doesn't stay open while the
|
|
65
|
+
model works.
|
|
67
66
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
failures, back through the provider's API. See
|
|
67
|
+
On Cursor hosting, the caller always gets an empty `202` response, and
|
|
68
|
+
the platform ignores whatever your handler returns. Send results and
|
|
69
|
+
failures back through the provider's API instead. See
|
|
72
70
|
[Route responses](../reference/channels.md#route-responses).
|
|
73
71
|
|
|
74
72
|
## Keep one conversation per ticket
|
|
75
73
|
|
|
76
|
-
Without a conversation key, every delivery creates a new session.
|
|
77
|
-
the ticket ID as the `continuationToken
|
|
78
|
-
|
|
79
|
-
starts its own.
|
|
74
|
+
Without a conversation key, every delivery creates a new session. Pass
|
|
75
|
+
the ticket ID as the `continuationToken`, so every message on one
|
|
76
|
+
ticket resumes the same conversation.
|
|
80
77
|
|
|
81
78
|
```ts
|
|
82
79
|
waitUntil(
|
|
@@ -88,17 +85,13 @@ waitUntil(
|
|
|
88
85
|
);
|
|
89
86
|
```
|
|
90
87
|
|
|
91
|
-
The channel owns this key. Callers only need to send the domain ID they
|
|
92
|
-
already know.
|
|
93
|
-
|
|
94
88
|
## Keep one hosted session per thread
|
|
95
89
|
|
|
96
|
-
On Cursor
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
`
|
|
100
|
-
|
|
101
|
-
go to one session, and their turns run in the order the requests arrive.
|
|
90
|
+
On Cursor hosting, each request to a custom route starts a new session,
|
|
91
|
+
even when the handler passes the same `continuationToken`. To join
|
|
92
|
+
requests, the sender or a small relay in front of the deployment adds
|
|
93
|
+
the same `X-BDK-Session-Key` value to each one, and those requests run
|
|
94
|
+
in one session in arrival order.
|
|
102
95
|
|
|
103
96
|
```bash
|
|
104
97
|
curl -X POST "$AGENT_ALIAS_URL/v1/channels/tickets/ticket" \
|
|
@@ -108,44 +101,16 @@ curl -X POST "$AGENT_ALIAS_URL/v1/channels/tickets/ticket" \
|
|
|
108
101
|
-d '{"ticketId":"ENG-142","message":"CSV export returns 500"}'
|
|
109
102
|
```
|
|
110
103
|
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
The header has these rules:
|
|
116
|
-
|
|
117
|
-
- The route must admit the sender with the alias token or
|
|
118
|
-
`sharedSecretAuth()`. If the route admits the sender with
|
|
119
|
-
`hmacSignatureAuth()` or `publicEndpoint()`, hosting answers `400`. An
|
|
120
|
-
HMAC signature covers the body and not the header, so a copy of one
|
|
121
|
-
signed request could be sent again under a different key.
|
|
122
|
-
- The value must be 1 to 256 printable ASCII characters, with no space
|
|
123
|
-
and no comma. Hosting answers `400` for any other value, and no turn
|
|
124
|
-
starts.
|
|
125
|
-
- A key belongs to one channel on one deployment. The same value on a
|
|
126
|
-
different channel or deployment starts a different session.
|
|
127
|
-
- Only `defineChannel` routes read the header. Prebuilt channels, such
|
|
128
|
-
as `githubChannel()`, keep their own conversation keys.
|
|
129
|
-
- The handler still receives the header in `request.headers`.
|
|
130
|
-
- Hosting stores the value with the request. Do not put secrets or
|
|
131
|
-
personal data in it.
|
|
132
|
-
- Local `agent-sdk serve` ignores the header. Keep the `continuationToken` in
|
|
133
|
-
the handler, so local runs join requests the same way.
|
|
134
|
-
|
|
135
|
-
Two limits apply:
|
|
136
|
-
|
|
137
|
-
- Hosting does not deduplicate requests. If the sender retries a
|
|
138
|
-
request, the session runs a second turn.
|
|
139
|
-
- A [reminder](../reference/schedules.md#reminders) that a keyed
|
|
140
|
-
session sets fires in that session, but it can run at the same time
|
|
141
|
-
as a turn from a request.
|
|
104
|
+
Hosting stores the value with the request, so don't put secrets or
|
|
105
|
+
personal data in it.
|
|
106
|
+
[Hosted session keys](../reference/channels.md#hosted-session-keys)
|
|
107
|
+
lists the auth, format, and retry rules.
|
|
142
108
|
|
|
143
109
|
## Prepare evidence before the turn
|
|
144
110
|
|
|
145
|
-
Webhook payloads often
|
|
146
|
-
handler fetches the full ticket
|
|
147
|
-
|
|
148
|
-
instead of spending the turn looking for context.
|
|
111
|
+
Webhook payloads often carry little more than an object ID. This
|
|
112
|
+
handler fetches the full ticket with a server tool and writes it to
|
|
113
|
+
`ticket.json`, so the model starts from a fixed snapshot.
|
|
149
114
|
|
|
150
115
|
```ts
|
|
151
116
|
handler: async (_request, { callTool, send, waitUntil, body }) => {
|
|
@@ -173,74 +138,38 @@ handler: async (_request, { callTool, send, waitUntil, body }) => {
|
|
|
173
138
|
},
|
|
174
139
|
```
|
|
175
140
|
|
|
176
|
-
The
|
|
177
|
-
the answer
|
|
178
|
-
reports that on the ticket instead.
|
|
179
|
-
|
|
180
|
-
## Routes receive, events deliver
|
|
181
|
-
|
|
182
|
-
Routes own inbound HTTP. A route validates the request, decides whether
|
|
183
|
-
to start or resume a turn, and acknowledges the caller with `202`. The
|
|
184
|
-
channel's
|
|
185
|
-
`events` handlers receive session events later, which is where you
|
|
186
|
-
deliver the model's answer or report a failure to the originating
|
|
187
|
-
system.
|
|
141
|
+
The `message.completed` handler from the first example still delivers
|
|
142
|
+
the answer.
|
|
188
143
|
|
|
189
144
|
## Validate payloads with Zod
|
|
190
145
|
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
narrow it.
|
|
196
|
-
|
|
197
|
-
The route description and schema also appear in `GET /v1/info`. The
|
|
198
|
-
playground uses them to add a **Try** action and a matching slash
|
|
199
|
-
command, so you can exercise the same handler without building a
|
|
200
|
-
separate test UI.
|
|
146
|
+
The route validates the request and passes the handler a typed `body`
|
|
147
|
+
or `query`. `POST`, `PUT`, and `PATCH` routes need a Zod `bodySchema`,
|
|
148
|
+
and `GET` routes need a `querySchema`. Use `z.unknown()` for a variable
|
|
149
|
+
payload that your own parser narrows.
|
|
201
150
|
|
|
202
151
|
## Use handler context
|
|
203
152
|
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
-
|
|
208
|
-
|
|
209
|
-
- `callTool` runs an authored server tool without starting a model
|
|
210
|
-
turn.
|
|
211
|
-
|
|
212
|
-
- `waitUntil` keeps background work alive after the handler returns.
|
|
213
|
-
Await `send` when later handler code needs the session handle, such
|
|
214
|
-
as calling `session.waitForCompletion()` before reporting the turn
|
|
215
|
-
outcome to the provider.
|
|
216
|
-
|
|
217
|
-
- `host` provides authenticated services for API calls made by channel
|
|
218
|
-
code.
|
|
219
|
-
|
|
220
|
-
The full handler API lives in the
|
|
221
|
-
[Channels reference](../reference/channels.md#handler-arguments).
|
|
153
|
+
Await `send` instead of passing it to `waitUntil` when later handler
|
|
154
|
+
code needs the session, for example to call
|
|
155
|
+
`session.waitForCompletion()`.
|
|
156
|
+
[Handler arguments](../reference/channels.md#handler-arguments) lists
|
|
157
|
+
every helper.
|
|
222
158
|
|
|
223
159
|
## Protect public webhooks
|
|
224
160
|
|
|
225
|
-
Custom routes accept direct loopback requests by default
|
|
226
|
-
forwarded
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
start
|
|
237
|
-
|
|
238
|
-
Before accepting remote traffic, choose an explicit boundary.
|
|
239
|
-
`bearerAuth()` works when the sender can attach an authorization header.
|
|
240
|
-
On managed hosting, webhook providers often cannot attach the agent
|
|
241
|
-
alias token, so `publicEndpoint()` lets that custom channel bypass it.
|
|
242
|
-
That opens the route to every caller; verify the provider signature
|
|
243
|
-
before starting a turn or calling a tool.
|
|
161
|
+
Custom routes accept direct loopback requests by default and reject
|
|
162
|
+
forwarded ones, so a tunnel or reverse proxy can't quietly make a local
|
|
163
|
+
endpoint public. Under `--dev`, a provider channel with no webhook
|
|
164
|
+
secret (GitHub, GitLab, Bitbucket, or PagerDuty) accepts only local
|
|
165
|
+
requests, so set that secret in the provider and in your shell before
|
|
166
|
+
you test through a tunnel.
|
|
167
|
+
|
|
168
|
+
Use `bearerAuth()` when the sender can attach an authorization header.
|
|
169
|
+
Webhook providers often can't attach the agent alias token, so
|
|
170
|
+
`publicEndpoint()` lets a custom channel skip it on Cursor hosting.
|
|
171
|
+
That opens the route to every caller, so verify the provider's
|
|
172
|
+
signature before you start a turn or call a tool.
|
|
244
173
|
|
|
245
174
|
```ts
|
|
246
175
|
import { defineChannel, POST, publicEndpoint } from "@grok/agent-sdk/channels";
|
|
@@ -268,24 +197,20 @@ export default defineChannel({
|
|
|
268
197
|
});
|
|
269
198
|
```
|
|
270
199
|
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
delivery with `401`.
|
|
200
|
+
With `publicEndpoint()`, the handler drops a badly signed delivery
|
|
201
|
+
silently. If the provider sends a shared secret header or signs the raw
|
|
202
|
+
body with HMAC-SHA256, use `sharedSecretAuth()` or
|
|
203
|
+
`hmacSignatureAuth()` instead. Hosting checks those policies before the
|
|
204
|
+
handler runs and answers a bad delivery with `401`.
|
|
277
205
|
|
|
278
|
-
`publicEndpoint()` only
|
|
206
|
+
`publicEndpoint()` opens only this channel's routes, and the built-in
|
|
279
207
|
session and tool APIs stay private. See
|
|
280
|
-
[Auth policies](../reference/channels.md#auth-policies)
|
|
281
|
-
tokens and the complete policy reference.
|
|
208
|
+
[Auth policies](../reference/channels.md#auth-policies).
|
|
282
209
|
|
|
283
210
|
## Test locally
|
|
284
211
|
|
|
285
|
-
Run the agent
|
|
286
|
-
|
|
287
|
-
right away, and the resulting session should appear in the playground
|
|
288
|
-
while the reply is delivered.
|
|
212
|
+
Run the agent with `--dev` and post the payload the provider will send.
|
|
213
|
+
The session appears in the playground while the reply goes out.
|
|
289
214
|
|
|
290
215
|
```text
|
|
291
216
|
agent-sdk serve --dir . --dev
|
|
@@ -296,18 +221,11 @@ curl -sS -X POST \
|
|
|
296
221
|
-d '{"ticketId":"ENG-142","message":"CSV export returns 500"}'
|
|
297
222
|
```
|
|
298
223
|
|
|
299
|
-
Keep
|
|
300
|
-
`--data-binary @fixtures/<event>.json`.
|
|
301
|
-
**Try** action in the playground for manual probes.
|
|
224
|
+
Keep sample payloads under `fixtures/` and pass them with
|
|
225
|
+
`--data-binary @fixtures/<event>.json`.
|
|
302
226
|
|
|
303
227
|
## Related
|
|
304
228
|
|
|
305
|
-
- [Channels reference](../reference/channels.md)
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
signed tracker webhook with reply delivery
|
|
309
|
-
- [HTTP API](../reference/http-api.md): built-in session, follow-up,
|
|
310
|
-
stream, and tool routes
|
|
311
|
-
- [Deployment](../deployment.md#use-the-hosted-agent): stable hosted
|
|
312
|
-
URLs and alias-token behavior
|
|
313
|
-
- [Evals](../evals.md): turn saved payloads into regression fixtures
|
|
229
|
+
- [Channels reference](../reference/channels.md)
|
|
230
|
+
- [Review and triage templates](../templates/reviews.md), including a
|
|
231
|
+
signed tracker webhook
|
package/docs/hillclimbing.md
CHANGED
|
@@ -1,63 +1,62 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Hillclimbing"
|
|
3
|
-
description: "
|
|
3
|
+
description: "Iteratively improve agent behavior with evals"
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Hillclimbing
|
|
7
7
|
|
|
8
|
-
Hillclimbing improves an agent
|
|
9
|
-
|
|
10
|
-
and retain the change only when the same run gets better without
|
|
11
|
-
crossing the freeze line.
|
|
8
|
+
Hillclimbing improves an agent one measured change at a time. Hold the inputs fixed, change one
|
|
9
|
+
thing, and keep it only when the same run gets better without moving the behavior you froze.
|
|
12
10
|
|
|
13
|
-
|
|
14
|
-
this loop with you.
|
|
11
|
+
A coding agent in your checkout can run this loop by following the `bdk-hillclimb` skill.
|
|
15
12
|
|
|
16
|
-
##
|
|
13
|
+
## Run one measured round
|
|
17
14
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
that owns the decision. The improved run should inspect first and leave
|
|
21
|
-
approval untouched.
|
|
15
|
+
First agree on the agent, one to three fixed inputs, the metric to improve, and the behavior that
|
|
16
|
+
must not change, such as the output shape, side effects, and existing evals.
|
|
22
17
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
18
|
+
Then run one round:
|
|
19
|
+
|
|
20
|
+
1. Run the agent the way a user would, on saved or local inputs, without deploying or posting live.
|
|
21
|
+
2. Read the trajectory and name the main failure in one sentence.
|
|
22
|
+
3. Change one lever.
|
|
23
|
+
4. Rerun the same fixtures.
|
|
24
|
+
5. Compare correctness, efficiency, and contract fit.
|
|
25
|
+
6. Keep, revert, or narrow the change.
|
|
26
|
+
|
|
27
|
+
Don't swap a fixture mid-round, or the comparison means nothing.
|
|
28
|
+
|
|
29
|
+
## Choose the smallest lever
|
|
27
30
|
|
|
28
|
-
|
|
31
|
+
Start with the earliest place that can remove the failure. Prepare evidence on the host before the
|
|
32
|
+
turn, then change the shape of that evidence, then the instructions or skills, then remove or gate
|
|
33
|
+
tools that invite wandering, and change the framework only when the agent can't express the fix.
|
|
34
|
+
|
|
35
|
+
Fixing the host or evidence often improves quality and latency together, because the model searches
|
|
36
|
+
less for ground truth.
|
|
37
|
+
|
|
38
|
+
## Match the fix to the failure
|
|
39
|
+
|
|
40
|
+
When the agent picks the wrong tool, such as a PR reviewer that calls `approve_pr` before
|
|
41
|
+
`inspect_pr`, pin one PR and tighten only the instruction that owns that decision, so you know which
|
|
42
|
+
edit fixed it.
|
|
29
43
|
|
|
30
44
|
```ts
|
|
31
|
-
t.succeeded();
|
|
32
45
|
t.calledTool("inspect_pr");
|
|
33
46
|
t.notCalledTool("approve_pr");
|
|
34
47
|
```
|
|
35
48
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
## Reduce wandering or latency
|
|
40
|
-
|
|
41
|
-
A slow run often repeats reads, searches broad directories, or asks the
|
|
42
|
-
model to discover evidence the host already has. Compare the trajectory
|
|
43
|
-
by tool name and wall time, then move deterministic preparation ahead
|
|
44
|
-
of the turn or trim the evidence shape.
|
|
49
|
+
When a run wanders or runs long, it often repeats reads or makes the model find evidence the host
|
|
50
|
+
already has. Move that preparation ahead of the turn, and keep the change only if the answer still
|
|
51
|
+
finds the same issue.
|
|
45
52
|
|
|
46
53
|
```text
|
|
47
54
|
before: 14 tool calls, 92 seconds, 6 repeated reads
|
|
48
55
|
after: 5 tool calls, 31 seconds, 0 repeated reads
|
|
49
56
|
```
|
|
50
57
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
incomplete.
|
|
54
|
-
|
|
55
|
-
## Improve quality without changing the contract
|
|
56
|
-
|
|
57
|
-
For answer quality, freeze the public shape before editing: required
|
|
58
|
-
sections, API fields, side effects, and existing evals. Compare both
|
|
59
|
-
runs against a known-good answer or a small set of gold findings, then
|
|
60
|
-
change the instructions or skill that owns the missing judgment.
|
|
58
|
+
When the answer is weak, freeze the public shape, compare both runs against known-good findings, and
|
|
59
|
+
edit the instruction or skill that owns the missing judgment.
|
|
61
60
|
|
|
62
61
|
```text
|
|
63
62
|
fixture: saved checkout PR diff
|
|
@@ -65,75 +64,14 @@ success: report both gold findings with file paths
|
|
|
65
64
|
freeze: findings JSON shape; no review post; existing smoke evals
|
|
66
65
|
```
|
|
67
66
|
|
|
68
|
-
A wording change is not a win by itself. Keep it when correctness rises
|
|
69
|
-
and every frozen behavior remains intact.
|
|
70
|
-
|
|
71
|
-
## Run one measured round
|
|
72
|
-
|
|
73
|
-
Agree on four inputs before editing:
|
|
74
|
-
|
|
75
|
-
1. **Target:** the agent path or slug.
|
|
76
|
-
2. **Fixtures:** one to three prompts, saved payloads, or pinned PRs.
|
|
77
|
-
3. **Success:** the metric or decision that should improve.
|
|
78
|
-
4. **Freeze line:** behavior that must not move.
|
|
79
|
-
|
|
80
|
-
Then run one loop:
|
|
81
|
-
|
|
82
|
-
1. Exercise the agent through the same surface a user would.
|
|
83
|
-
2. Read the trajectory and name the dominant failure in one sentence.
|
|
84
|
-
3. Change one lever.
|
|
85
|
-
4. Rerun the same fixtures.
|
|
86
|
-
5. Compare correctness, efficiency, and contract fit.
|
|
87
|
-
6. Keep, revert, or narrow the change.
|
|
88
|
-
|
|
89
|
-
Do not replace a fixture mid-round. A moving input makes the comparison
|
|
90
|
-
meaningless.
|
|
91
|
-
|
|
92
|
-
## Choose the smallest lever
|
|
93
|
-
|
|
94
|
-
Start with the earliest place that can remove the failure:
|
|
95
|
-
|
|
96
|
-
1. **Host preparation:** fetch deterministic evidence before the turn.
|
|
97
|
-
2. **Evidence shape:** trim, order, or label what the model receives.
|
|
98
|
-
3. **Instructions or skills:** clarify the decision procedure.
|
|
99
|
-
4. **Tool surface:** remove or gate tools that invite wandering.
|
|
100
|
-
5. **Framework:** change it only when the agent cannot express the fix.
|
|
101
|
-
|
|
102
|
-
Changing the host or evidence often improves both quality and latency
|
|
103
|
-
because the model spends less time searching for ground truth.
|
|
104
|
-
|
|
105
67
|
## Lock every kept win
|
|
106
68
|
|
|
107
|
-
Each
|
|
108
|
-
|
|
109
|
-
quality score that captures the measured improvement.
|
|
69
|
+
Each kept change needs an eval that would have failed before it, such as a tool-choice assertion, a
|
|
70
|
+
`maxToolCalls` bound, an output-shape check, or a quality score.
|
|
110
71
|
|
|
111
|
-
```
|
|
72
|
+
```bash
|
|
112
73
|
agent-sdk eval --dir . --tag smoke
|
|
113
74
|
```
|
|
114
75
|
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
change leave your working memory.
|
|
118
|
-
|
|
119
|
-
## Run the loop with a coding agent
|
|
120
|
-
|
|
121
|
-
Ask the coding agent to read
|
|
122
|
-
[`skills/hillclimb/SKILL.md`](../skills/hillclimb/SKILL.md), then give
|
|
123
|
-
it the target, fixtures, success criterion, and freeze line. It will
|
|
124
|
-
measure the current run, propose one change, remeasure, and ask before
|
|
125
|
-
starting another round.
|
|
126
|
-
|
|
127
|
-
Use saved or local surfaces during a climb. Do not deploy or post to a
|
|
128
|
-
real external channel unless that side effect is part of an explicitly
|
|
129
|
-
approved fixture.
|
|
130
|
-
|
|
131
|
-
## Related
|
|
132
|
-
|
|
133
|
-
- [Evals](./evals.md): author the regression check for a kept win
|
|
134
|
-
- [Evals reference](./reference/evals.md): trajectory assertions and
|
|
135
|
-
scores
|
|
136
|
-
- [Building agents with agents](./building-with-agents.md): delegate
|
|
137
|
-
creation and verification to a coding agent
|
|
138
|
-
- [Fix common agent problems](./troubleshooting.md): diagnose a run
|
|
139
|
-
that is broken instead of underperforming
|
|
76
|
+
Don't loosen an existing eval so that a new change passes. If an older eval starts failing, the
|
|
77
|
+
change broke something that used to work, and you should fix the change instead.
|