@grok/agent-sdk 0.2.28 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +29 -29
- package/dist/bin/agent-serve.d.ts +2 -2
- package/dist/bin/agent-serve.js +3 -3
- package/dist/channels/pagerduty/api.js +1 -1
- package/dist/channels/pagerduty/pagerduty-channel.d.ts +1 -1
- package/dist/channels/pagerduty/pagerduty-channel.d.ts.map +1 -1
- package/dist/channels/pagerduty/pagerduty-channel.js +1 -1
- package/dist/channels/pagerduty/replay.d.ts +1 -1
- package/dist/channels/pagerduty/replay.js +4 -4
- package/dist/channels/slack/cli-project.js +1 -1
- package/dist/docs/404.html +2 -2
- package/dist/docs/assets/{app.DF9vlcdn.js → app.BzTUBOAD.js} +4 -4
- package/dist/docs/assets/building-with-agents.md.BqJ7AAjG.js +6 -0
- package/dist/docs/assets/{building-with-agents.md.Bf1yH2tG.lean.js → building-with-agents.md.BqJ7AAjG.lean.js} +1 -1
- package/dist/docs/assets/changelog.md.BWhC6DET.js +1 -0
- package/dist/docs/assets/changelog.md.BWhC6DET.lean.js +1 -0
- package/dist/docs/assets/chunks/@localSearchIndexroot.CWxwVoCG.js +1 -0
- package/dist/docs/assets/chunks/{VPLocalSearchBox.D8OuwKO0.js → VPLocalSearchBox.DsnRlUT5.js} +1 -1
- package/dist/docs/assets/chunks/{arc.DCq_TCYV.js → arc.DH8GOhiv.js} +1 -1
- package/dist/docs/assets/chunks/{architectureDiagram-Q4EWVU46.PWRNTPbk.js → architectureDiagram-Q4EWVU46.9m9ObyuE.js} +1 -1
- package/dist/docs/assets/chunks/{baseUniq.BeRPvRUL.js → baseUniq.BXHpx1lE.js} +1 -1
- package/dist/docs/assets/chunks/{blockDiagram-DXYQGD6D.BuRmZVSo.js → blockDiagram-DXYQGD6D.xY3EX59q.js} +1 -1
- package/dist/docs/assets/chunks/{c4Diagram-AHTNJAMY.7DKSMwuv.js → c4Diagram-AHTNJAMY.DnqgMVgc.js} +1 -1
- package/dist/docs/assets/chunks/channel.Cctv0f7X.js +1 -0
- package/dist/docs/assets/chunks/{chunk-4BX2VUAB.7VrO9-9i.js → chunk-4BX2VUAB.BjFxK2A3.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-4TB4RGXK.CHystNE2.js → chunk-4TB4RGXK.BujS_Spt.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-55IACEB6.Nuh9TbTq.js → chunk-55IACEB6.YbTjhdaM.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-EDXVE4YY.CA0EKugm.js → chunk-EDXVE4YY.DnQ8t4GC.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-FMBD7UC4.F9_mp7U8.js → chunk-FMBD7UC4.B67AwAmj.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-OYMX7WX6.CEU4QfE1.js → chunk-OYMX7WX6.DrZIAFOm.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-QZHKN3VN.B8h_x9_i.js → chunk-QZHKN3VN.BLmmydkn.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-YZCP3GAM.Btfb-rKg.js → chunk-YZCP3GAM.DaoOfw0O.js} +1 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.DU5sqchW.js +1 -0
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.DU5sqchW.js +1 -0
- package/dist/docs/assets/chunks/clone.B9rdNt6j.js +1 -0
- package/dist/docs/assets/chunks/{cose-bilkent-S5V4N54A.DKvc96Wa.js → cose-bilkent-S5V4N54A.DMQuNhM5.js} +1 -1
- package/dist/docs/assets/chunks/{dagre-KV5264BT.CMo0cy1b.js → dagre-KV5264BT.CZoGVuUf.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-5BDNPKRD.DDgMOQhB.js → diagram-5BDNPKRD.CLt9uOyL.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-G4DWMVQ6.BdJnoIsU.js → diagram-G4DWMVQ6.DpczEm1G.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-MMDJMWI5.oSvhAZaL.js → diagram-MMDJMWI5.D4r13DvJ.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-TYMM5635.C9zZLIE-.js → diagram-TYMM5635.CYU9eGFu.js} +1 -1
- package/dist/docs/assets/chunks/{erDiagram-SMLLAGMA.BNhVyccy.js → erDiagram-SMLLAGMA.QA9naWEw.js} +1 -1
- package/dist/docs/assets/chunks/{flowDiagram-DWJPFMVM.BEFLLBiU.js → flowDiagram-DWJPFMVM.BbNoVZYd.js} +1 -1
- package/dist/docs/assets/chunks/{ganttDiagram-T4ZO3ILL.BdUzXBgY.js → ganttDiagram-T4ZO3ILL.IHjDoG7r.js} +1 -1
- package/dist/docs/assets/chunks/{gitGraphDiagram-UUTBAWPF.Rd3LlOIJ.js → gitGraphDiagram-UUTBAWPF.B21VMdf5.js} +1 -1
- package/dist/docs/assets/chunks/{graph.DnJC1GpG.js → graph.DgJ4L-8V.js} +1 -1
- package/dist/docs/assets/chunks/{infoDiagram-42DDH7IO.xv0xntDJ.js → infoDiagram-42DDH7IO.CQjrcthc.js} +1 -1
- package/dist/docs/assets/chunks/{ishikawaDiagram-UXIWVN3A.BaGIlviU.js → ishikawaDiagram-UXIWVN3A.D4tPGtVo.js} +1 -1
- package/dist/docs/assets/chunks/{journeyDiagram-VCZTEJTY.Cof_h0fp.js → journeyDiagram-VCZTEJTY.BD3WaNbQ.js} +1 -1
- package/dist/docs/assets/chunks/{kanban-definition-6JOO6SKY.C5GozFuU.js → kanban-definition-6JOO6SKY.Ca0o4Tqz.js} +1 -1
- package/dist/docs/assets/chunks/{layout.zc9UShLc.js → layout.DXXqX4MQ.js} +1 -1
- package/dist/docs/assets/chunks/{linear.BoqrFVcJ.js → linear.5c61gNw4.js} +1 -1
- package/dist/docs/assets/chunks/{min.DwIfr8hG.js → min.B1-NAjHX.js} +1 -1
- package/dist/docs/assets/chunks/{mindmap-definition-QFDTVHPH.Dkq2yTtp.js → mindmap-definition-QFDTVHPH.BELznv3-.js} +1 -1
- package/dist/docs/assets/chunks/{pieDiagram-DEJITSTG.B4CpTmHK.js → pieDiagram-DEJITSTG.qPzO1mq5.js} +1 -1
- package/dist/docs/assets/chunks/{quadrantDiagram-34T5L4WZ.BqXnFC9C.js → quadrantDiagram-34T5L4WZ.CxIvzbjX.js} +1 -1
- package/dist/docs/assets/chunks/{requirementDiagram-MS252O5E.DhIN2z-E.js → requirementDiagram-MS252O5E.CqA0iJx8.js} +1 -1
- package/dist/docs/assets/chunks/{sankeyDiagram-XADWPNL6.BhxUAmg2.js → sankeyDiagram-XADWPNL6.XRTutBnb.js} +1 -1
- package/dist/docs/assets/chunks/{sequenceDiagram-FGHM5R23.BqgU7HU-.js → sequenceDiagram-FGHM5R23.E--7bRLQ.js} +1 -1
- package/dist/docs/assets/chunks/{stateDiagram-FHFEXIEX.B1BCO18N.js → stateDiagram-FHFEXIEX.C4vGu8zq.js} +1 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.ECMu2BdJ.js +1 -0
- package/dist/docs/assets/chunks/{theme.oV7rddEz.js → theme.DMj_7q3B.js} +2 -2
- package/dist/docs/assets/chunks/{timeline-definition-GMOUNBTQ.oRI8UwMC.js → timeline-definition-GMOUNBTQ.C7LgNVAL.js} +1 -1
- package/dist/docs/assets/chunks/{vennDiagram-DHZGUBPP.DmuWrIxN.js → vennDiagram-DHZGUBPP.HUwoZcy_.js} +1 -1
- package/dist/docs/assets/chunks/{wardley-RL74JXVD.CEBjM5ov.js → wardley-RL74JXVD.BxFEFYZS.js} +1 -1
- package/dist/docs/assets/chunks/{wardleyDiagram-NUSXRM2D.m5zsCOF9.js → wardleyDiagram-NUSXRM2D.B2pSo5rB.js} +1 -1
- package/dist/docs/assets/chunks/{xychartDiagram-5P7HB3ND.cPN-587n.js → xychartDiagram-5P7HB3ND.NQhMiOOL.js} +1 -1
- package/dist/docs/assets/deployment.md.BtqJrHhp.js +31 -0
- package/dist/docs/assets/{deployment.md.DDmjAVbg.lean.js → deployment.md.BtqJrHhp.lean.js} +1 -1
- package/dist/docs/assets/evals.md.Dne6VRmZ.js +49 -0
- package/dist/docs/assets/evals.md.Dne6VRmZ.lean.js +1 -0
- package/dist/docs/assets/{guides_agent-to-agent.md.D1D5f6Jc.js → guides_agent-to-agent.md.BcmSqL2z.js} +8 -8
- package/dist/docs/assets/guides_agent-to-agent.md.BcmSqL2z.lean.js +1 -0
- package/dist/docs/assets/{guides_bitbucket.md.DkjkBRU8.js → guides_bitbucket.md.BiA6ZMFW.js} +27 -27
- package/dist/docs/assets/{guides_bitbucket.md.DkjkBRU8.lean.js → guides_bitbucket.md.BiA6ZMFW.lean.js} +1 -1
- package/dist/docs/assets/guides_cloud-agents.md.CiXAW6on.js +9 -0
- package/dist/docs/assets/{guides_cloud-agents.md.Ceyjv0ul.lean.js → guides_cloud-agents.md.CiXAW6on.lean.js} +1 -1
- package/dist/docs/assets/guides_convert-automation.md.BvTxsJ8J.js +26 -0
- package/dist/docs/assets/{guides_convert-automation.md.BjraCvok.lean.js → guides_convert-automation.md.BvTxsJ8J.lean.js} +1 -1
- package/dist/docs/assets/{guides_github.md.CgN5sNbW.js → guides_github.md.6jiEH7dg.js} +11 -19
- package/dist/docs/assets/{guides_github.md.CgN5sNbW.lean.js → guides_github.md.6jiEH7dg.lean.js} +1 -1
- package/dist/docs/assets/{guides_gitlab.md.DCE0p7_w.js → guides_gitlab.md.DcKusOcU.js} +63 -73
- package/dist/docs/assets/{guides_gitlab.md.DCE0p7_w.lean.js → guides_gitlab.md.DcKusOcU.lean.js} +1 -1
- package/dist/docs/assets/guides_improve.md.o3WOGR7n.js +16 -0
- package/dist/docs/assets/{guides_improve.md.BFYtrtLE.lean.js → guides_improve.md.o3WOGR7n.lean.js} +1 -1
- package/dist/docs/assets/{guides_jev.md.Ccw4pedT.js → guides_jev.md.DGCzkMUN.js} +20 -60
- package/dist/docs/assets/{guides_jev.md.Ccw4pedT.lean.js → guides_jev.md.DGCzkMUN.lean.js} +1 -1
- package/dist/docs/assets/{guides_mcp-oauth.md.ekpWOZCC.js → guides_mcp-oauth.md.C-Sx_IPa.js} +3 -5
- package/dist/docs/assets/{guides_mcp-oauth.md.ekpWOZCC.lean.js → guides_mcp-oauth.md.C-Sx_IPa.lean.js} +1 -1
- package/dist/docs/assets/guides_migrate.md.BbhHYeCr.js +3 -0
- package/dist/docs/assets/{guides_migrate.md.RS9Eu-Xh.lean.js → guides_migrate.md.BbhHYeCr.lean.js} +1 -1
- package/dist/docs/assets/guides_opentelemetry.md.BRSktBHt.js +26 -0
- package/dist/docs/assets/guides_opentelemetry.md.BRSktBHt.lean.js +1 -0
- package/dist/docs/assets/guides_pagerduty.md.pMXUkZZc.js +61 -0
- package/dist/docs/assets/guides_pagerduty.md.pMXUkZZc.lean.js +1 -0
- package/dist/docs/assets/guides_slack.md.BgIGG9ur.js +82 -0
- package/dist/docs/assets/{guides_slack.md.BqiGSYGX.lean.js → guides_slack.md.BgIGG9ur.lean.js} +1 -1
- package/dist/docs/assets/{guides_webhooks.md.BJk63ZTs.js → guides_webhooks.md.B5DXt2v1.js} +7 -7
- package/dist/docs/assets/{guides_webhooks.md.BJk63ZTs.lean.js → guides_webhooks.md.B5DXt2v1.lean.js} +1 -1
- package/dist/docs/assets/hillclimbing.md.3TkdF79A.js +5 -0
- package/dist/docs/assets/hillclimbing.md.3TkdF79A.lean.js +1 -0
- package/dist/docs/assets/index.md.DRfaoRCZ.js +20 -0
- package/dist/docs/assets/index.md.DRfaoRCZ.lean.js +1 -0
- package/dist/docs/assets/quickstart.md.r-oE8nkX.js +113 -0
- package/dist/docs/assets/{quickstart.md.DaLk4ZIF.lean.js → quickstart.md.r-oE8nkX.lean.js} +1 -1
- package/dist/docs/assets/reference_access.md.C5lblfUC.js +1 -0
- package/dist/docs/assets/{reference_access.md.CExlH_mR.lean.js → reference_access.md.C5lblfUC.lean.js} +1 -1
- package/dist/docs/assets/reference_agent-config.md.C0Tp_Fk9.js +27 -0
- package/dist/docs/assets/{reference_agent-config.md.11E_xe--.lean.js → reference_agent-config.md.C0Tp_Fk9.lean.js} +1 -1
- package/dist/docs/assets/reference_artifacts.md.BJpAI7h9.js +17 -0
- package/dist/docs/assets/{reference_artifacts.md.C-hKR2hp.lean.js → reference_artifacts.md.BJpAI7h9.lean.js} +1 -1
- package/dist/docs/assets/reference_channels.md.CPWOpdsC.js +21 -0
- package/dist/docs/assets/{reference_channels.md.DsJfGSBJ.lean.js → reference_channels.md.CPWOpdsC.lean.js} +1 -1
- package/dist/docs/assets/reference_cli.md.B8GdpaRj.js +83 -0
- package/dist/docs/assets/reference_cli.md.B8GdpaRj.lean.js +1 -0
- package/dist/docs/assets/reference_connections.md.DoY4vrDH.js +54 -0
- package/dist/docs/assets/{reference_connections.md.BoAotr7_.lean.js → reference_connections.md.DoY4vrDH.lean.js} +1 -1
- package/dist/docs/assets/reference_evals.md.DgfUtfIc.js +69 -0
- package/dist/docs/assets/{reference_evals.md.DYKjGFi-.lean.js → reference_evals.md.DgfUtfIc.lean.js} +1 -1
- package/dist/docs/assets/{reference_extensions.md.pEVj72Xo.js → reference_extensions.md.DHbW6eOf.js} +6 -8
- package/dist/docs/assets/{reference_extensions.md.pEVj72Xo.lean.js → reference_extensions.md.DHbW6eOf.lean.js} +1 -1
- package/dist/docs/assets/reference_hooks.md.CSWmOwMM.js +39 -0
- package/dist/docs/assets/reference_hooks.md.CSWmOwMM.lean.js +1 -0
- package/dist/docs/assets/reference_http-api.md.C7Cb0r2J.js +7 -0
- package/dist/docs/assets/{reference_http-api.md._RWELr3d.lean.js → reference_http-api.md.C7Cb0r2J.lean.js} +1 -1
- package/dist/docs/assets/reference_instructions.md.CV6Qq0UX.js +14 -0
- package/dist/docs/assets/reference_instructions.md.CV6Qq0UX.lean.js +1 -0
- package/dist/docs/assets/reference_limits.md.CbdtFr4T.js +8 -0
- package/dist/docs/assets/reference_limits.md.CbdtFr4T.lean.js +1 -0
- package/dist/docs/assets/reference_memory.md.CdoJISM-.js +3 -0
- package/dist/docs/assets/{reference_memory.md.Dd7cyV9V.lean.js → reference_memory.md.CdoJISM-.lean.js} +1 -1
- package/dist/docs/assets/reference_playground.md.DIUsRAcy.js +1 -0
- package/dist/docs/assets/{reference_playground.md.CQiJk9CM.lean.js → reference_playground.md.DIUsRAcy.lean.js} +1 -1
- package/dist/docs/assets/reference_project-layout.md.9DiKoE16.js +26 -0
- package/dist/docs/assets/reference_project-layout.md.9DiKoE16.lean.js +1 -0
- package/dist/docs/assets/reference_schedules.md.RhQ9ZLo1.js +45 -0
- package/dist/docs/assets/{reference_schedules.md.RC47aFm4.lean.js → reference_schedules.md.RhQ9ZLo1.lean.js} +1 -1
- package/dist/docs/assets/reference_sessions.md.NXVQt9mP.js +22 -0
- package/dist/docs/assets/{reference_sessions.md.C7KFhWXV.lean.js → reference_sessions.md.NXVQt9mP.lean.js} +1 -1
- package/dist/docs/assets/{reference_skills.md.Dej2zQxi.js → reference_skills.md.DzCPNPkG.js} +4 -4
- package/dist/docs/assets/{reference_skills.md.Dej2zQxi.lean.js → reference_skills.md.DzCPNPkG.lean.js} +1 -1
- package/dist/docs/assets/reference_subagents.md.Dvpq2sUu.js +10 -0
- package/dist/docs/assets/{reference_subagents.md.CAhvW4yS.lean.js → reference_subagents.md.Dvpq2sUu.lean.js} +1 -1
- package/dist/docs/assets/reference_tools.md.B2OaR1Nb.js +62 -0
- package/dist/docs/assets/{reference_tools.md.DQr7Fnhu.lean.js → reference_tools.md.B2OaR1Nb.lean.js} +1 -1
- package/dist/docs/assets/templates_agentic-owners.md.B6ZmKAzT.js +13 -0
- package/dist/docs/assets/{templates_agentic-owners.md.Dh2nDSqg.lean.js → templates_agentic-owners.md.B6ZmKAzT.lean.js} +1 -1
- package/dist/docs/assets/templates_reviews.md.dr9Xv_KM.js +10 -0
- package/dist/docs/assets/templates_reviews.md.dr9Xv_KM.lean.js +1 -0
- package/dist/docs/assets/troubleshooting.md.DfKKvW1R.js +3 -0
- package/dist/docs/assets/{troubleshooting.md.AGJ3jDzj.lean.js → troubleshooting.md.DfKKvW1R.lean.js} +1 -1
- package/dist/docs/building-with-agents.html +41 -44
- package/dist/docs/building-with-agents.md +11 -104
- package/dist/docs/changelog.html +37 -37
- package/dist/docs/changelog.md +5 -145
- package/dist/docs/deployment.html +54 -54
- package/dist/docs/deployment.md +86 -265
- package/dist/docs/evals.html +52 -71
- package/dist/docs/evals.md +33 -127
- package/dist/docs/guides/agent-to-agent.html +43 -43
- package/dist/docs/guides/agent-to-agent.md +27 -64
- package/dist/docs/guides/bitbucket.html +62 -62
- package/dist/docs/guides/bitbucket.md +73 -134
- package/dist/docs/guides/cloud-agents.html +37 -37
- package/dist/docs/guides/cloud-agents.md +23 -53
- package/dist/docs/guides/convert-automation.html +39 -56
- package/dist/docs/guides/convert-automation.md +31 -115
- package/dist/docs/guides/github.html +46 -54
- package/dist/docs/guides/github.md +49 -131
- package/dist/docs/guides/gitlab.html +98 -108
- package/dist/docs/guides/gitlab.md +104 -184
- package/dist/docs/guides/improve.html +38 -43
- package/dist/docs/guides/improve.md +24 -90
- package/dist/docs/guides/jev.html +55 -95
- package/dist/docs/guides/jev.md +57 -159
- package/dist/docs/guides/mcp-oauth.html +38 -40
- package/dist/docs/guides/mcp-oauth.md +34 -69
- package/dist/docs/guides/migrate.html +38 -43
- package/dist/docs/guides/migrate.md +56 -130
- package/dist/docs/guides/opentelemetry.html +41 -43
- package/dist/docs/guides/opentelemetry.md +32 -27
- package/dist/docs/guides/pagerduty.html +50 -49
- package/dist/docs/guides/pagerduty.md +65 -199
- package/dist/docs/guides/slack.html +51 -57
- package/dist/docs/guides/slack.md +76 -205
- package/dist/docs/guides/webhooks.html +42 -42
- package/dist/docs/guides/webhooks.md +64 -146
- package/dist/docs/hashmap.json +1 -1
- package/dist/docs/hillclimbing.html +40 -42
- package/dist/docs/hillclimbing.md +40 -102
- package/dist/docs/index.html +55 -62
- package/dist/docs/index.md +49 -82
- package/dist/docs/llms-full.txt +2292 -5830
- package/dist/docs/llms.txt +9 -15
- package/dist/docs/quickstart.html +96 -153
- package/dist/docs/quickstart.md +93 -178
- package/dist/docs/reference/access.html +36 -36
- package/dist/docs/reference/access.md +7 -12
- package/dist/docs/reference/agent-config.html +43 -56
- package/dist/docs/reference/agent-config.md +93 -176
- package/dist/docs/reference/artifacts.html +38 -39
- package/dist/docs/reference/artifacts.md +38 -62
- package/dist/docs/reference/channels.html +38 -39
- package/dist/docs/reference/channels.md +102 -151
- package/dist/docs/reference/cli.html +68 -84
- package/dist/docs/reference/cli.md +233 -698
- package/dist/docs/reference/connections.html +45 -57
- package/dist/docs/reference/connections.md +83 -164
- package/dist/docs/reference/evals.html +66 -53
- package/dist/docs/reference/evals.md +97 -128
- package/dist/docs/reference/extensions.html +41 -43
- package/dist/docs/reference/extensions.md +37 -70
- package/dist/docs/reference/hooks.html +40 -52
- package/dist/docs/reference/hooks.md +62 -133
- package/dist/docs/reference/http-api.html +38 -42
- package/dist/docs/reference/http-api.md +66 -118
- package/dist/docs/reference/instructions.html +39 -39
- package/dist/docs/reference/instructions.md +19 -29
- package/dist/docs/reference/limits.html +38 -38
- package/dist/docs/reference/limits.md +9 -21
- package/dist/docs/reference/memory.html +37 -38
- package/dist/docs/reference/memory.md +38 -75
- package/dist/docs/reference/playground.html +36 -36
- package/dist/docs/reference/playground.md +14 -22
- package/dist/docs/reference/project-layout.html +49 -48
- package/dist/docs/reference/project-layout.md +38 -84
- package/dist/docs/reference/schedules.html +46 -48
- package/dist/docs/reference/schedules.md +59 -90
- package/dist/docs/reference/sessions.html +37 -37
- package/dist/docs/reference/sessions.md +66 -113
- package/dist/docs/reference/skills.html +39 -39
- package/dist/docs/reference/skills.md +11 -31
- package/dist/docs/reference/subagents.html +37 -37
- package/dist/docs/reference/subagents.md +17 -31
- package/dist/docs/reference/tools.html +47 -64
- package/dist/docs/reference/tools.md +48 -130
- package/dist/docs/templates/agentic-owners.html +38 -38
- package/dist/docs/templates/agentic-owners.md +50 -74
- package/dist/docs/templates/reviews.html +69 -0
- package/dist/docs/templates/reviews.md +71 -0
- package/dist/docs/troubleshooting.html +38 -36
- package/dist/docs/troubleshooting.md +48 -101
- package/dist/evals.d.ts +2 -2
- package/dist/extensions/jev/extension.d.ts +12 -2
- package/dist/extensions/jev/extension.d.ts.map +1 -1
- package/dist/extensions/jev/extension.js +4 -0
- package/dist/extensions/jev/lib/evaluate.d.ts +31 -4
- package/dist/extensions/jev/lib/evaluate.d.ts.map +1 -1
- package/dist/extensions/jev/lib/evaluate.js +18 -4
- package/dist/internal/cli/command.d.ts +1 -1
- package/dist/internal/cli/command.js +1 -1
- package/dist/internal/cli/commands/channels.js +6 -6
- package/dist/internal/cli/commands/develop.d.ts.map +1 -1
- package/dist/internal/cli/commands/develop.js +23 -14
- package/dist/internal/cli/commands/hosted.js +4 -4
- package/dist/internal/cli/commands/index.d.ts +1 -1
- package/dist/internal/cli/commands/index.d.ts.map +1 -1
- package/dist/internal/cli/commands/index.js +1 -1
- package/dist/internal/cli/commands/mcp.js +1 -1
- package/dist/internal/cli/commands/project.js +4 -4
- package/dist/internal/cli/commands/scaffold.d.ts.map +1 -1
- package/dist/internal/cli/commands/scaffold.js +9 -6
- package/dist/internal/cli/commands/serve.d.ts +1 -1
- package/dist/internal/cli/commands/serve.js +5 -5
- package/dist/internal/cli/commands/session.d.ts.map +1 -1
- package/dist/internal/cli/commands/session.js +12 -7
- package/dist/internal/cli/dispatch.d.ts +3 -3
- package/dist/internal/cli/dispatch.js +3 -3
- package/dist/internal/cli/errors.d.ts +1 -1
- package/dist/internal/cli/errors.d.ts.map +1 -1
- package/dist/internal/cli/errors.js +1 -1
- package/dist/internal/cli/flags.d.ts +2 -2
- package/dist/internal/cli/flags.d.ts.map +1 -1
- package/dist/internal/cli/flags.js +2 -2
- package/dist/internal/cli/help-command.d.ts +1 -1
- package/dist/internal/cli/help-command.js +2 -2
- package/dist/internal/cli/help.d.ts +7 -7
- package/dist/internal/cli/help.d.ts.map +1 -1
- package/dist/internal/cli/help.js +8 -8
- package/dist/internal/cli-ax.d.ts.map +1 -1
- package/dist/internal/cli-ax.js +3 -0
- package/dist/internal/cli-convert-automation.d.ts +1 -1
- package/dist/internal/cli-convert-automation.js +1 -1
- package/dist/internal/cli-deploy.js +1 -1
- package/dist/internal/cli-docs.js +1 -1
- package/dist/internal/cli-images.js +1 -1
- package/dist/internal/cli-migrate.d.ts +1 -1
- package/dist/internal/cli-migrate.js +1 -1
- package/dist/internal/cli-pagerduty.d.ts +1 -1
- package/dist/internal/cli-pagerduty.js +1 -1
- package/dist/internal/cli-skills.js +1 -1
- package/dist/internal/convert-automation/types.d.ts +1 -1
- package/dist/internal/convert-automation/types.js +1 -1
- package/dist/internal/cursor/credentials.js +1 -1
- package/dist/internal/deploy-client.d.ts +2 -2
- package/dist/internal/deploy-client.d.ts.map +1 -1
- package/dist/internal/deploy-manifest.d.ts +1 -0
- package/dist/internal/deploy-manifest.d.ts.map +1 -1
- package/dist/internal/deploy-manifest.js +0 -1
- package/dist/internal/discovery/agent-config.d.ts +2 -6
- package/dist/internal/discovery/agent-config.d.ts.map +1 -1
- package/dist/internal/discovery/agent-config.js +8 -25
- package/dist/internal/discovery/agent.d.ts.map +1 -1
- package/dist/internal/discovery/agent.js +2 -3
- package/dist/internal/discovery/project.d.ts.map +1 -1
- package/dist/internal/discovery/project.js +15 -0
- package/dist/internal/init-project.d.ts +7 -3
- package/dist/internal/init-project.d.ts.map +1 -1
- package/dist/internal/init-project.js +60 -12
- package/dist/internal/init-scaffold.d.ts +2 -1
- package/dist/internal/init-scaffold.d.ts.map +1 -1
- package/dist/internal/init-scaffold.js +20 -7
- package/dist/internal/peer-connections.js +1 -1
- package/dist/internal/reminder-runner.js +1 -1
- package/dist/internal/server.d.ts +1 -1
- package/dist/internal/session-cost.d.ts +4 -4
- package/dist/internal/session-cost.d.ts.map +1 -1
- package/dist/internal/session-cost.js +4 -4
- package/dist/internal/session-engine.d.ts +1 -1
- package/dist/internal/session-engine.js +2 -2
- package/dist/internal/shallow-clone.js +1 -1
- package/dist/playground/assets/index-D6mVn9og.js +62 -0
- package/dist/playground/assets/index-DlALM6gr.css +1 -0
- package/dist/playground/index.html +2 -2
- package/dist/types.d.ts +9 -22
- package/dist/types.d.ts.map +1 -1
- package/docs/README.md +49 -82
- package/docs/building-with-agents.md +11 -104
- package/docs/changelog.md +6 -146
- package/docs/deployment.md +86 -265
- package/docs/evals.md +34 -128
- package/docs/guides/agent-to-agent.md +27 -64
- package/docs/guides/bitbucket.md +73 -134
- package/docs/guides/cloud-agents.md +23 -53
- package/docs/guides/convert-automation.md +31 -115
- package/docs/guides/github.md +49 -131
- package/docs/guides/gitlab.md +104 -184
- package/docs/guides/improve.md +24 -90
- package/docs/guides/jev.md +57 -159
- package/docs/guides/mcp-oauth.md +34 -69
- package/docs/guides/migrate.md +56 -130
- package/docs/guides/opentelemetry.md +37 -27
- package/docs/guides/pagerduty.md +68 -200
- package/docs/guides/slack.md +76 -205
- package/docs/guides/webhooks.md +64 -146
- package/docs/hillclimbing.md +41 -103
- package/docs/quickstart.md +93 -178
- package/docs/reference/access.md +7 -12
- package/docs/reference/agent-config.md +93 -176
- package/docs/reference/artifacts.md +38 -62
- package/docs/reference/channels.md +102 -151
- package/docs/reference/cli.md +233 -698
- package/docs/reference/connections.md +83 -164
- package/docs/reference/evals.md +97 -128
- package/docs/reference/extensions.md +37 -70
- package/docs/reference/hooks.md +61 -132
- package/docs/reference/http-api.md +66 -118
- package/docs/reference/instructions.md +20 -30
- package/docs/reference/limits.md +10 -22
- package/docs/reference/memory.md +38 -75
- package/docs/reference/playground.md +14 -22
- package/docs/reference/project-layout.md +38 -84
- package/docs/reference/schedules.md +59 -90
- package/docs/reference/sessions.md +66 -113
- package/docs/reference/skills.md +12 -32
- package/docs/reference/subagents.md +17 -31
- package/docs/reference/tools.md +48 -130
- package/docs/templates/agentic-owners.md +50 -74
- package/docs/templates/reviews.md +76 -0
- package/docs/troubleshooting.md +48 -101
- package/package.json +3 -9
- package/skills/cli/SKILL.md +15 -15
- package/skills/create-agent/SKILL.md +20 -19
- package/skills/debug/SKILL.md +4 -4
- package/skills/deploy/SKILL.md +2 -2
- package/skills/evals/SKILL.md +8 -8
- package/skills/framework-map/SKILL.md +3 -3
- package/skills/github/SKILL.md +7 -7
- package/skills/hillclimb/SKILL.md +4 -4
- package/skills/mcp-auth/SKILL.md +3 -3
- package/skills/migrate-v2/SKILL.md +40 -41
- package/skills/otel/SKILL.md +2 -2
- package/skills/setup-slack/SKILL.md +8 -8
- package/templates/agentic-owners/README.md +5 -5
- package/templates/agentic-owners/bot/tools/record_review.ts +1 -1
- package/templates/agentic-owners/package.json +1 -1
- package/templates/agents-md/README.md +4 -4
- package/templates/agents-md/package.json +1 -1
- package/templates/code-wiki/README.md +3 -3
- package/templates/code-wiki/package.json +1 -1
- package/templates/demo/README.md +3 -3
- package/templates/demo/package.json +1 -1
- package/templates/pr-autofixer/package.json +1 -1
- package/templates/security-help/README.md +5 -5
- package/templates/security-help/package.json +1 -1
- package/templates/security-reviewer/README.md +3 -3
- package/templates/security-reviewer/package.json +1 -1
- package/templates/thermo-quality-review/README.md +4 -4
- package/templates/thermo-quality-review/package.json +1 -1
- package/templates/thermo-review/README.md +4 -4
- package/templates/thermo-review/package.json +1 -1
- package/templates/triage/README.md +3 -3
- package/templates/triage/overlays/jira/README.md +3 -3
- package/templates/triage/overlays/linear/README.md +3 -3
- package/templates/triage/package.json +1 -1
- package/dist/docs/assets/building-with-agents.md.Bf1yH2tG.js +0 -9
- package/dist/docs/assets/changelog.md.fZ-NNFeJ.js +0 -1
- package/dist/docs/assets/changelog.md.fZ-NNFeJ.lean.js +0 -1
- package/dist/docs/assets/chunks/@localSearchIndexroot.mfzjiOsL.js +0 -1
- package/dist/docs/assets/chunks/channel.goFR5lbe.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.B2yLtFja.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.B2yLtFja.js +0 -1
- package/dist/docs/assets/chunks/clone.CztV97Wu.js +0 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.CZlVHdDZ.js +0 -1
- package/dist/docs/assets/deployment.md.DDmjAVbg.js +0 -31
- package/dist/docs/assets/evals.md.OjKb7tNA.js +0 -68
- package/dist/docs/assets/evals.md.OjKb7tNA.lean.js +0 -1
- package/dist/docs/assets/guides_agent-to-agent.md.D1D5f6Jc.lean.js +0 -1
- package/dist/docs/assets/guides_cloud-agents.md.Ceyjv0ul.js +0 -9
- package/dist/docs/assets/guides_convert-automation.md.BjraCvok.js +0 -43
- package/dist/docs/assets/guides_grokbot-agents.md.D0PpM_Gf.js +0 -15
- package/dist/docs/assets/guides_grokbot-agents.md.D0PpM_Gf.lean.js +0 -1
- package/dist/docs/assets/guides_hooks.md.BjeEiM7s.js +0 -54
- package/dist/docs/assets/guides_hooks.md.BjeEiM7s.lean.js +0 -1
- package/dist/docs/assets/guides_improve.md.BFYtrtLE.js +0 -21
- package/dist/docs/assets/guides_migrate.md.RS9Eu-Xh.js +0 -8
- package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.js +0 -28
- package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.lean.js +0 -1
- package/dist/docs/assets/guides_pagerduty.md.mnKXe9U0.js +0 -60
- package/dist/docs/assets/guides_pagerduty.md.mnKXe9U0.lean.js +0 -1
- package/dist/docs/assets/guides_slack.md.BqiGSYGX.js +0 -88
- package/dist/docs/assets/hillclimbing.md.By61f3uq.js +0 -7
- package/dist/docs/assets/hillclimbing.md.By61f3uq.lean.js +0 -1
- package/dist/docs/assets/index.md.CVRjO09Y.js +0 -27
- package/dist/docs/assets/index.md.CVRjO09Y.lean.js +0 -1
- package/dist/docs/assets/quickstart.md.DaLk4ZIF.js +0 -170
- package/dist/docs/assets/reference_access.md.CExlH_mR.js +0 -1
- package/dist/docs/assets/reference_agent-config.md.11E_xe--.js +0 -40
- package/dist/docs/assets/reference_artifacts.md.C-hKR2hp.js +0 -18
- package/dist/docs/assets/reference_channels.md.DsJfGSBJ.js +0 -22
- package/dist/docs/assets/reference_cli.md.DQ3dCgmk.js +0 -99
- package/dist/docs/assets/reference_cli.md.DQ3dCgmk.lean.js +0 -1
- package/dist/docs/assets/reference_connections.md.BoAotr7_.js +0 -66
- package/dist/docs/assets/reference_evals.md.DYKjGFi-.js +0 -56
- package/dist/docs/assets/reference_hooks.md.B-bwJuiG.js +0 -51
- package/dist/docs/assets/reference_hooks.md.B-bwJuiG.lean.js +0 -1
- package/dist/docs/assets/reference_http-api.md._RWELr3d.js +0 -11
- package/dist/docs/assets/reference_instructions.md.yL2hXLnl.js +0 -14
- package/dist/docs/assets/reference_instructions.md.yL2hXLnl.lean.js +0 -1
- package/dist/docs/assets/reference_limits.md.Da1HegjB.js +0 -8
- package/dist/docs/assets/reference_limits.md.Da1HegjB.lean.js +0 -1
- package/dist/docs/assets/reference_memory.md.Dd7cyV9V.js +0 -4
- package/dist/docs/assets/reference_playground.md.CQiJk9CM.js +0 -1
- package/dist/docs/assets/reference_project-layout.md.BamcPDUn.js +0 -25
- package/dist/docs/assets/reference_project-layout.md.BamcPDUn.lean.js +0 -1
- package/dist/docs/assets/reference_prompt.md.BMjm1Jp3.js +0 -9
- package/dist/docs/assets/reference_prompt.md.BMjm1Jp3.lean.js +0 -1
- package/dist/docs/assets/reference_schedules.md.RC47aFm4.js +0 -47
- package/dist/docs/assets/reference_sessions.md.C7KFhWXV.js +0 -22
- package/dist/docs/assets/reference_subagents.md.CAhvW4yS.js +0 -10
- package/dist/docs/assets/reference_tools.md.DQr7Fnhu.js +0 -79
- package/dist/docs/assets/templates_agentic-owners.md.Dh2nDSqg.js +0 -13
- package/dist/docs/assets/templates_security-reviewer.md.DnwXdnB5.js +0 -3
- package/dist/docs/assets/templates_security-reviewer.md.DnwXdnB5.lean.js +0 -1
- package/dist/docs/assets/templates_thermo-quality-review.md.MJIdHkzE.js +0 -3
- package/dist/docs/assets/templates_thermo-quality-review.md.MJIdHkzE.lean.js +0 -1
- package/dist/docs/assets/templates_thermo-review.md.DfN1OFOl.js +0 -3
- package/dist/docs/assets/templates_thermo-review.md.DfN1OFOl.lean.js +0 -1
- package/dist/docs/assets/templates_triage.md.BYWMloV4.js +0 -9
- package/dist/docs/assets/templates_triage.md.BYWMloV4.lean.js +0 -1
- package/dist/docs/assets/troubleshooting.md.AGJ3jDzj.js +0 -1
- package/dist/docs/guides/grokbot-agents.html +0 -74
- package/dist/docs/guides/grokbot-agents.md +0 -129
- package/dist/docs/guides/hooks.html +0 -113
- package/dist/docs/guides/hooks.md +0 -116
- package/dist/docs/reference/prompt.html +0 -68
- package/dist/docs/reference/prompt.md +0 -47
- package/dist/docs/templates/security-reviewer.html +0 -62
- package/dist/docs/templates/security-reviewer.md +0 -81
- package/dist/docs/templates/thermo-quality-review.html +0 -62
- package/dist/docs/templates/thermo-quality-review.md +0 -75
- package/dist/docs/templates/thermo-review.html +0 -62
- package/dist/docs/templates/thermo-review.md +0 -75
- package/dist/docs/templates/triage.html +0 -68
- package/dist/docs/templates/triage.md +0 -101
- package/dist/extensions/cursor-grokbot-agents/extension.d.ts +0 -71
- package/dist/extensions/cursor-grokbot-agents/extension.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/extension.js +0 -64
- package/dist/extensions/cursor-grokbot-agents/lib/agents.d.ts +0 -11
- package/dist/extensions/cursor-grokbot-agents/lib/agents.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/agents.js +0 -31
- package/dist/extensions/cursor-grokbot-agents/lib/backend.d.ts +0 -56
- package/dist/extensions/cursor-grokbot-agents/lib/backend.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/backend.js +0 -139
- package/dist/extensions/cursor-grokbot-agents/lib/contacts.d.ts +0 -28
- package/dist/extensions/cursor-grokbot-agents/lib/contacts.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/contacts.js +0 -46
- package/dist/extensions/cursor-grokbot-agents/lib/conversation.d.ts +0 -53
- package/dist/extensions/cursor-grokbot-agents/lib/conversation.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/conversation.js +0 -186
- package/dist/extensions/cursor-grokbot-agents/lib/inputs.d.ts +0 -4
- package/dist/extensions/cursor-grokbot-agents/lib/inputs.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/inputs.js +0 -15
- package/dist/extensions/cursor-grokbot-agents/lib/lock.d.ts +0 -12
- package/dist/extensions/cursor-grokbot-agents/lib/lock.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/lock.js +0 -24
- package/dist/extensions/cursor-grokbot-agents/skills/consult.md +0 -40
- package/dist/extensions/cursor-grokbot-agents/tools/ask.d.ts +0 -4
- package/dist/extensions/cursor-grokbot-agents/tools/ask.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/tools/ask.js +0 -26
- package/dist/extensions/cursor-grokbot-agents/tools/check.d.ts +0 -4
- package/dist/extensions/cursor-grokbot-agents/tools/check.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/tools/check.js +0 -21
- package/dist/extensions/cursor-grokbot-agents/tools/interrupt.d.ts +0 -4
- package/dist/extensions/cursor-grokbot-agents/tools/interrupt.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/tools/interrupt.js +0 -13
- package/dist/extensions/cursor-grokbot-agents/tools/list.d.ts +0 -4
- package/dist/extensions/cursor-grokbot-agents/tools/list.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/tools/list.js +0 -22
- package/dist/playground/assets/index-BMpVzZzC.css +0 -1
- package/dist/playground/assets/index-_3zz3yh8.js +0 -62
- package/docs/guides/grokbot-agents.md +0 -134
- package/docs/guides/hooks.md +0 -121
- package/docs/reference/prompt.md +0 -52
- package/docs/templates/security-reviewer.md +0 -86
- package/docs/templates/thermo-quality-review.md +0 -80
- package/docs/templates/thermo-review.md +0 -80
- package/docs/templates/triage.md +0 -106
package/docs/reference/limits.md
CHANGED
|
@@ -1,23 +1,18 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Limits"
|
|
3
|
-
description: "
|
|
3
|
+
description: "How many deployments and deploys a team can have on Cursor-managed hosting, and the error a deploy returns at the cap."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Limits
|
|
7
7
|
|
|
8
|
-
Cursor
|
|
8
|
+
Cursor caps deployments for some teams. If your team has caps, these are the default values.
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
| Limit | Default | What counts |
|
|
11
|
+
| --- | --- | --- |
|
|
12
|
+
| `owner.deployments` | 20 | Each slug, running or stopped |
|
|
13
|
+
| `owner.deploysPerDay` | 100 per 24 hours | Each accepted deploy, including redeploys |
|
|
11
14
|
|
|
12
|
-
|
|
13
|
-
| --- | --- | --- | --- |
|
|
14
|
-
| Deployments | `owner.deployments` | 20 | Each deployment slug the team owns, running or stopped, and each new slug whose first build is still running or ready and not installed yet. A redeploy of an existing slug does not count. Installs of Cursor multi-tenant apps do not count. A ready build that has not been installed still holds its slot. |
|
|
15
|
-
| Deploys | `owner.deploysPerDay` | 100 in the last 24 hours | Each accepted deploy, including redeploys and deploys that are still building. Deleting a deployment does not give its deploys back. A deploy that fails before it is accepted does not count. |
|
|
16
|
-
| Persistent deployments | `owner.persistentSlots` | 1 | Deployments with `persistent: true`. |
|
|
17
|
-
|
|
18
|
-
## When a deploy reaches a limit
|
|
19
|
-
|
|
20
|
-
`agent-sdk deploy` and the dashboard show the `error` sentence. The HTTP API returns this body:
|
|
15
|
+
The error looks like this:
|
|
21
16
|
|
|
22
17
|
```json
|
|
23
18
|
{
|
|
@@ -30,13 +25,6 @@ When the switch is on, these are the default values. Cursor can set a different
|
|
|
30
25
|
}
|
|
31
26
|
```
|
|
32
27
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
-
|
|
36
|
-
- A deploy that waits on another deploy for the same team can answer `503` with `Retry-After: 2`. Retry that request.
|
|
37
|
-
|
|
38
|
-
The Deployed Agents dashboard shows `Deployments (N/max)` only when Cursor has turned the caps on for the team and the team has a deployment cap. Otherwise the heading is `Deployments`.
|
|
39
|
-
|
|
40
|
-
## Raise a limit
|
|
41
|
-
|
|
42
|
-
Contact Cursor support with your team and the limit you need.
|
|
28
|
+
To free a slot, run `agent-sdk deployment delete <slug>`, or wait until the
|
|
29
|
+
oldest counted deploy is 24 hours old. A deploy can also answer `503` with a
|
|
30
|
+
`Retry-After` header, and you can retry it after that many seconds.
|
package/docs/reference/memory.md
CHANGED
|
@@ -5,34 +5,29 @@ description: "Journal every turn so later sessions can read what earlier ones di
|
|
|
5
5
|
|
|
6
6
|
# Memory
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
that journal with its normal file tools when its instructions send it
|
|
11
|
-
there. Every session and every user of the agent shares one journal.
|
|
8
|
+
A memory hook appends one record per turn to a journal. The model reads
|
|
9
|
+
the journal with its file tools when its instructions send it there.
|
|
12
10
|
|
|
13
11
|
## Memory is on by default
|
|
14
12
|
|
|
15
13
|
`agent-sdk init` scaffolds `bot/hooks/memory.ts`:
|
|
16
14
|
|
|
17
15
|
```ts
|
|
18
|
-
// bot/hooks/memory.ts
|
|
19
16
|
import { memoryHook } from "@grok/agent-sdk/memory";
|
|
20
17
|
|
|
21
18
|
export default memoryHook();
|
|
22
19
|
```
|
|
23
20
|
|
|
24
21
|
It also adds a `## Memory` section to `bot/instructions.md`. The model
|
|
25
|
-
has no recall tool, so that section
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
project into your instructions. To turn memory off, delete the hook
|
|
30
|
-
file and the `## Memory` section.
|
|
22
|
+
has no recall tool, so that section tells it when to read `memory/` and
|
|
23
|
+
to treat records as untrusted history. To add memory to an existing
|
|
24
|
+
project, copy both from a new `agent-sdk init` project. To turn memory
|
|
25
|
+
off, delete both.
|
|
31
26
|
|
|
32
27
|
## Journal records
|
|
33
28
|
|
|
34
|
-
|
|
35
|
-
|
|
29
|
+
After each turn, the hook appends one JSON line to
|
|
30
|
+
`memory/journal.jsonl`:
|
|
36
31
|
|
|
37
32
|
```json
|
|
38
33
|
{"at":"2026-10-01T16:42:09.118Z","sessionId":"5f0c2a9e-7d1b-4c43-9a6e-2b8f1e0d7c35","channelId":"slack","status":"completed","title":"Checkout flaky test","userMessage":"Why does acme/checkout fail on main?","result":"The cart test races the price service mock...","usage":{"inputTokens":18234,"outputTokens":912,"cacheReadTokens":15002,"cacheWriteTokens":0}}
|
|
@@ -42,78 +37,46 @@ turn completes or fails:
|
|
|
42
37
|
| --- | --- |
|
|
43
38
|
| `at` | ISO-8601 time the turn finished |
|
|
44
39
|
| `sessionId` | Session that ran the turn |
|
|
45
|
-
| `channelId` | Channel that started the session
|
|
40
|
+
| `channelId` | Channel that started the session |
|
|
46
41
|
| `status` | `"completed"` or `"failed"` |
|
|
47
|
-
| `title` | Session title,
|
|
48
|
-
| `userMessage` | The message
|
|
49
|
-
| `result` | Final assistant text
|
|
50
|
-
| `usage` | Token usage for completed turns
|
|
42
|
+
| `title` | Session title, if set |
|
|
43
|
+
| `userMessage` | The turn's message, truncated |
|
|
44
|
+
| `result` | Final assistant text or failure message, truncated |
|
|
45
|
+
| `usage` | Token usage for completed turns |
|
|
51
46
|
|
|
52
47
|
As the journal grows, older records move to `journal-*.jsonl` files
|
|
53
|
-
beside it
|
|
54
|
-
needs history beyond the latest segment.
|
|
48
|
+
beside it, so point the model at the whole `memory/` directory.
|
|
55
49
|
|
|
56
50
|
## Read memory
|
|
57
51
|
|
|
58
52
|
Local turns find the journal at `memory/` in the session workspace. On
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
`memory` is a reserved workspace path. Agent SDK rejects per-send
|
|
64
|
-
`workspaceFiles` and `sandbox/workspace/` seed files under `memory/`,
|
|
65
|
-
so callers can't write records through the workspace.
|
|
66
|
-
|
|
67
|
-
Local servers keep the journal in the project state directory. `agent-sdk
|
|
68
|
-
run` and `agent-sdk eval` start an ephemeral server with a fresh state
|
|
69
|
-
directory unless you pass `--state-root`, so each run starts with
|
|
70
|
-
empty memory. Use `agent-sdk serve` or `agent-sdk dev`, or pass the same
|
|
71
|
-
`--state-root`, to keep memory across runs. Hosted deployments keep
|
|
72
|
-
the journal across redeploys.
|
|
73
|
-
|
|
74
|
-
## Who sees memory
|
|
75
|
-
|
|
76
|
-
Records from every session and every user land in the same journal, so
|
|
77
|
-
one person's messages and the agent's replies to them can surface in
|
|
78
|
-
another person's session. Turn memory off for an agent whose users
|
|
79
|
-
shouldn't see each other's requests. Turning it off stops new records,
|
|
80
|
-
but the journal keeps the records it already has. On a local server,
|
|
81
|
-
delete the `memory/` directory in the project state directory to clear
|
|
82
|
-
them. On Cursor-managed hosting, the journal is deployment data, so
|
|
83
|
-
[Privacy Mode](../deployment.md#privacy-mode) applies to it.
|
|
84
|
-
|
|
85
|
-
Anyone who can message the agent can put text in the journal. The
|
|
86
|
-
scaffolded instructions tell the model never to follow instructions
|
|
87
|
-
found inside records; keep that rule if you write your own section.
|
|
88
|
-
|
|
89
|
-
## Memory and host state
|
|
90
|
-
|
|
91
|
-
Memory is advisory. A record can be dropped, and records written by
|
|
92
|
-
concurrent sessions can show up only in a later session. Keep state
|
|
93
|
-
your code depends on, such as dedupe records and cursors, in
|
|
94
|
-
`ctx.host.kv` or `ctx.host.files`; see
|
|
95
|
-
[Handler context](./hooks.md#handler-context).
|
|
53
|
+
Cursor hosting, Agent SDK tells the model where the journal is at the
|
|
54
|
+
start of each session. A session on a server you run yourself can't
|
|
55
|
+
reach the journal. Agent SDK rejects `workspaceFiles` and
|
|
56
|
+
`sandbox/workspace/` seed files under the reserved `memory/` path.
|
|
96
57
|
|
|
97
|
-
|
|
58
|
+
Local servers keep the journal in the project state directory. `agent-sdk run` and `agent-sdk eval` start with empty memory unless you pass `--state-root`, and hosted deployments keep the journal across redeploys.
|
|
98
59
|
|
|
99
|
-
|
|
60
|
+
## Caveats
|
|
100
61
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
62
|
+
- All sessions and users share one journal, so one person's messages
|
|
63
|
+
can surface in another's session.
|
|
64
|
+
- Turning memory off keeps existing records. Locally, delete `memory/`
|
|
65
|
+
in the project state directory to clear them. On Cursor hosting,
|
|
66
|
+
[Privacy Mode](../deployment.md#privacy-mode) applies.
|
|
67
|
+
- Anyone who can message the agent writes to the journal, so keep the
|
|
68
|
+
scaffolded rule against following instructions found in records.
|
|
69
|
+
- Records can be dropped or arrive late. Keep state your code depends
|
|
70
|
+
on in `ctx.host.kv` or `ctx.host.files`.
|
|
105
71
|
|
|
106
|
-
|
|
107
|
-
which receives each record, and an optional
|
|
108
|
-
`prepareSession({ stateRoot, agentName })`, which runs when a session
|
|
109
|
-
starts. Records go only where `appendTurn` sends them, but the
|
|
110
|
-
`memory/` directory and the hosted first-prompt path still point at the
|
|
111
|
-
default journal. Give the model a tool or file to read your records,
|
|
112
|
-
and write instructions that send it there instead of `memory/`.
|
|
72
|
+
## Options
|
|
113
73
|
|
|
114
|
-
|
|
74
|
+
| `memoryHook` option | Contract |
|
|
75
|
+
| --- | --- |
|
|
76
|
+
| `maxTextLength` | Truncation cap for `userMessage` and `result`. Default `2000` characters |
|
|
77
|
+
| `backend` | A `MemoryBackend` that replaces the default journal |
|
|
115
78
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
79
|
+
A `MemoryBackend` has `appendTurn(record, { stateRoot, agentName })`
|
|
80
|
+
and an optional `prepareSession({ stateRoot, agentName })` that runs
|
|
81
|
+
when a session starts. The model still looks in `memory/`, so tell it
|
|
82
|
+
how to read your records.
|
|
@@ -5,37 +5,29 @@ description: "The built-in web UI: chat with streaming, Try buttons and slash co
|
|
|
5
5
|
|
|
6
6
|
# Playground
|
|
7
7
|
|
|
8
|
-
`agent-sdk serve`
|
|
9
|
-
`http://127.0.0.1:3000
|
|
10
|
-
|
|
11
|
-
lists them
|
|
8
|
+
`agent-sdk serve` hosts a web playground at
|
|
9
|
+
`http://127.0.0.1:3000/playground`. When one server hosts multiple
|
|
10
|
+
agents, each agent's playground is at `/<slug>/playground` and `/`
|
|
11
|
+
lists them.
|
|
12
12
|
|
|
13
13
|
## Playground surfaces
|
|
14
14
|
|
|
15
15
|
| Surface | What you can do |
|
|
16
16
|
| --- | --- |
|
|
17
|
-
| Chat |
|
|
18
|
-
| Slash commands |
|
|
19
|
-
| Try |
|
|
20
|
-
| Runs |
|
|
21
|
-
| Evals | List and run filesystem evals
|
|
22
|
-
| Agent | Inspect
|
|
17
|
+
| Chat | Text and reasoning stream live, and tool calls appear inline with arguments, output, and errors |
|
|
18
|
+
| Slash commands | Run a custom channel route without path parameters from the composer. A `drive` route becomes `/drive <pr-url>`. GitHub and Slack ingress routes are excluded |
|
|
19
|
+
| Try | Call a custom channel route from the Agent tab and copy the request as curl |
|
|
20
|
+
| Runs | Search the sessions you own and eval runs, then open them in Chat, Trace, Raw, or Evals |
|
|
21
|
+
| Evals | List and run filesystem evals |
|
|
22
|
+
| Agent | Inspect discovered tools, skills, subagents, MCP connections, channels, and hooks |
|
|
23
23
|
| Raw | Inspect the selected session's event stream |
|
|
24
|
-
| Logs | Recent server log lines
|
|
24
|
+
| Logs | Recent server log lines from `GET /v1/logs` |
|
|
25
25
|
|
|
26
26
|
In `--dev` on loopback, or with `--allow-anonymous`, the session list
|
|
27
27
|
includes every principal.
|
|
28
28
|
|
|
29
29
|
## Remote access
|
|
30
30
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
`serve(dir, { authToken })`). Open the playground on the remote device
|
|
35
|
-
and paste the token into the token field in the navbar.
|
|
36
|
-
`--allow-anonymous` is the demo-only alternative for trusted networks.
|
|
37
|
-
|
|
38
|
-
## Related
|
|
39
|
-
|
|
40
|
-
- [HTTP API](./http-api.md): the HTTP surface the playground uses
|
|
41
|
-
- [Sessions and streaming](./sessions.md): the streams it renders
|
|
31
|
+
To open the playground through a tunnel or LAN address, start the
|
|
32
|
+
server with `--bearer-token <secret>` and paste the token into the
|
|
33
|
+
navbar's token field. See [Auth policies](./channels.md#auth-policies).
|
|
@@ -5,118 +5,72 @@ description: "The canonical bot/ folder layout and its path-derived naming rules
|
|
|
5
5
|
|
|
6
6
|
# Project layout
|
|
7
7
|
|
|
8
|
-
An Agent SDK project keeps agent files under `bot
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
Existing projects rooted at `agent/` remain supported.
|
|
12
|
-
|
|
13
|
-
## Folder structure
|
|
14
|
-
|
|
15
|
-
For the capabilities below, identity comes from the path.
|
|
16
|
-
|
|
17
|
-
| Path under `bot/` | Resolves to |
|
|
18
|
-
| --- | --- |
|
|
19
|
-
| `tools/approve_pr.ts` | tool `approve_pr` |
|
|
20
|
-
| `mcp-connections/linear.ts` | MCP connection `linear` (model + host) |
|
|
21
|
-
| `host-connections/inventory.ts` | Host MCP connection `inventory` (host + `mcp oauth` only) |
|
|
22
|
-
| `skills/pr-review.md` | skill `pr-review` |
|
|
23
|
-
| `subagents/reviewer/` | subagent `reviewer` |
|
|
24
|
-
| `extensions/ci.ts` | extension mount `ci`; its contributions become `ci__<name>` |
|
|
25
|
-
| `extensions/notion.ts` | Cursor plugin mount `notion` (`cursorPlugin`); its skills, agents, and MCP servers become `notion__<name>` |
|
|
26
|
-
| `channels/drive.ts` | channel `drive`, routes under `/v1/channels/drive` |
|
|
27
|
-
|
|
28
|
-
The root agent takes its name from `package.json` `name`, falling back
|
|
29
|
-
to the directory name. When serving multiple agents, the slug is the
|
|
30
|
-
directory name and must match `[A-Za-z0-9][A-Za-z0-9_-]*` (and not the
|
|
31
|
-
reserved `v1`, `playground`, or `docs` segments).
|
|
32
|
-
|
|
33
|
-
## Project tree
|
|
34
|
-
|
|
35
|
-
Most projects start with this shape.
|
|
8
|
+
An Agent SDK project keeps agent files under `bot/`, and each file's
|
|
9
|
+
path determines how Agent SDK loads it. [Evals](../evals.md) live in
|
|
10
|
+
`evals/` at the project root, beside `bot/`.
|
|
36
11
|
|
|
37
12
|
```text
|
|
38
13
|
my-agent/
|
|
39
14
|
├── package.json
|
|
40
15
|
├── bot/
|
|
41
|
-
│ ├── agent.ts
|
|
42
|
-
│ ├── instructions.md
|
|
16
|
+
│ ├── agent.ts
|
|
17
|
+
│ ├── instructions.md
|
|
43
18
|
│ ├── tools/
|
|
44
|
-
│ │ └── approve_pr.ts
|
|
19
|
+
│ │ └── approve_pr.ts
|
|
45
20
|
│ ├── skills/
|
|
46
|
-
│ │ └── pr-review.md
|
|
21
|
+
│ │ └── pr-review.md
|
|
47
22
|
│ ├── mcp-connections/
|
|
48
|
-
│ │ └── linear.ts
|
|
49
|
-
│ ├── host-connections/
|
|
50
|
-
│ │ └── inventory.ts # host-only MCP tools
|
|
23
|
+
│ │ └── linear.ts
|
|
51
24
|
│ ├── subagents/
|
|
52
25
|
│ │ └── reviewer/
|
|
53
26
|
│ │ ├── agent.ts
|
|
54
27
|
│ │ └── instructions.md
|
|
28
|
+
│ ├── extensions/
|
|
29
|
+
│ │ └── ci.ts
|
|
55
30
|
│ ├── channels/
|
|
56
|
-
│ │ └── github.ts
|
|
31
|
+
│ │ └── github.ts
|
|
57
32
|
│ └── hooks/
|
|
58
|
-
│ └── audit.ts
|
|
33
|
+
│ └── audit.ts
|
|
59
34
|
└── evals/
|
|
60
|
-
|
|
35
|
+
├── evals.config.ts
|
|
36
|
+
└── readiness.eval.ts
|
|
61
37
|
```
|
|
62
38
|
|
|
63
|
-
|
|
64
|
-
inside it. See [Evals](../evals.md).
|
|
39
|
+
The root agent's name is the `name` in `package.json`, or else the directory name. When one server hosts multiple agents, each slug is the agent's directory name, and it must match `[A-Za-z0-9][A-Za-z0-9_-]*` and can't be `v1`, `playground`, or `docs`.
|
|
65
40
|
|
|
66
41
|
## Folder reference
|
|
67
42
|
|
|
68
|
-
Each path maps to a capability and a reference page.
|
|
69
|
-
|
|
70
43
|
| Path under `bot/` | What it is | Reference |
|
|
71
44
|
| --- | --- | --- |
|
|
72
|
-
| `agent.ts` | `defineAgent({ model?, local? })
|
|
73
|
-
| `instructions.md` | Always-on system prompt, required on the root agent
|
|
74
|
-
| `tools/<name>.ts` | One typed tool
|
|
75
|
-
| `skills/*` |
|
|
76
|
-
| `mcp-connections/<name>.ts` | MCP servers
|
|
77
|
-
| `host-connections/<name>.ts` |
|
|
78
|
-
| `subagents/<id>/` | Child agent directory
|
|
79
|
-
| `extensions/<ns>.ts` or `extensions/<ns>/` |
|
|
80
|
-
| `channels
|
|
81
|
-
| `hooks/*.ts` | Observe-only event subscribers
|
|
82
|
-
| `artifacts.ts` |
|
|
83
|
-
| `schedules/*` | Cron-driven runs
|
|
84
|
-
| `reminders/*.ts` | Named reminder handlers
|
|
45
|
+
| `agent.ts` | `defineAgent({ model?, local? })` | [Agent config](./agent-config.md) |
|
|
46
|
+
| `instructions.md` | Always-on system prompt, required on the root agent | [Instructions](./instructions.md) |
|
|
47
|
+
| `tools/<name>.ts` | One typed tool named after the file | [Tools](./tools.md) |
|
|
48
|
+
| `skills/*` | Procedures loaded on demand | [Skills](./skills.md) |
|
|
49
|
+
| `mcp-connections/<name>.ts` | MCP servers for the model, server tools, and handlers | [MCP connections](./connections.md) |
|
|
50
|
+
| `host-connections/<name>.ts` | MCP servers for host code and `mcp oauth`. The model never sees them | [MCP connections](./connections.md) |
|
|
51
|
+
| `subagents/<id>/` | Child agent directory with a required `description` | [Subagents](./subagents.md) |
|
|
52
|
+
| `extensions/<ns>.ts` or `extensions/<ns>/` | Extension or Cursor plugin mount. Its contributions become `<ns>__<name>` | [Extensions](./extensions.md) |
|
|
53
|
+
| `channels/<name>.ts` | HTTP routes under `/v1/channels/<name>` | [Channels](./channels.md) |
|
|
54
|
+
| `hooks/*.ts` | Observe-only event subscribers | [Hooks](./hooks.md) |
|
|
55
|
+
| `artifacts.ts` | Artifact kinds, the `tag_artifact` opt-in, and retention | [Artifacts](./artifacts.md) |
|
|
56
|
+
| `schedules/*` | Cron-driven runs | [Schedules](./schedules.md) |
|
|
57
|
+
| `reminders/*.ts` | Named reminder handlers | [Reminders](./schedules.md#reminders) |
|
|
85
58
|
| `sandbox/workspace/**` | Seed files copied into each local session workspace | [Sessions](./sessions.md#local-session-workspace) |
|
|
86
|
-
| `lib/` |
|
|
87
|
-
|
|
88
|
-
Discovery rejects a `bot/result.ts` file. To act on a turn's decision, have
|
|
89
|
-
the model record it with an authored [tool](./tools.md), then act on it from a
|
|
90
|
-
`turn.completed` [hook](./hooks.md).
|
|
91
|
-
|
|
92
|
-
Evals use project-root paths:
|
|
59
|
+
| `lib/` | Shared imports, never discovered | None |
|
|
93
60
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
| `evals/evals.config.ts` | Shared eval settings (e.g. `maxConcurrency`); required when evals exist | [Evals](../evals.md) |
|
|
97
|
-
| `evals/**/*.eval.ts` | Filesystem evals; case id = path under `evals/` | [Evals](../evals.md) |
|
|
61
|
+
Every eval project needs `evals/evals.config.ts`. Each
|
|
62
|
+
`evals/**/*.eval.ts` file is a suite whose case IDs come from its path.
|
|
98
63
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
64
|
+
A `.ts` file in a discovery folder loads as a definition, and an
|
|
65
|
+
unrecognized directory produces a validation warning. Agent SDK still
|
|
66
|
+
loads existing projects rooted at `agent/`.
|
|
102
67
|
|
|
103
68
|
## Inspect discovery
|
|
104
69
|
|
|
105
|
-
Run `agent-sdk validate --dir .` and `agent-sdk info --dir .`.
|
|
106
|
-
`validate` prints diagnostics, and `serve` refuses to start on
|
|
107
|
-
error-severity ones. Warnings print but don't block. `info` lists the discovered
|
|
108
|
-
surface, so a missing tool or channel shows up immediately. From
|
|
109
|
-
there, check the folder reference: the file is usually in the wrong directory
|
|
110
|
-
or has the wrong extension.
|
|
111
|
-
|
|
112
70
|
```text
|
|
113
|
-
agent-sdk validate --dir . # diagnostics
|
|
114
|
-
agent-sdk info --dir . #
|
|
115
|
-
agent-sdk info --dir . --json #
|
|
71
|
+
agent-sdk validate --dir . # diagnostics, non-zero exit on errors
|
|
72
|
+
agent-sdk info --dir . # discovered surface
|
|
73
|
+
agent-sdk info --dir . --json # same shape as GET /v1/info
|
|
116
74
|
```
|
|
117
75
|
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
- [Agent config](./agent-config.md): the config at the project root
|
|
121
|
-
- [Tools](./tools.md): add typed actions under `tools/`
|
|
122
|
-
- [CLI](./cli.md): commands that discover this tree
|
|
76
|
+
`serve` refuses to start on errors. Warnings do not block startup. When `info` omits a tool or channel, the file is in the wrong directory or has the wrong extension.
|