@grok/agent-sdk 0.2.29 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/channels/slack/cli-project.js +1 -1
- package/dist/channels/slack/slack-channel.d.ts.map +1 -1
- package/dist/channels/slack/slack-channel.js +27 -14
- package/dist/docs/404.html +2 -2
- package/dist/docs/assets/{app.DMrZKFjI.js → app.BSH__xV4.js} +4 -4
- package/dist/docs/assets/building-with-agents.md.Bo3ct-rf.js +6 -0
- package/dist/docs/assets/{building-with-agents.md.Bf1yH2tG.lean.js → building-with-agents.md.Bo3ct-rf.lean.js} +1 -1
- package/dist/docs/assets/changelog.md.b6H_ea44.js +1 -0
- package/dist/docs/assets/changelog.md.b6H_ea44.lean.js +1 -0
- package/dist/docs/assets/chunks/@localSearchIndexroot.CiRGcfZg.js +1 -0
- package/dist/docs/assets/chunks/{VPLocalSearchBox.DQvuw1KA.js → VPLocalSearchBox.Cadl7A0k.js} +1 -1
- package/dist/docs/assets/chunks/{arc.ahOG-Qza.js → arc.K7t9nNY6.js} +1 -1
- package/dist/docs/assets/chunks/{architectureDiagram-Q4EWVU46.BcgfYNO_.js → architectureDiagram-Q4EWVU46.SlHEknkX.js} +1 -1
- package/dist/docs/assets/chunks/{baseUniq.DeIYZrWh.js → baseUniq.DJLRMLkz.js} +1 -1
- package/dist/docs/assets/chunks/{blockDiagram-DXYQGD6D.HjJ2goMX.js → blockDiagram-DXYQGD6D.Bs6XxFpe.js} +1 -1
- package/dist/docs/assets/chunks/{c4Diagram-AHTNJAMY.C1QTb9GM.js → c4Diagram-AHTNJAMY.CyLg6Ovc.js} +1 -1
- package/dist/docs/assets/chunks/channel.CVTdqYx0.js +1 -0
- package/dist/docs/assets/chunks/{chunk-4BX2VUAB.UuZiDiVp.js → chunk-4BX2VUAB.DTQ4TinT.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-4TB4RGXK.5A3YmkhI.js → chunk-4TB4RGXK.Es84IgcH.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-55IACEB6.B4uf1yYV.js → chunk-55IACEB6.Clm3cGPQ.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-EDXVE4YY.CoXBce8t.js → chunk-EDXVE4YY.DE4CRkS5.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-FMBD7UC4.DnC5NO4e.js → chunk-FMBD7UC4.Bf8HCvqp.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-OYMX7WX6.CzfHCeIi.js → chunk-OYMX7WX6.eub-7nSx.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-QZHKN3VN.C6tcwkVd.js → chunk-QZHKN3VN.WyP9VAS_.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-YZCP3GAM._oboyZ1A.js → chunk-YZCP3GAM.LO9ohhDE.js} +1 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.CsJJyx6-.js +1 -0
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.CsJJyx6-.js +1 -0
- package/dist/docs/assets/chunks/clone.Dk8KvtOB.js +1 -0
- package/dist/docs/assets/chunks/{cose-bilkent-S5V4N54A.BfPVKeId.js → cose-bilkent-S5V4N54A.D5za6aH0.js} +1 -1
- package/dist/docs/assets/chunks/{dagre-KV5264BT.CLMLc0lD.js → dagre-KV5264BT.Dq1daUru.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-5BDNPKRD.C7OF7UfH.js → diagram-5BDNPKRD.j1YL5BKS.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-G4DWMVQ6.Dpao0Bl1.js → diagram-G4DWMVQ6.Bi1aLdhC.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-MMDJMWI5.DLnM9eLp.js → diagram-MMDJMWI5.BOzMEkAr.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-TYMM5635.BcpVgA_M.js → diagram-TYMM5635.Dx2FVhCr.js} +1 -1
- package/dist/docs/assets/chunks/{erDiagram-SMLLAGMA.CsL5JuCV.js → erDiagram-SMLLAGMA.DI4TNkye.js} +1 -1
- package/dist/docs/assets/chunks/{flowDiagram-DWJPFMVM.MFihq9AF.js → flowDiagram-DWJPFMVM.C58Z9uPK.js} +1 -1
- package/dist/docs/assets/chunks/{ganttDiagram-T4ZO3ILL.CJeLodyG.js → ganttDiagram-T4ZO3ILL.DXSpW809.js} +1 -1
- package/dist/docs/assets/chunks/{gitGraphDiagram-UUTBAWPF.1HhlE45Z.js → gitGraphDiagram-UUTBAWPF.B955oaFl.js} +1 -1
- package/dist/docs/assets/chunks/{graph.BS02KkWA.js → graph.BQXhKtxS.js} +1 -1
- package/dist/docs/assets/chunks/{infoDiagram-42DDH7IO.fp5gvytQ.js → infoDiagram-42DDH7IO.Dozj_-Gm.js} +1 -1
- package/dist/docs/assets/chunks/{ishikawaDiagram-UXIWVN3A.C6Wk1V4I.js → ishikawaDiagram-UXIWVN3A.D2140OzH.js} +1 -1
- package/dist/docs/assets/chunks/{journeyDiagram-VCZTEJTY.qJt4uJ_H.js → journeyDiagram-VCZTEJTY.DrqrMhCk.js} +1 -1
- package/dist/docs/assets/chunks/{kanban-definition-6JOO6SKY.z2tG9kly.js → kanban-definition-6JOO6SKY.Dv-LTrlw.js} +1 -1
- package/dist/docs/assets/chunks/{layout.BPCkdejr.js → layout.CGtHp49X.js} +1 -1
- package/dist/docs/assets/chunks/{linear.CL3TC3u7.js → linear.CHZLYB52.js} +1 -1
- package/dist/docs/assets/chunks/{min.SPrSp704.js → min.D4Vt3eIy.js} +1 -1
- package/dist/docs/assets/chunks/{mindmap-definition-QFDTVHPH.DgrQRFZW.js → mindmap-definition-QFDTVHPH.BBfpYTea.js} +1 -1
- package/dist/docs/assets/chunks/{pieDiagram-DEJITSTG.Ba7yxiW2.js → pieDiagram-DEJITSTG.BVYvElmY.js} +1 -1
- package/dist/docs/assets/chunks/{quadrantDiagram-34T5L4WZ.Bvskad4p.js → quadrantDiagram-34T5L4WZ.C6Gc2mdY.js} +1 -1
- package/dist/docs/assets/chunks/{requirementDiagram-MS252O5E.Ce70ugV9.js → requirementDiagram-MS252O5E.DWa8b4cn.js} +1 -1
- package/dist/docs/assets/chunks/{sankeyDiagram-XADWPNL6.BJ5OEULO.js → sankeyDiagram-XADWPNL6.Bi-g4ajv.js} +1 -1
- package/dist/docs/assets/chunks/{sequenceDiagram-FGHM5R23.C8a1hDs6.js → sequenceDiagram-FGHM5R23.DlU3vVN9.js} +1 -1
- package/dist/docs/assets/chunks/{stateDiagram-FHFEXIEX.D2D8A5CK.js → stateDiagram-FHFEXIEX.CeqJRqnU.js} +1 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.DE0BnUZh.js +1 -0
- package/dist/docs/assets/chunks/{theme.DRciHmS1.js → theme.DGq7D4tt.js} +2 -2
- package/dist/docs/assets/chunks/{timeline-definition-GMOUNBTQ.C4ePrY8-.js → timeline-definition-GMOUNBTQ.Cqf2kjq9.js} +1 -1
- package/dist/docs/assets/chunks/{vennDiagram-DHZGUBPP.Dzso6dEA.js → vennDiagram-DHZGUBPP.BeOpE_lM.js} +1 -1
- package/dist/docs/assets/chunks/{wardley-RL74JXVD.djgXR0ar.js → wardley-RL74JXVD.FMQXA-6q.js} +1 -1
- package/dist/docs/assets/chunks/{wardleyDiagram-NUSXRM2D.Bf2ICxjh.js → wardleyDiagram-NUSXRM2D.BXS65dAC.js} +1 -1
- package/dist/docs/assets/chunks/{xychartDiagram-5P7HB3ND.DEH4BcVJ.js → xychartDiagram-5P7HB3ND.haEiSxqc.js} +1 -1
- package/dist/docs/assets/deployment.md.DJtuDVLh.js +31 -0
- package/dist/docs/assets/{deployment.md.KW0Ni_rY.lean.js → deployment.md.DJtuDVLh.lean.js} +1 -1
- package/dist/docs/assets/evals.md.Dne6VRmZ.js +49 -0
- package/dist/docs/assets/evals.md.Dne6VRmZ.lean.js +1 -0
- package/dist/docs/assets/{guides_agent-to-agent.md.D1D5f6Jc.js → guides_agent-to-agent.md.DcB3nhOz.js} +8 -8
- package/dist/docs/assets/guides_agent-to-agent.md.DcB3nhOz.lean.js +1 -0
- package/dist/docs/assets/{guides_bitbucket.md.DkjkBRU8.js → guides_bitbucket.md.BiA6ZMFW.js} +27 -27
- package/dist/docs/assets/{guides_bitbucket.md.DkjkBRU8.lean.js → guides_bitbucket.md.BiA6ZMFW.lean.js} +1 -1
- package/dist/docs/assets/guides_cloud-agents.md.CiXAW6on.js +9 -0
- package/dist/docs/assets/{guides_cloud-agents.md.Ceyjv0ul.lean.js → guides_cloud-agents.md.CiXAW6on.lean.js} +1 -1
- package/dist/docs/assets/guides_convert-automation.md.BvTxsJ8J.js +26 -0
- package/dist/docs/assets/{guides_convert-automation.md.BjraCvok.lean.js → guides_convert-automation.md.BvTxsJ8J.lean.js} +1 -1
- package/dist/docs/assets/{guides_github.md.CgN5sNbW.js → guides_github.md.CcuZ7keS.js} +11 -19
- package/dist/docs/assets/{guides_github.md.CgN5sNbW.lean.js → guides_github.md.CcuZ7keS.lean.js} +1 -1
- package/dist/docs/assets/{guides_gitlab.md.DCE0p7_w.js → guides_gitlab.md.DcKusOcU.js} +63 -73
- package/dist/docs/assets/{guides_gitlab.md.DCE0p7_w.lean.js → guides_gitlab.md.DcKusOcU.lean.js} +1 -1
- package/dist/docs/assets/guides_improve.md.o3WOGR7n.js +16 -0
- package/dist/docs/assets/{guides_improve.md.BFYtrtLE.lean.js → guides_improve.md.o3WOGR7n.lean.js} +1 -1
- package/dist/docs/assets/{guides_jev.md.CEqLgjj9.js → guides_jev.md.DGCzkMUN.js} +20 -60
- package/dist/docs/assets/{guides_jev.md.CEqLgjj9.lean.js → guides_jev.md.DGCzkMUN.lean.js} +1 -1
- package/dist/docs/assets/{guides_mcp-oauth.md.DrGY92u4.js → guides_mcp-oauth.md.GVPMKcYl.js} +3 -5
- package/dist/docs/assets/{guides_mcp-oauth.md.DrGY92u4.lean.js → guides_mcp-oauth.md.GVPMKcYl.lean.js} +1 -1
- package/dist/docs/assets/guides_migrate.md.B8CZxnnX.js +3 -0
- package/dist/docs/assets/{guides_migrate.md.RS9Eu-Xh.lean.js → guides_migrate.md.B8CZxnnX.lean.js} +1 -1
- package/dist/docs/assets/guides_opentelemetry.md.BRSktBHt.js +26 -0
- package/dist/docs/assets/guides_opentelemetry.md.BRSktBHt.lean.js +1 -0
- package/dist/docs/assets/guides_pagerduty.md.pMXUkZZc.js +61 -0
- package/dist/docs/assets/guides_pagerduty.md.pMXUkZZc.lean.js +1 -0
- package/dist/docs/assets/guides_slack.md.D7Rwyva4.js +82 -0
- package/dist/docs/assets/{guides_slack.md.BwXHURvY.lean.js → guides_slack.md.D7Rwyva4.lean.js} +1 -1
- package/dist/docs/assets/{guides_webhooks.md.BJk63ZTs.js → guides_webhooks.md.B5DXt2v1.js} +7 -7
- package/dist/docs/assets/{guides_webhooks.md.BJk63ZTs.lean.js → guides_webhooks.md.B5DXt2v1.lean.js} +1 -1
- package/dist/docs/assets/hillclimbing.md.M51bF-oT.js +5 -0
- package/dist/docs/assets/hillclimbing.md.M51bF-oT.lean.js +1 -0
- package/dist/docs/assets/index.md.DnJPj_B6.js +14 -0
- package/dist/docs/assets/index.md.DnJPj_B6.lean.js +1 -0
- package/dist/docs/assets/quickstart.md.r-oE8nkX.js +113 -0
- package/dist/docs/assets/{quickstart.md.CljDaJBi.lean.js → quickstart.md.r-oE8nkX.lean.js} +1 -1
- package/dist/docs/assets/reference_access.md.C5lblfUC.js +1 -0
- package/dist/docs/assets/reference_access.md.C5lblfUC.lean.js +1 -0
- package/dist/docs/assets/reference_agent-config.md.BSNp2uJ7.js +27 -0
- package/dist/docs/assets/{reference_agent-config.md.Ck29qYNj.lean.js → reference_agent-config.md.BSNp2uJ7.lean.js} +1 -1
- package/dist/docs/assets/reference_artifacts.md.BJpAI7h9.js +17 -0
- package/dist/docs/assets/{reference_artifacts.md.C-hKR2hp.lean.js → reference_artifacts.md.BJpAI7h9.lean.js} +1 -1
- package/dist/docs/assets/reference_channels.md.CPWOpdsC.js +21 -0
- package/dist/docs/assets/{reference_channels.md.DsJfGSBJ.lean.js → reference_channels.md.CPWOpdsC.lean.js} +1 -1
- package/dist/docs/assets/reference_cli.md.DHm6DmYk.js +83 -0
- package/dist/docs/assets/reference_cli.md.DHm6DmYk.lean.js +1 -0
- package/dist/docs/assets/reference_connections.md.DoY4vrDH.js +54 -0
- package/dist/docs/assets/{reference_connections.md.BoAotr7_.lean.js → reference_connections.md.DoY4vrDH.lean.js} +1 -1
- package/dist/docs/assets/reference_evals.md.DgfUtfIc.js +69 -0
- package/dist/docs/assets/{reference_evals.md.2BXeMiO2.lean.js → reference_evals.md.DgfUtfIc.lean.js} +1 -1
- package/dist/docs/assets/{reference_extensions.md.DI5X5x8p.js → reference_extensions.md.DHbW6eOf.js} +6 -8
- package/dist/docs/assets/{reference_extensions.md.DI5X5x8p.lean.js → reference_extensions.md.DHbW6eOf.lean.js} +1 -1
- package/dist/docs/assets/reference_hooks.md.vbIM394-.js +39 -0
- package/dist/docs/assets/reference_hooks.md.vbIM394-.lean.js +1 -0
- package/dist/docs/assets/reference_http-api.md.C7Cb0r2J.js +7 -0
- package/dist/docs/assets/{reference_http-api.md._RWELr3d.lean.js → reference_http-api.md.C7Cb0r2J.lean.js} +1 -1
- package/dist/docs/assets/reference_instructions.md.CV6Qq0UX.js +14 -0
- package/dist/docs/assets/reference_instructions.md.CV6Qq0UX.lean.js +1 -0
- package/dist/docs/assets/reference_limits.md.CbdtFr4T.js +8 -0
- package/dist/docs/assets/reference_limits.md.CbdtFr4T.lean.js +1 -0
- package/dist/docs/assets/reference_memory.md.CdoJISM-.js +3 -0
- package/dist/docs/assets/{reference_memory.md.Dd7cyV9V.lean.js → reference_memory.md.CdoJISM-.lean.js} +1 -1
- package/dist/docs/assets/reference_playground.md.DIUsRAcy.js +1 -0
- package/dist/docs/assets/{reference_playground.md.CQiJk9CM.lean.js → reference_playground.md.DIUsRAcy.lean.js} +1 -1
- package/dist/docs/assets/reference_project-layout.md.9DiKoE16.js +26 -0
- package/dist/docs/assets/reference_project-layout.md.9DiKoE16.lean.js +1 -0
- package/dist/docs/assets/reference_schedules.md.Dd8_d0WG.js +45 -0
- package/dist/docs/assets/{reference_schedules.md.RC47aFm4.lean.js → reference_schedules.md.Dd8_d0WG.lean.js} +1 -1
- package/dist/docs/assets/reference_sessions.md.NXVQt9mP.js +22 -0
- package/dist/docs/assets/{reference_sessions.md.C7KFhWXV.lean.js → reference_sessions.md.NXVQt9mP.lean.js} +1 -1
- package/dist/docs/assets/{reference_skills.md.Dej2zQxi.js → reference_skills.md.DzCPNPkG.js} +4 -4
- package/dist/docs/assets/{reference_skills.md.Dej2zQxi.lean.js → reference_skills.md.DzCPNPkG.lean.js} +1 -1
- package/dist/docs/assets/reference_subagents.md.Dvpq2sUu.js +10 -0
- package/dist/docs/assets/{reference_subagents.md.CAhvW4yS.lean.js → reference_subagents.md.Dvpq2sUu.lean.js} +1 -1
- package/dist/docs/assets/reference_tools.md.B2OaR1Nb.js +62 -0
- package/dist/docs/assets/{reference_tools.md.DQr7Fnhu.lean.js → reference_tools.md.B2OaR1Nb.lean.js} +1 -1
- package/dist/docs/assets/templates_agentic-owners.md.B6ZmKAzT.js +13 -0
- package/dist/docs/assets/{templates_agentic-owners.md.Dh2nDSqg.lean.js → templates_agentic-owners.md.B6ZmKAzT.lean.js} +1 -1
- package/dist/docs/assets/templates_reviews.md.dr9Xv_KM.js +10 -0
- package/dist/docs/assets/templates_reviews.md.dr9Xv_KM.lean.js +1 -0
- package/dist/docs/assets/troubleshooting.md.DfKKvW1R.js +3 -0
- package/dist/docs/assets/{troubleshooting.md.CGOdNVAL.lean.js → troubleshooting.md.DfKKvW1R.lean.js} +1 -1
- package/dist/docs/building-with-agents.html +41 -44
- package/dist/docs/building-with-agents.md +11 -104
- package/dist/docs/changelog.html +37 -37
- package/dist/docs/changelog.md +14 -145
- package/dist/docs/deployment.html +54 -54
- package/dist/docs/deployment.md +97 -270
- package/dist/docs/evals.html +52 -71
- package/dist/docs/evals.md +33 -129
- package/dist/docs/guides/agent-to-agent.html +43 -43
- package/dist/docs/guides/agent-to-agent.md +29 -64
- package/dist/docs/guides/bitbucket.html +62 -62
- package/dist/docs/guides/bitbucket.md +73 -134
- package/dist/docs/guides/cloud-agents.html +37 -37
- package/dist/docs/guides/cloud-agents.md +23 -53
- package/dist/docs/guides/convert-automation.html +39 -56
- package/dist/docs/guides/convert-automation.md +31 -115
- package/dist/docs/guides/github.html +46 -54
- package/dist/docs/guides/github.md +49 -131
- package/dist/docs/guides/gitlab.html +98 -108
- package/dist/docs/guides/gitlab.md +104 -184
- package/dist/docs/guides/improve.html +38 -43
- package/dist/docs/guides/improve.md +24 -90
- package/dist/docs/guides/jev.html +55 -95
- package/dist/docs/guides/jev.md +53 -160
- package/dist/docs/guides/mcp-oauth.html +38 -40
- package/dist/docs/guides/mcp-oauth.md +33 -67
- package/dist/docs/guides/migrate.html +38 -43
- package/dist/docs/guides/migrate.md +56 -130
- package/dist/docs/guides/opentelemetry.html +41 -43
- package/dist/docs/guides/opentelemetry.md +32 -27
- package/dist/docs/guides/pagerduty.html +50 -49
- package/dist/docs/guides/pagerduty.md +65 -199
- package/dist/docs/guides/slack.html +51 -57
- package/dist/docs/guides/slack.md +76 -204
- package/dist/docs/guides/webhooks.html +42 -42
- package/dist/docs/guides/webhooks.md +64 -146
- package/dist/docs/hashmap.json +1 -1
- package/dist/docs/hillclimbing.html +40 -42
- package/dist/docs/hillclimbing.md +40 -102
- package/dist/docs/index.html +49 -61
- package/dist/docs/index.md +42 -82
- package/dist/docs/llms-full.txt +2272 -5711
- package/dist/docs/llms.txt +9 -14
- package/dist/docs/quickstart.html +95 -152
- package/dist/docs/quickstart.md +91 -180
- package/dist/docs/reference/access.html +36 -36
- package/dist/docs/reference/access.md +7 -12
- package/dist/docs/reference/agent-config.html +45 -58
- package/dist/docs/reference/agent-config.md +92 -176
- package/dist/docs/reference/artifacts.html +38 -39
- package/dist/docs/reference/artifacts.md +38 -62
- package/dist/docs/reference/channels.html +38 -39
- package/dist/docs/reference/channels.md +102 -151
- package/dist/docs/reference/cli.html +68 -84
- package/dist/docs/reference/cli.md +232 -697
- package/dist/docs/reference/connections.html +45 -57
- package/dist/docs/reference/connections.md +83 -164
- package/dist/docs/reference/evals.html +47 -54
- package/dist/docs/reference/evals.md +75 -141
- package/dist/docs/reference/extensions.html +41 -43
- package/dist/docs/reference/extensions.md +37 -70
- package/dist/docs/reference/hooks.html +40 -52
- package/dist/docs/reference/hooks.md +62 -133
- package/dist/docs/reference/http-api.html +38 -42
- package/dist/docs/reference/http-api.md +66 -118
- package/dist/docs/reference/instructions.html +39 -39
- package/dist/docs/reference/instructions.md +19 -29
- package/dist/docs/reference/limits.html +38 -38
- package/dist/docs/reference/limits.md +9 -21
- package/dist/docs/reference/memory.html +37 -38
- package/dist/docs/reference/memory.md +38 -75
- package/dist/docs/reference/playground.html +36 -36
- package/dist/docs/reference/playground.md +14 -22
- package/dist/docs/reference/project-layout.html +49 -48
- package/dist/docs/reference/project-layout.md +38 -84
- package/dist/docs/reference/schedules.html +44 -46
- package/dist/docs/reference/schedules.md +59 -90
- package/dist/docs/reference/sessions.html +37 -37
- package/dist/docs/reference/sessions.md +66 -113
- package/dist/docs/reference/skills.html +39 -39
- package/dist/docs/reference/skills.md +11 -31
- package/dist/docs/reference/subagents.html +37 -37
- package/dist/docs/reference/subagents.md +17 -31
- package/dist/docs/reference/tools.html +47 -64
- package/dist/docs/reference/tools.md +48 -130
- package/dist/docs/templates/agentic-owners.html +38 -38
- package/dist/docs/templates/agentic-owners.md +50 -74
- package/dist/docs/templates/reviews.html +69 -0
- package/dist/docs/templates/reviews.md +71 -0
- package/dist/docs/troubleshooting.html +38 -36
- package/dist/docs/troubleshooting.md +48 -101
- package/dist/filesystem.d.ts +7 -320
- package/dist/filesystem.d.ts.map +1 -1
- package/dist/filesystem.js +10 -691
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/internal/authored-alias-hooks.d.ts +6 -0
- package/dist/internal/authored-alias-hooks.d.ts.map +1 -1
- package/dist/internal/authored-alias-hooks.js +12 -0
- package/dist/internal/authored-loaders.js +10 -1
- package/dist/internal/cli/commands/scaffold.js +1 -1
- package/dist/internal/cli-deploy.js +1 -1
- package/dist/internal/cli-docs.js +1 -1
- package/dist/internal/cli-images.js +1 -1
- package/dist/internal/cli-skills.js +1 -1
- package/dist/internal/continuation-session-ids.d.ts +15 -0
- package/dist/internal/continuation-session-ids.d.ts.map +1 -0
- package/dist/internal/continuation-session-ids.js +43 -0
- package/dist/internal/cursor/credentials.js +1 -1
- package/dist/internal/deploy-manifest.d.ts +1 -0
- package/dist/internal/deploy-manifest.d.ts.map +1 -1
- package/dist/internal/deploy-manifest.js +0 -1
- package/dist/internal/discovery/agent-config.d.ts +2 -6
- package/dist/internal/discovery/agent-config.d.ts.map +1 -1
- package/dist/internal/discovery/agent-config.js +8 -25
- package/dist/internal/discovery/agent.d.ts.map +1 -1
- package/dist/internal/discovery/agent.js +2 -3
- package/dist/internal/discovery/project.d.ts.map +1 -1
- package/dist/internal/discovery/project.js +15 -0
- package/dist/internal/filesystem/walk.d.ts +1 -5
- package/dist/internal/filesystem/walk.d.ts.map +1 -1
- package/dist/internal/filesystem/walk.js +1 -9
- package/dist/internal/hosted-catch-protocol.d.ts +3 -3
- package/dist/internal/hosted-catch-protocol.js +3 -3
- package/dist/internal/hosted-fetch.d.ts +7 -0
- package/dist/internal/hosted-fetch.d.ts.map +1 -0
- package/dist/internal/hosted-fetch.js +26 -0
- package/dist/internal/init-project.d.ts.map +1 -1
- package/dist/internal/init-project.js +7 -5
- package/dist/internal/install-cursor-skills.d.ts +5 -6
- package/dist/internal/install-cursor-skills.d.ts.map +1 -1
- package/dist/internal/install-cursor-skills.js +19 -4
- package/dist/internal/mcp-endpoint.js +4 -4
- package/dist/internal/model-config.d.ts.map +1 -1
- package/dist/internal/model-config.js +11 -4
- package/dist/internal/platform-timers.d.ts +3 -7
- package/dist/internal/platform-timers.d.ts.map +1 -1
- package/dist/internal/platform-timers.js +10 -51
- package/dist/internal/reminder-runner.js +1 -1
- package/dist/internal/server.d.ts.map +1 -1
- package/dist/internal/server.js +6 -1
- package/dist/internal/session-engine.d.ts +3 -0
- package/dist/internal/session-engine.d.ts.map +1 -1
- package/dist/internal/session-engine.js +13 -4
- package/dist/internal/shallow-clone.js +1 -1
- package/dist/playground/assets/index-Bno25Cg0.css +1 -0
- package/dist/playground/assets/index-SGKsaznh.js +62 -0
- package/dist/playground/index.html +2 -2
- package/dist/types.d.ts +6 -17
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js +2 -2
- package/docs/README.md +42 -82
- package/docs/building-with-agents.md +11 -104
- package/docs/changelog.md +15 -146
- package/docs/deployment.md +97 -270
- package/docs/evals.md +34 -130
- package/docs/guides/agent-to-agent.md +29 -64
- package/docs/guides/bitbucket.md +73 -134
- package/docs/guides/cloud-agents.md +23 -53
- package/docs/guides/convert-automation.md +31 -115
- package/docs/guides/github.md +49 -131
- package/docs/guides/gitlab.md +104 -184
- package/docs/guides/improve.md +24 -90
- package/docs/guides/jev.md +53 -160
- package/docs/guides/mcp-oauth.md +33 -67
- package/docs/guides/migrate.md +56 -130
- package/docs/guides/opentelemetry.md +37 -27
- package/docs/guides/pagerduty.md +68 -200
- package/docs/guides/slack.md +76 -204
- package/docs/guides/webhooks.md +64 -146
- package/docs/hillclimbing.md +41 -103
- package/docs/quickstart.md +91 -180
- package/docs/reference/access.md +7 -12
- package/docs/reference/agent-config.md +92 -176
- package/docs/reference/artifacts.md +38 -62
- package/docs/reference/channels.md +102 -151
- package/docs/reference/cli.md +232 -697
- package/docs/reference/connections.md +83 -164
- package/docs/reference/evals.md +75 -141
- package/docs/reference/extensions.md +37 -70
- package/docs/reference/hooks.md +61 -132
- package/docs/reference/http-api.md +66 -118
- package/docs/reference/instructions.md +20 -30
- package/docs/reference/limits.md +10 -22
- package/docs/reference/memory.md +38 -75
- package/docs/reference/playground.md +14 -22
- package/docs/reference/project-layout.md +38 -84
- package/docs/reference/schedules.md +59 -90
- package/docs/reference/sessions.md +66 -113
- package/docs/reference/skills.md +12 -32
- package/docs/reference/subagents.md +17 -31
- package/docs/reference/tools.md +48 -130
- package/docs/templates/agentic-owners.md +50 -74
- package/docs/templates/reviews.md +76 -0
- package/docs/troubleshooting.md +48 -101
- package/package.json +4 -4
- package/skills/cli/SKILL.md +1 -1
- package/skills/create-agent/SKILL.md +61 -7
- package/skills/debug/SKILL.md +1 -1
- package/skills/deploy/SKILL.md +3 -3
- package/skills/evals/SKILL.md +1 -1
- package/skills/framework-map/SKILL.md +2 -2
- package/skills/github/SKILL.md +1 -1
- package/skills/hillclimb/SKILL.md +1 -1
- package/skills/mcp-auth/SKILL.md +1 -1
- package/skills/migrate-v2/SKILL.md +2 -3
- package/skills/otel/SKILL.md +1 -1
- package/skills/setup-slack/SKILL.md +2 -2
- package/dist/docs/assets/building-with-agents.md.Bf1yH2tG.js +0 -9
- package/dist/docs/assets/changelog.md.DrLFQUlu.js +0 -1
- package/dist/docs/assets/changelog.md.DrLFQUlu.lean.js +0 -1
- package/dist/docs/assets/chunks/@localSearchIndexroot.Dpd_wxVU.js +0 -1
- package/dist/docs/assets/chunks/channel._fZX_hvU.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.eClS1Q0E.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.eClS1Q0E.js +0 -1
- package/dist/docs/assets/chunks/clone.W1Phdw9P.js +0 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.77yf4kRr.js +0 -1
- package/dist/docs/assets/deployment.md.KW0Ni_rY.js +0 -31
- package/dist/docs/assets/evals.md.DiljU__Z.js +0 -68
- package/dist/docs/assets/evals.md.DiljU__Z.lean.js +0 -1
- package/dist/docs/assets/guides_agent-to-agent.md.D1D5f6Jc.lean.js +0 -1
- package/dist/docs/assets/guides_cloud-agents.md.Ceyjv0ul.js +0 -9
- package/dist/docs/assets/guides_convert-automation.md.BjraCvok.js +0 -43
- package/dist/docs/assets/guides_hooks.md.BjeEiM7s.js +0 -54
- package/dist/docs/assets/guides_hooks.md.BjeEiM7s.lean.js +0 -1
- package/dist/docs/assets/guides_improve.md.BFYtrtLE.js +0 -21
- package/dist/docs/assets/guides_migrate.md.RS9Eu-Xh.js +0 -8
- package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.js +0 -28
- package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.lean.js +0 -1
- package/dist/docs/assets/guides_pagerduty.md.mnKXe9U0.js +0 -60
- package/dist/docs/assets/guides_pagerduty.md.mnKXe9U0.lean.js +0 -1
- package/dist/docs/assets/guides_slack.md.BwXHURvY.js +0 -88
- package/dist/docs/assets/hillclimbing.md.By61f3uq.js +0 -7
- package/dist/docs/assets/hillclimbing.md.By61f3uq.lean.js +0 -1
- package/dist/docs/assets/index.md.CAruw_rp.js +0 -26
- package/dist/docs/assets/index.md.CAruw_rp.lean.js +0 -1
- package/dist/docs/assets/quickstart.md.CljDaJBi.js +0 -170
- package/dist/docs/assets/reference_access.md.CEtibb4i.js +0 -1
- package/dist/docs/assets/reference_access.md.CEtibb4i.lean.js +0 -1
- package/dist/docs/assets/reference_agent-config.md.Ck29qYNj.js +0 -40
- package/dist/docs/assets/reference_artifacts.md.C-hKR2hp.js +0 -18
- package/dist/docs/assets/reference_channels.md.DsJfGSBJ.js +0 -22
- package/dist/docs/assets/reference_cli.md.BkdLRbXg.js +0 -99
- package/dist/docs/assets/reference_cli.md.BkdLRbXg.lean.js +0 -1
- package/dist/docs/assets/reference_connections.md.BoAotr7_.js +0 -66
- package/dist/docs/assets/reference_evals.md.2BXeMiO2.js +0 -76
- package/dist/docs/assets/reference_hooks.md.B-bwJuiG.js +0 -51
- package/dist/docs/assets/reference_hooks.md.B-bwJuiG.lean.js +0 -1
- package/dist/docs/assets/reference_http-api.md._RWELr3d.js +0 -11
- package/dist/docs/assets/reference_instructions.md.yL2hXLnl.js +0 -14
- package/dist/docs/assets/reference_instructions.md.yL2hXLnl.lean.js +0 -1
- package/dist/docs/assets/reference_limits.md.BCCnvt3o.js +0 -8
- package/dist/docs/assets/reference_limits.md.BCCnvt3o.lean.js +0 -1
- package/dist/docs/assets/reference_memory.md.Dd7cyV9V.js +0 -4
- package/dist/docs/assets/reference_playground.md.CQiJk9CM.js +0 -1
- package/dist/docs/assets/reference_project-layout.md.BamcPDUn.js +0 -25
- package/dist/docs/assets/reference_project-layout.md.BamcPDUn.lean.js +0 -1
- package/dist/docs/assets/reference_prompt.md.BMjm1Jp3.js +0 -9
- package/dist/docs/assets/reference_prompt.md.BMjm1Jp3.lean.js +0 -1
- package/dist/docs/assets/reference_schedules.md.RC47aFm4.js +0 -47
- package/dist/docs/assets/reference_sessions.md.C7KFhWXV.js +0 -22
- package/dist/docs/assets/reference_subagents.md.CAhvW4yS.js +0 -10
- package/dist/docs/assets/reference_tools.md.DQr7Fnhu.js +0 -79
- package/dist/docs/assets/templates_agentic-owners.md.Dh2nDSqg.js +0 -13
- package/dist/docs/assets/templates_security-reviewer.md.DnwXdnB5.js +0 -3
- package/dist/docs/assets/templates_security-reviewer.md.DnwXdnB5.lean.js +0 -1
- package/dist/docs/assets/templates_thermo-quality-review.md.MJIdHkzE.js +0 -3
- package/dist/docs/assets/templates_thermo-quality-review.md.MJIdHkzE.lean.js +0 -1
- package/dist/docs/assets/templates_thermo-review.md.DfN1OFOl.js +0 -3
- package/dist/docs/assets/templates_thermo-review.md.DfN1OFOl.lean.js +0 -1
- package/dist/docs/assets/templates_triage.md.BYWMloV4.js +0 -9
- package/dist/docs/assets/templates_triage.md.BYWMloV4.lean.js +0 -1
- package/dist/docs/assets/troubleshooting.md.CGOdNVAL.js +0 -1
- package/dist/docs/guides/hooks.html +0 -113
- package/dist/docs/guides/hooks.md +0 -116
- package/dist/docs/package/skills/create-agent/SKILL.md +0 -178
- package/dist/docs/package/skills/evals/SKILL.md +0 -145
- package/dist/docs/package/skills/github/SKILL.md +0 -133
- package/dist/docs/package/skills/hillclimb/SKILL.md +0 -63
- package/dist/docs/package/skills/mcp-auth/SKILL.md +0 -60
- package/dist/docs/package/skills/migrate-v2/SKILL.md +0 -394
- package/dist/docs/package/skills/setup-slack/SKILL.md +0 -136
- package/dist/docs/reference/prompt.html +0 -68
- package/dist/docs/reference/prompt.md +0 -47
- package/dist/docs/templates/security-reviewer.html +0 -62
- package/dist/docs/templates/security-reviewer.md +0 -81
- package/dist/docs/templates/thermo-quality-review.html +0 -62
- package/dist/docs/templates/thermo-quality-review.md +0 -75
- package/dist/docs/templates/thermo-review.html +0 -62
- package/dist/docs/templates/thermo-review.md +0 -75
- package/dist/docs/templates/triage.html +0 -68
- package/dist/docs/templates/triage.md +0 -101
- package/dist/internal/filesystem/errors.d.ts +0 -64
- package/dist/internal/filesystem/errors.d.ts.map +0 -1
- package/dist/internal/filesystem/errors.js +0 -180
- package/dist/internal/filesystem/merge.d.ts +0 -34
- package/dist/internal/filesystem/merge.d.ts.map +0 -1
- package/dist/internal/filesystem/merge.js +0 -154
- package/dist/playground/assets/index-Cl9zvmmf.js +0 -62
- package/dist/playground/assets/index-F8b5WvWi.css +0 -1
- package/docs/guides/hooks.md +0 -121
- package/docs/reference/prompt.md +0 -52
- package/docs/templates/security-reviewer.md +0 -86
- package/docs/templates/thermo-quality-review.md +0 -80
- package/docs/templates/thermo-review.md +0 -80
- package/docs/templates/triage.md +0 -106
|
@@ -5,18 +5,18 @@ description: "defineAgent at bot/agent.ts: the model, local workspace, and progr
|
|
|
5
5
|
|
|
6
6
|
# Agent config
|
|
7
7
|
|
|
8
|
-
`bot/agent.ts` default-exports `defineAgent(config)
|
|
9
|
-
the agent and
|
|
10
|
-
|
|
8
|
+
`bot/agent.ts` default-exports `defineAgent(config)`, which sets the model
|
|
9
|
+
that runs the agent and the defaults for a local run. Every field is optional on
|
|
10
|
+
the root agent.
|
|
11
11
|
|
|
12
12
|
```ts
|
|
13
13
|
import { defineAgent } from "@grok/agent-sdk";
|
|
14
14
|
|
|
15
15
|
export default defineAgent({
|
|
16
16
|
model: {
|
|
17
|
-
id: "grok-4.
|
|
17
|
+
id: "grok-4.7",
|
|
18
18
|
params: [
|
|
19
|
-
{ id: "
|
|
19
|
+
{ id: "reasoning_effort", value: "high" },
|
|
20
20
|
{ id: "fast", value: "true" },
|
|
21
21
|
],
|
|
22
22
|
}, // optional; this is the default
|
|
@@ -27,36 +27,24 @@ export default defineAgent({
|
|
|
27
27
|
|
|
28
28
|
| Field | Type | Meaning |
|
|
29
29
|
| --- | --- | --- |
|
|
30
|
-
| `model` | string or `{ id, params }` | Cursor model for turns. Defaults to `grok-4.
|
|
31
|
-
| `name` | string | Display name
|
|
32
|
-
| `description` | string | What the agent is for. Required on subagents
|
|
33
|
-
| `instructions` | string | Inline instructions
|
|
34
|
-
| `local` | `{ cwd?, workspaceDir?, sandbox? }` |
|
|
35
|
-
| `
|
|
36
|
-
| `
|
|
37
|
-
| `
|
|
38
|
-
| `
|
|
39
|
-
| `tools` | `ToolName[]` | Allowlist of built-in harness tools offered to the model. Unset = the model's full standard toolset. See [Harness tools](#harness-tools). |
|
|
30
|
+
| `model` | string or `{ id, params }` | Cursor model for turns. Defaults to `grok-4.7` with `reasoning_effort=high` and `fast=true`. Subagents omit it to inherit. |
|
|
31
|
+
| `name` | string | Display name. Defaults to the package or directory name. |
|
|
32
|
+
| `description` | string | What the agent is for. Required on subagents, where the parent model reads it to decide when to delegate. |
|
|
33
|
+
| `instructions` | string | Inline instructions for subagents and generated configs. Prefer `instructions.md`. |
|
|
34
|
+
| `local` | `{ cwd?, workspaceDir?, sandbox? }` | Defaults for a local run. See [Local options](#local-options). |
|
|
35
|
+
| `hosting` | `{ egressDomains?, secretNames? }` | The egress allowlist and expected secret names that `agent-sdk deploy` reads. Mounted [extensions](./extensions.md#build-an-extension) add their own. |
|
|
36
|
+
| `concurrency` | `{ maxRunningTurns? }` | Agent-wide limit on concurrent turns. See [Concurrency](#concurrency). |
|
|
37
|
+
| `builtinTools` | `{ reminders? }` | Opt-in tools that Agent SDK provides. See [Built-in tools](#built-in-tools). |
|
|
38
|
+
| `tools` | `ToolName[]` | Allowlist of built-in tools. Omit it for the full standard toolset. See [Harness tools](#harness-tools). |
|
|
40
39
|
| `fs` | `FileSystem` or `(ctx) => FileSystem` | Custom file tree for the session. `root` is the deprecated name. See [Custom filesystem](#custom-filesystem). |
|
|
41
40
|
| `skills` | `false` or `(ctx) => FileSystem` | Replaces the skills tree mounted at `/agent/skills`, or turns that mount off. |
|
|
42
41
|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
`model` is a Cursor model id string, or `{ id, params }`. Effort and
|
|
46
|
-
speed are params, not id suffixes. Agent SDK rejects suffix-style ids
|
|
47
|
-
like `grok-4.5-fast`:
|
|
42
|
+
The `persistent` field was removed. Discovery rejects a config that still sets it, and the error is `persistent was removed. Delete it from defineAgent.`, so `validate`, `dev`, and `deploy` fail until you delete the field. A deployment that is already running keeps serving until you stop or delete it.
|
|
48
43
|
|
|
49
|
-
|
|
50
|
-
model: {
|
|
51
|
-
id: "grok-4.5",
|
|
52
|
-
params: [
|
|
53
|
-
{ id: "effort", value: "high" },
|
|
54
|
-
{ id: "fast", value: "true" },
|
|
55
|
-
],
|
|
56
|
-
}
|
|
57
|
-
```
|
|
44
|
+
## Model
|
|
58
45
|
|
|
59
|
-
|
|
46
|
+
Set effort and speed with params, not in the id. Use the object form shown above
|
|
47
|
+
to set params, or a plain string when you don't need any:
|
|
60
48
|
|
|
61
49
|
```ts
|
|
62
50
|
model: "composer-2.5",
|
|
@@ -64,157 +52,91 @@ model: "composer-2.5",
|
|
|
64
52
|
|
|
65
53
|
## Local options
|
|
66
54
|
|
|
67
|
-
`local`
|
|
68
|
-
|
|
69
|
-
`
|
|
70
|
-
|
|
71
|
-
over `cwd`, and a per-send `workspaceDir` still wins over both.
|
|
72
|
-
Sessions share a working tree, so a file one turn writes is visible to
|
|
73
|
-
the next.
|
|
55
|
+
`local.workspaceDir` points every session at one shared working directory, for
|
|
56
|
+
agents that work inside an existing checkout. It takes precedence over `cwd`,
|
|
57
|
+
and a per-send `workspaceDir` wins over both. Sessions share that tree, so one
|
|
58
|
+
turn's files are visible to the next.
|
|
74
59
|
|
|
75
|
-
`local.sandbox` runs the
|
|
76
|
-
|
|
77
|
-
environment, including
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
60
|
+
`local.sandbox` runs the agent inside Cursor's local sandbox. It's off by
|
|
61
|
+
default, so shell commands auto-approve and inherit the serve process
|
|
62
|
+
environment, including the host's credentials. Turn it on when turns read
|
|
63
|
+
untrusted input, such as webhook payloads, PR diffs, or inbound chat. The
|
|
64
|
+
sandbox limits the tools themselves, so an injected prompt can't talk the model
|
|
65
|
+
past it.
|
|
81
66
|
|
|
82
67
|
Agent SDK runs the file tools (`read`, `edit`, `delete`, `grep`, `glob`, `ls`)
|
|
83
|
-
in the serve process, outside the sandbox. With `local.sandbox` on,
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
large-output files that web search and web fetch write. With
|
|
87
|
-
`local.sandbox` off, the file tools can read and write any path the serve
|
|
88
|
-
process can.
|
|
68
|
+
in the serve process, outside the sandbox. With `local.sandbox` on, they refuse
|
|
69
|
+
a path outside the session workspace with `Path is outside the workspace`. With
|
|
70
|
+
it off, they can reach any path the serve process can.
|
|
89
71
|
|
|
90
72
|
### Local cwd
|
|
91
73
|
|
|
92
|
-
`local.cwd` sets the parent directory for local
|
|
93
|
-
session uses `<cwd>/<sessionId>` unless a per-send `workspaceDir` overrides
|
|
94
|
-
it.
|
|
95
|
-
|
|
96
|
-
Session workspaces are real Cursor project directories. The harness loads
|
|
97
|
-
`AGENTS.md` and `.cursor` config from ancestor directories. An agent nested
|
|
98
|
-
in another git repo (a monorepo package) defaults to a per-project
|
|
99
|
-
cache directory under `~/.cache` when you omit `cwd`, so the enclosing checkout
|
|
100
|
-
does not leak rules, skills, or MCP servers into the turn. A standalone git
|
|
101
|
-
root keeps the in-project session workspace. Point `cwd` at a checkout only
|
|
102
|
-
when the agent should inherit that tree.
|
|
103
|
-
|
|
104
|
-
## Persistent hosting
|
|
105
|
-
|
|
106
|
-
By default, a hosted deployment starts a runtime when an event arrives
|
|
107
|
-
and stops it when the work ends. Set `persistent: true` to keep one
|
|
108
|
-
long-lived runtime for the deployment instead, with its state directory
|
|
109
|
-
on the runtime's own disk. On a redeploy, the new version starts beside
|
|
110
|
-
the old one on the same state, and the old version stops after the new
|
|
111
|
-
one takes over. Each team can have one persistent deployment. Local
|
|
112
|
-
serving ignores the flag.
|
|
113
|
-
|
|
114
|
-
```ts
|
|
115
|
-
export default defineAgent({
|
|
116
|
-
persistent: true,
|
|
117
|
-
hosting: { image: "incident-bot-base" },
|
|
118
|
-
});
|
|
119
|
-
```
|
|
74
|
+
`local.cwd` sets the parent directory for local session workspaces. Each
|
|
75
|
+
session uses `<cwd>/<sessionId>` unless a per-send `workspaceDir` overrides it.
|
|
120
76
|
|
|
121
|
-
|
|
122
|
-
`
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
77
|
+
Session workspaces are real Cursor project directories, so the local agent reads
|
|
78
|
+
`AGENTS.md` and `.cursor` config from every ancestor directory. When you omit
|
|
79
|
+
`cwd` and the agent sits inside another git repo, such as a monorepo package,
|
|
80
|
+
Agent SDK uses a per-project directory under `~/.cache` instead, so the
|
|
81
|
+
enclosing checkout's rules, skills, and MCP servers stay out of the turn. An
|
|
82
|
+
agent at its own git root keeps its workspaces inside the project. Point `cwd`
|
|
83
|
+
at a checkout only when the agent should inherit that tree.
|
|
127
84
|
|
|
128
85
|
## Custom filesystem
|
|
129
86
|
|
|
130
|
-
`fs` is mounted at
|
|
131
|
-
|
|
132
|
-
`root` is the deprecated name of `fs`. Set one of them. A tree that already
|
|
133
|
-
has `/agent/skills` fails session start unless `skills` is `false`.
|
|
134
|
-
|
|
135
|
-
Semantic search is removed. Use Grep. See
|
|
136
|
-
[Migrate off semantic search](#migrate-off-semantic-search).
|
|
87
|
+
`fs` is mounted at `/`, and Agent SDK mounts `/tmp` and `/agent/skills` over it. Set `fs` or the deprecated `root`, not both. A tree that already has `/agent/skills` fails session start unless `skills` is `false`.
|
|
137
88
|
|
|
138
89
|
## Harness tools
|
|
139
90
|
|
|
140
|
-
Use `tools` to limit which built-in Cursor
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
built-in tools. New platform tools stay disabled until you add them.
|
|
91
|
+
Use `tools` to limit which built-in Cursor tools the model can call.
|
|
92
|
+
When you set it, the model gets only the tools you list. An empty list turns
|
|
93
|
+
off every built-in tool, and new platform tools stay off until you add them.
|
|
144
94
|
|
|
145
95
|
```ts
|
|
146
96
|
export default defineAgent({
|
|
147
97
|
model: "composer-2.5",
|
|
148
|
-
// Read-only triage
|
|
149
|
-
// No shell, no edits, no subagents.
|
|
98
|
+
// Read-only triage: no shell, no edits, no subagents.
|
|
150
99
|
tools: ["read", "grep", "glob", "ls"],
|
|
151
100
|
});
|
|
152
101
|
```
|
|
153
102
|
|
|
154
|
-
Agent SDK always adds `"mcp"` to a configured allowlist, because
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
servers, point `local.cwd` outside the checkout. See
|
|
159
|
-
[Local cwd](#local-cwd). `local.sandbox` makes MCP tool calls fail
|
|
160
|
-
closed.
|
|
103
|
+
Agent SDK always adds `"mcp"` to a configured allowlist, because the server
|
|
104
|
+
tools in `bot/tools/` reach the model over MCP. With `local.sandbox` on, MCP
|
|
105
|
+
tool calls fail closed. An enclosing checkout can also add MCP servers, as
|
|
106
|
+
[Local cwd](#local-cwd) explains.
|
|
161
107
|
|
|
162
|
-
Use the Cursor SDK's public tool names,
|
|
163
|
-
`"edit"`, `"grep"`, `"glob"`, `"ls"`, and `"task"`.
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
[Migrate off semantic search](#migrate-off-semantic-search).
|
|
108
|
+
Use the Cursor SDK's public tool names, such as `"shell"`, `"read"`,
|
|
109
|
+
`"edit"`, `"grep"`, `"glob"`, `"ls"`, and `"task"`. An unknown name fails the
|
|
110
|
+
turn with a `ConfigurationError`, and `"SemanticSearch"` or `"semSearch"`
|
|
111
|
+
fails validation.
|
|
167
112
|
|
|
168
113
|
Two names have broader effects:
|
|
169
114
|
|
|
170
|
-
- `"shell"` also grants shell input. Tools with
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
its own curated toolset.
|
|
115
|
+
- `"shell"` also grants shell input. Tools with `execution: "agent"` need it
|
|
116
|
+
to run their scripts, and discovery warns when your allowlist blocks them.
|
|
117
|
+
- `"task"` lets the root agent start subagents. Each subagent keeps its own
|
|
118
|
+
toolset.
|
|
175
119
|
|
|
176
|
-
The allowlist
|
|
177
|
-
|
|
178
|
-
set `local: { sandbox: true }`.
|
|
120
|
+
The allowlist doesn't isolate the serve host, so pair it with `local.sandbox`
|
|
121
|
+
for untrusted input.
|
|
179
122
|
|
|
180
123
|
## Migrate off semantic search
|
|
181
124
|
|
|
182
|
-
Semantic search is removed
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
`glob`, and `maxResults`. A `GrepResult` has `path`, `lineNumber`, and
|
|
187
|
-
`line`.
|
|
188
|
-
|
|
189
|
-
Delete imports of `SearchQuery` and `SearchResult`. `SearchQuery`
|
|
190
|
-
carried a natural-language `query`, plus optional `maxResults` and
|
|
191
|
-
`targetDirectories`. `SearchResult` carried `path`, `score`, and
|
|
192
|
-
`snippet`. Import `GrepQuery` and `GrepResult` from `@grok/agent-sdk`.
|
|
125
|
+
Semantic search is removed, and `agent-sdk validate` reports
|
|
126
|
+
`Semantic search has been removed. Use Grep.` while a project still uses it.
|
|
127
|
+
[A turn fails or misbehaves](../troubleshooting.md#a-turn-fails-or-misbehaves) lists what to
|
|
128
|
+
delete and what to use instead.
|
|
193
129
|
|
|
194
|
-
|
|
195
|
-
Delete `bot/tools/SemanticSearch.ts` or `bot/tools/semSearch.ts`. In
|
|
196
|
-
`instructions.md`, tell the model to call `Grep` with `pattern`, and
|
|
197
|
-
with `path` or `glob` when the lookup should stay in one directory.
|
|
198
|
-
|
|
199
|
-
```ts
|
|
200
|
-
export default defineAgent({
|
|
201
|
-
tools: ["read", "grep"],
|
|
202
|
-
});
|
|
203
|
-
```
|
|
130
|
+
## Concurrency
|
|
204
131
|
|
|
205
|
-
`agent
|
|
206
|
-
when `tools` lists either name, or a file in `bot/tools/` uses it.
|
|
132
|
+
`concurrency.maxRunningTurns` caps how many model turns run at once across the agent's sessions. It takes a positive integer up to 200. Omit it for no limit.
|
|
207
133
|
|
|
208
|
-
|
|
134
|
+
When every slot is busy, a new turn queues in arrival order instead of failing. The stream records a `turn.queued` event with the queue
|
|
135
|
+
position, `GET /v1/sessions` reports `queued: true`, and the turn starts as
|
|
136
|
+
soon as a slot frees.
|
|
209
137
|
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
When every slot is busy, newly admitted turns queue FIFO instead of
|
|
213
|
-
failing: the stream records a durable `turn.queued` event with the
|
|
214
|
-
queue position, `GET /v1/sessions` reports `queued: true`, and each
|
|
215
|
-
queued turn starts as soon as a slot frees. A queued turn still counts
|
|
216
|
-
as running for busy semantics: follow-ups preempt it, and direct
|
|
217
|
-
write-effect tool calls get `409 session_busy`. Omit for unlimited.
|
|
138
|
+
A queued turn still counts as running. A follow-up preempts it, and a direct
|
|
139
|
+
write-effect tool call gets `409 session_busy`.
|
|
218
140
|
|
|
219
141
|
```ts
|
|
220
142
|
export default defineAgent({
|
|
@@ -224,15 +146,13 @@ export default defineAgent({
|
|
|
224
146
|
|
|
225
147
|
## Built-in tools
|
|
226
148
|
|
|
227
|
-
`builtinTools` opts into
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
warning, and like all server tools they run on the local runtime.
|
|
149
|
+
`builtinTools` opts into tools that Agent SDK provides. They behave like your
|
|
150
|
+
own server tools in turns, direct calls, `info`, and the playground. A tool you
|
|
151
|
+
write with the same name wins, with a warning.
|
|
231
152
|
|
|
232
|
-
`builtinTools: { reminders: true }` adds
|
|
233
|
-
current conversation
|
|
234
|
-
|
|
235
|
-
continuation key can't arm reminders. See
|
|
153
|
+
`builtinTools: { reminders: true }` adds `reminders_create`, `reminders_list`,
|
|
154
|
+
and `reminders_cancel`, bound to the current conversation. A session without a
|
|
155
|
+
continuation key can't set reminders. See
|
|
236
156
|
[Schedules and reminders](./schedules.md#reminders).
|
|
237
157
|
|
|
238
158
|
## Serve programmatically
|
|
@@ -250,36 +170,32 @@ console.log(`listening on ${handle.url}`);
|
|
|
250
170
|
// handle.createReminder(...), handle.agents, await handle.close()
|
|
251
171
|
```
|
|
252
172
|
|
|
253
|
-
`handle.agents` lists each mount as `slug
|
|
173
|
+
`handle.agents` lists each mount as `{ slug, url, info }`. `handle.project` is
|
|
174
|
+
deprecated.
|
|
254
175
|
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
`CURSOR_SERVICE_ACCOUNT_KEY`, or `agent-sdk login`.
|
|
176
|
+
`serve()` takes the same host settings as the [CLI](./cli.md) `serve` flags,
|
|
177
|
+
plus `discovery` for project-loading options and `mode: "single" | "multi"`.
|
|
178
|
+
Pass `apiKey`, or sign in the same way as the CLI, as
|
|
179
|
+
[Environment variables](./cli.md#environment-variables) describes.
|
|
260
180
|
|
|
261
181
|
## Inspect a project in tests
|
|
262
182
|
|
|
263
|
-
`loadProject(dir)` reads one project
|
|
183
|
+
`loadProject(dir)` reads one project without serving it. Its `info` matches the
|
|
184
|
+
`GET /v1/info` body.
|
|
264
185
|
|
|
265
186
|
```ts
|
|
266
187
|
import { loadProject } from "@grok/agent-sdk";
|
|
267
188
|
|
|
268
|
-
const
|
|
269
|
-
|
|
270
|
-
console.log(project.info.tools.map((tool) => tool.name));
|
|
189
|
+
const { info } = await loadProject("./my-agent", { strict: true });
|
|
190
|
+
expect(info.tools.map((t) => t.name)).toContain("inspect_pr");
|
|
271
191
|
```
|
|
272
192
|
|
|
273
|
-
`loadProject` throws `ProjectLoadError` when discovery reports an error
|
|
274
|
-
|
|
275
|
-
`
|
|
276
|
-
|
|
277
|
-
`serve` accepts that `Project` or a directory path.
|
|
193
|
+
`loadProject` throws `ProjectLoadError` when discovery reports an error, and
|
|
194
|
+
`{ strict: true }` makes it throw on a warning too. `error.diagnostics` lists
|
|
195
|
+
the findings, and each `path` is relative to the project directory. `serve`
|
|
196
|
+
accepts the loaded project or a directory path.
|
|
278
197
|
|
|
279
198
|
## Related
|
|
280
199
|
|
|
281
|
-
- [Instructions](./instructions.md)
|
|
282
|
-
|
|
283
|
-
- [CLI](./cli.md): the `serve` flags `serve()` accepts
|
|
284
|
-
- [Sessions](./sessions.md): workspaces, identifiers, and turn admission
|
|
285
|
-
- [Schedules](./schedules.md): reminder tools opted in here
|
|
200
|
+
- [Instructions](./instructions.md)
|
|
201
|
+
- [Sessions](./sessions.md)
|
|
@@ -5,15 +5,13 @@ description: "Declare, tag, list, stream, and download durable agent outputs."
|
|
|
5
5
|
|
|
6
6
|
# Artifacts
|
|
7
7
|
|
|
8
|
-
Artifacts are durable outputs such as reviewed pull requests
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
sessions and can be listed, streamed, or downloaded.
|
|
8
|
+
Artifacts are durable outputs such as reviewed pull requests or
|
|
9
|
+
reports. Records persist across sessions, update by key, and can be
|
|
10
|
+
listed, streamed, or downloaded.
|
|
12
11
|
|
|
13
12
|
## Artifact kinds
|
|
14
13
|
|
|
15
|
-
|
|
16
|
-
`@grok/agent-sdk/artifacts`:
|
|
14
|
+
Declare kinds in `bot/artifacts.ts`:
|
|
17
15
|
|
|
18
16
|
```ts
|
|
19
17
|
import { z } from "zod";
|
|
@@ -25,7 +23,6 @@ export default defineArtifacts({
|
|
|
25
23
|
description: "A pull request this agent reviewed.",
|
|
26
24
|
schema: z.object({ url: z.string(), verdict: z.string() }),
|
|
27
25
|
},
|
|
28
|
-
report: { description: "A generated report." },
|
|
29
26
|
},
|
|
30
27
|
agentTool: true,
|
|
31
28
|
});
|
|
@@ -33,19 +30,15 @@ export default defineArtifacts({
|
|
|
33
30
|
|
|
34
31
|
| Option | Contract |
|
|
35
32
|
| --- | --- |
|
|
36
|
-
| `kinds` |
|
|
37
|
-
| `agentTool` | Expose `tag_artifact` to the model
|
|
38
|
-
| `max` |
|
|
33
|
+
| `kinds` | Kind names, each with a non-empty `description` and optional Zod `schema` |
|
|
34
|
+
| `agentTool` | Expose `tag_artifact` to the model. Requires at least one declared kind |
|
|
35
|
+
| `max` | Retention cap, default `1000`. Only local and self-hosted servers evict, oldest-updated first |
|
|
39
36
|
|
|
40
|
-
With declared kinds, `tag` rejects any other kind
|
|
41
|
-
accepts free-form kind names and defaults an omitted kind to
|
|
42
|
-
`"artifact"`. A kind's schema validates `data`, and the parsed value is
|
|
43
|
-
stored, including schema defaults and coercions.
|
|
37
|
+
With declared kinds, `tag` rejects any other kind, and without them it accepts any kind name and defaults an omitted kind to `"artifact"`. `tag` stores `data` as the kind's schema parsed it, with defaults and coercions applied.
|
|
44
38
|
|
|
45
39
|
## Tag artifacts from host code
|
|
46
40
|
|
|
47
|
-
|
|
48
|
-
reminders receive an `ArtifactsApi` with `tag` and `list`.
|
|
41
|
+
Host code gets an `ArtifactsApi` with `tag` and `list`:
|
|
49
42
|
|
|
50
43
|
```ts
|
|
51
44
|
await ctx.artifacts.tag({
|
|
@@ -56,63 +49,46 @@ await ctx.artifacts.tag({
|
|
|
56
49
|
});
|
|
57
50
|
```
|
|
58
51
|
|
|
59
|
-
|
|
52
|
+
`tag` returns an `ArtifactRecord`.
|
|
53
|
+
|
|
54
|
+
| Field | Contract |
|
|
60
55
|
| --- | --- |
|
|
61
|
-
| `data` | Required JSON data, validated when the kind has a schema |
|
|
62
56
|
| `kind` | Declared or free-form kind |
|
|
63
|
-
| `
|
|
57
|
+
| `data` | Required JSON data, validated by the kind's schema |
|
|
58
|
+
| `key` | Optional upsert key, unique across the agent and all kinds |
|
|
64
59
|
| `title` | Optional display title |
|
|
65
|
-
| `
|
|
66
|
-
| `
|
|
67
|
-
| `
|
|
68
|
-
| `
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
60
|
+
| `sessionId`, `turnId` | Optional session or turn attribution |
|
|
61
|
+
| `source` | `"host"` or `"model"`. `tag` defaults to `"host"` |
|
|
62
|
+
| `contents` | Tag only. String or bytes served by the content route |
|
|
63
|
+
| `contentType` | Tag only. MIME type for `contents` |
|
|
64
|
+
| `id` | Record only. Stable ID derived from `key`, or a generated ID |
|
|
65
|
+
| `content` | Record only. `{ size, contentType? }` metadata |
|
|
66
|
+
| `createdAt`, `updatedAt` | Record only. ISO-8601 timestamps |
|
|
67
|
+
|
|
68
|
+
Tool, hook, and channel-event contexts are session-bound and fill
|
|
69
|
+
`sessionId` and the current `turnId`. Channel routes, channel
|
|
70
|
+
`onStart`, schedules, and reminders get an unbound API, so pass
|
|
73
71
|
`sessionId` to attribute an artifact.
|
|
74
72
|
|
|
75
|
-
Re-tagging a key without `contents` keeps its
|
|
76
|
-
`sessionId`
|
|
77
|
-
new contents removes the previous payload. `tag` returns the stored
|
|
78
|
-
`ArtifactRecord`.
|
|
79
|
-
|
|
80
|
-
| Record field | Contract |
|
|
81
|
-
| --- | --- |
|
|
82
|
-
| `id` | Stable ID derived from `key`, or a generated ID when no key is set |
|
|
83
|
-
| `kind`, `data` | Validated kind and JSON payload |
|
|
84
|
-
| `key`, `title` | Optional upsert key and display title |
|
|
85
|
-
| `content` | Optional `{ size, contentType? }` metadata |
|
|
86
|
-
| `sessionId`, `turnId` | Optional session attribution |
|
|
87
|
-
| `source` | `"host"` or `"model"` |
|
|
88
|
-
| `createdAt`, `updatedAt` | ISO-8601 timestamps |
|
|
73
|
+
Re-tagging a key without `contents` keeps its payload unless
|
|
74
|
+
`sessionId` changes.
|
|
89
75
|
|
|
90
76
|
## Expose `tag_artifact` to the model
|
|
91
77
|
|
|
92
|
-
With `agentTool: true`, the `tag_artifact`
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
An authored tool named `tag_artifact` takes precedence over the generated
|
|
98
|
-
tool.
|
|
78
|
+
With `agentTool: true`, the model gets a generated `tag_artifact` tool
|
|
79
|
+
that accepts the declared kinds and validates data with their schemas.
|
|
80
|
+
Kind descriptions tell the model what each kind is for. An authored
|
|
81
|
+
`tag_artifact` tool takes precedence.
|
|
99
82
|
|
|
100
83
|
## List artifacts
|
|
101
84
|
|
|
102
|
-
`list({ kind?, sessionId? })` returns matching records newest
|
|
103
|
-
first. HTTP callers
|
|
104
|
-
[artifact routes](./http-api.md#list-and-download-artifacts)
|
|
85
|
+
`list({ kind?, sessionId? })` returns matching records, newest update
|
|
86
|
+
first. HTTP callers use the
|
|
87
|
+
[artifact routes](./http-api.md#list-and-download-artifacts) to list
|
|
88
|
+
and download.
|
|
105
89
|
|
|
106
90
|
## Stream artifact tags
|
|
107
91
|
|
|
108
|
-
Tagging
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
event envelope.
|
|
112
|
-
|
|
113
|
-
## Related
|
|
114
|
-
|
|
115
|
-
- [Sessions](./sessions.md)
|
|
116
|
-
- [Tools](./tools.md)
|
|
117
|
-
- [Evals](./evals.md)
|
|
118
|
-
- [HTTP API](./http-api.md)
|
|
92
|
+
Tagging with a `sessionId` emits
|
|
93
|
+
[`artifact.tagged`](./sessions.md#stream-events) on that session with
|
|
94
|
+
`id`, `kind`, `key`, `title`, `data`, and `source`.
|