@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
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
# Agent config
|
|
2
2
|
|
|
3
|
-
`bot/agent.ts` default-exports `defineAgent(config)
|
|
4
|
-
the agent and
|
|
5
|
-
|
|
3
|
+
`bot/agent.ts` default-exports `defineAgent(config)`, which sets the model
|
|
4
|
+
that runs the agent and the defaults for a local run. Every field is optional on
|
|
5
|
+
the root agent.
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
import { defineAgent } from "@grok/agent-sdk";
|
|
9
9
|
|
|
10
10
|
export default defineAgent({
|
|
11
11
|
model: {
|
|
12
|
-
id: "grok-4.
|
|
12
|
+
id: "grok-4.7",
|
|
13
13
|
params: [
|
|
14
|
-
{ id: "
|
|
14
|
+
{ id: "reasoning_effort", value: "high" },
|
|
15
15
|
{ id: "fast", value: "true" },
|
|
16
16
|
],
|
|
17
17
|
}, // optional; this is the default
|
|
@@ -22,36 +22,24 @@ export default defineAgent({
|
|
|
22
22
|
|
|
23
23
|
| Field | Type | Meaning |
|
|
24
24
|
| --- | --- | --- |
|
|
25
|
-
| `model` | string or `{ id, params }` | Cursor model for turns. Defaults to `grok-4.
|
|
26
|
-
| `name` | string | Display name
|
|
27
|
-
| `description` | string | What the agent is for. Required on subagents
|
|
28
|
-
| `instructions` | string | Inline instructions
|
|
29
|
-
| `local` | `{ cwd?, workspaceDir?, sandbox? }` |
|
|
30
|
-
| `
|
|
31
|
-
| `
|
|
32
|
-
| `
|
|
33
|
-
| `
|
|
34
|
-
| `tools` | `ToolName[]` | Allowlist of built-in harness tools offered to the model. Unset = the model's full standard toolset. See [Harness tools](#harness-tools). |
|
|
25
|
+
| `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. |
|
|
26
|
+
| `name` | string | Display name. Defaults to the package or directory name. |
|
|
27
|
+
| `description` | string | What the agent is for. Required on subagents, where the parent model reads it to decide when to delegate. |
|
|
28
|
+
| `instructions` | string | Inline instructions for subagents and generated configs. Prefer `instructions.md`. |
|
|
29
|
+
| `local` | `{ cwd?, workspaceDir?, sandbox? }` | Defaults for a local run. See [Local options](#local-options). |
|
|
30
|
+
| `hosting` | `{ egressDomains?, secretNames? }` | The egress allowlist and expected secret names that `agent-sdk deploy` reads. Mounted [extensions](/docs/reference/extensions.md#build-an-extension) add their own. |
|
|
31
|
+
| `concurrency` | `{ maxRunningTurns? }` | Agent-wide limit on concurrent turns. See [Concurrency](#concurrency). |
|
|
32
|
+
| `builtinTools` | `{ reminders? }` | Opt-in tools that Agent SDK provides. See [Built-in tools](#built-in-tools). |
|
|
33
|
+
| `tools` | `ToolName[]` | Allowlist of built-in tools. Omit it for the full standard toolset. See [Harness tools](#harness-tools). |
|
|
35
34
|
| `fs` | `FileSystem` or `(ctx) => FileSystem` | Custom file tree for the session. `root` is the deprecated name. See [Custom filesystem](#custom-filesystem). |
|
|
36
35
|
| `skills` | `false` or `(ctx) => FileSystem` | Replaces the skills tree mounted at `/agent/skills`, or turns that mount off. |
|
|
37
36
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
`model` is a Cursor model id string, or `{ id, params }`. Effort and
|
|
41
|
-
speed are params, not id suffixes. Agent SDK rejects suffix-style ids
|
|
42
|
-
like `grok-4.5-fast`:
|
|
37
|
+
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.
|
|
43
38
|
|
|
44
|
-
|
|
45
|
-
model: {
|
|
46
|
-
id: "grok-4.5",
|
|
47
|
-
params: [
|
|
48
|
-
{ id: "effort", value: "high" },
|
|
49
|
-
{ id: "fast", value: "true" },
|
|
50
|
-
],
|
|
51
|
-
}
|
|
52
|
-
```
|
|
39
|
+
## Model
|
|
53
40
|
|
|
54
|
-
|
|
41
|
+
Set effort and speed with params, not in the id. Use the object form shown above
|
|
42
|
+
to set params, or a plain string when you don't need any:
|
|
55
43
|
|
|
56
44
|
```ts
|
|
57
45
|
model: "composer-2.5",
|
|
@@ -59,157 +47,91 @@ model: "composer-2.5",
|
|
|
59
47
|
|
|
60
48
|
## Local options
|
|
61
49
|
|
|
62
|
-
`local`
|
|
63
|
-
|
|
64
|
-
`
|
|
65
|
-
|
|
66
|
-
over `cwd`, and a per-send `workspaceDir` still wins over both.
|
|
67
|
-
Sessions share a working tree, so a file one turn writes is visible to
|
|
68
|
-
the next.
|
|
50
|
+
`local.workspaceDir` points every session at one shared working directory, for
|
|
51
|
+
agents that work inside an existing checkout. It takes precedence over `cwd`,
|
|
52
|
+
and a per-send `workspaceDir` wins over both. Sessions share that tree, so one
|
|
53
|
+
turn's files are visible to the next.
|
|
69
54
|
|
|
70
|
-
`local.sandbox` runs the
|
|
71
|
-
|
|
72
|
-
environment, including
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
55
|
+
`local.sandbox` runs the agent inside Cursor's local sandbox. It's off by
|
|
56
|
+
default, so shell commands auto-approve and inherit the serve process
|
|
57
|
+
environment, including the host's credentials. Turn it on when turns read
|
|
58
|
+
untrusted input, such as webhook payloads, PR diffs, or inbound chat. The
|
|
59
|
+
sandbox limits the tools themselves, so an injected prompt can't talk the model
|
|
60
|
+
past it.
|
|
76
61
|
|
|
77
62
|
Agent SDK runs the file tools (`read`, `edit`, `delete`, `grep`, `glob`, `ls`)
|
|
78
|
-
in the serve process, outside the sandbox. With `local.sandbox` on,
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
large-output files that web search and web fetch write. With
|
|
82
|
-
`local.sandbox` off, the file tools can read and write any path the serve
|
|
83
|
-
process can.
|
|
63
|
+
in the serve process, outside the sandbox. With `local.sandbox` on, they refuse
|
|
64
|
+
a path outside the session workspace with `Path is outside the workspace`. With
|
|
65
|
+
it off, they can reach any path the serve process can.
|
|
84
66
|
|
|
85
67
|
### Local cwd
|
|
86
68
|
|
|
87
|
-
`local.cwd` sets the parent directory for local
|
|
88
|
-
session uses `<cwd>/<sessionId>` unless a per-send `workspaceDir` overrides
|
|
89
|
-
it.
|
|
90
|
-
|
|
91
|
-
Session workspaces are real Cursor project directories. The harness loads
|
|
92
|
-
`AGENTS.md` and `.cursor` config from ancestor directories. An agent nested
|
|
93
|
-
in another git repo (a monorepo package) defaults to a per-project
|
|
94
|
-
cache directory under `~/.cache` when you omit `cwd`, so the enclosing checkout
|
|
95
|
-
does not leak rules, skills, or MCP servers into the turn. A standalone git
|
|
96
|
-
root keeps the in-project session workspace. Point `cwd` at a checkout only
|
|
97
|
-
when the agent should inherit that tree.
|
|
98
|
-
|
|
99
|
-
## Persistent hosting
|
|
100
|
-
|
|
101
|
-
By default, a hosted deployment starts a runtime when an event arrives
|
|
102
|
-
and stops it when the work ends. Set `persistent: true` to keep one
|
|
103
|
-
long-lived runtime for the deployment instead, with its state directory
|
|
104
|
-
on the runtime's own disk. On a redeploy, the new version starts beside
|
|
105
|
-
the old one on the same state, and the old version stops after the new
|
|
106
|
-
one takes over. Each team can have one persistent deployment. Local
|
|
107
|
-
serving ignores the flag.
|
|
108
|
-
|
|
109
|
-
```ts
|
|
110
|
-
export default defineAgent({
|
|
111
|
-
persistent: true,
|
|
112
|
-
hosting: { image: "incident-bot-base" },
|
|
113
|
-
});
|
|
114
|
-
```
|
|
69
|
+
`local.cwd` sets the parent directory for local session workspaces. Each
|
|
70
|
+
session uses `<cwd>/<sessionId>` unless a per-send `workspaceDir` overrides it.
|
|
115
71
|
|
|
116
|
-
|
|
117
|
-
`
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
72
|
+
Session workspaces are real Cursor project directories, so the local agent reads
|
|
73
|
+
`AGENTS.md` and `.cursor` config from every ancestor directory. When you omit
|
|
74
|
+
`cwd` and the agent sits inside another git repo, such as a monorepo package,
|
|
75
|
+
Agent SDK uses a per-project directory under `~/.cache` instead, so the
|
|
76
|
+
enclosing checkout's rules, skills, and MCP servers stay out of the turn. An
|
|
77
|
+
agent at its own git root keeps its workspaces inside the project. Point `cwd`
|
|
78
|
+
at a checkout only when the agent should inherit that tree.
|
|
122
79
|
|
|
123
80
|
## Custom filesystem
|
|
124
81
|
|
|
125
|
-
`fs` is mounted at
|
|
126
|
-
|
|
127
|
-
`root` is the deprecated name of `fs`. Set one of them. A tree that already
|
|
128
|
-
has `/agent/skills` fails session start unless `skills` is `false`.
|
|
129
|
-
|
|
130
|
-
Semantic search is removed. Use Grep. See
|
|
131
|
-
[Migrate off semantic search](#migrate-off-semantic-search).
|
|
82
|
+
`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`.
|
|
132
83
|
|
|
133
84
|
## Harness tools
|
|
134
85
|
|
|
135
|
-
Use `tools` to limit which built-in Cursor
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
built-in tools. New platform tools stay disabled until you add them.
|
|
86
|
+
Use `tools` to limit which built-in Cursor tools the model can call.
|
|
87
|
+
When you set it, the model gets only the tools you list. An empty list turns
|
|
88
|
+
off every built-in tool, and new platform tools stay off until you add them.
|
|
139
89
|
|
|
140
90
|
```ts
|
|
141
91
|
export default defineAgent({
|
|
142
92
|
model: "composer-2.5",
|
|
143
|
-
// Read-only triage
|
|
144
|
-
// No shell, no edits, no subagents.
|
|
93
|
+
// Read-only triage: no shell, no edits, no subagents.
|
|
145
94
|
tools: ["read", "grep", "glob", "ls"],
|
|
146
95
|
});
|
|
147
96
|
```
|
|
148
97
|
|
|
149
|
-
Agent SDK always adds `"mcp"` to a configured allowlist, because
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
servers, point `local.cwd` outside the checkout. See
|
|
154
|
-
[Local cwd](#local-cwd). `local.sandbox` makes MCP tool calls fail
|
|
155
|
-
closed.
|
|
98
|
+
Agent SDK always adds `"mcp"` to a configured allowlist, because the server
|
|
99
|
+
tools in `bot/tools/` reach the model over MCP. With `local.sandbox` on, MCP
|
|
100
|
+
tool calls fail closed. An enclosing checkout can also add MCP servers, as
|
|
101
|
+
[Local cwd](#local-cwd) explains.
|
|
156
102
|
|
|
157
|
-
Use the Cursor SDK's public tool names,
|
|
158
|
-
`"edit"`, `"grep"`, `"glob"`, `"ls"`, and `"task"`.
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
[Migrate off semantic search](#migrate-off-semantic-search).
|
|
103
|
+
Use the Cursor SDK's public tool names, such as `"shell"`, `"read"`,
|
|
104
|
+
`"edit"`, `"grep"`, `"glob"`, `"ls"`, and `"task"`. An unknown name fails the
|
|
105
|
+
turn with a `ConfigurationError`, and `"SemanticSearch"` or `"semSearch"`
|
|
106
|
+
fails validation.
|
|
162
107
|
|
|
163
108
|
Two names have broader effects:
|
|
164
109
|
|
|
165
|
-
- `"shell"` also grants shell input. Tools with
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
its own curated toolset.
|
|
110
|
+
- `"shell"` also grants shell input. Tools with `execution: "agent"` need it
|
|
111
|
+
to run their scripts, and discovery warns when your allowlist blocks them.
|
|
112
|
+
- `"task"` lets the root agent start subagents. Each subagent keeps its own
|
|
113
|
+
toolset.
|
|
170
114
|
|
|
171
|
-
The allowlist
|
|
172
|
-
|
|
173
|
-
set `local: { sandbox: true }`.
|
|
115
|
+
The allowlist doesn't isolate the serve host, so pair it with `local.sandbox`
|
|
116
|
+
for untrusted input.
|
|
174
117
|
|
|
175
118
|
## Migrate off semantic search
|
|
176
119
|
|
|
177
|
-
Semantic search is removed
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
`glob`, and `maxResults`. A `GrepResult` has `path`, `lineNumber`, and
|
|
182
|
-
`line`.
|
|
183
|
-
|
|
184
|
-
Delete imports of `SearchQuery` and `SearchResult`. `SearchQuery`
|
|
185
|
-
carried a natural-language `query`, plus optional `maxResults` and
|
|
186
|
-
`targetDirectories`. `SearchResult` carried `path`, `score`, and
|
|
187
|
-
`snippet`. Import `GrepQuery` and `GrepResult` from `@grok/agent-sdk`.
|
|
120
|
+
Semantic search is removed, and `agent-sdk validate` reports
|
|
121
|
+
`Semantic search has been removed. Use Grep.` while a project still uses it.
|
|
122
|
+
[A turn fails or misbehaves](/docs/troubleshooting.md#a-turn-fails-or-misbehaves) lists what to
|
|
123
|
+
delete and what to use instead.
|
|
188
124
|
|
|
189
|
-
|
|
190
|
-
Delete `bot/tools/SemanticSearch.ts` or `bot/tools/semSearch.ts`. In
|
|
191
|
-
`instructions.md`, tell the model to call `Grep` with `pattern`, and
|
|
192
|
-
with `path` or `glob` when the lookup should stay in one directory.
|
|
193
|
-
|
|
194
|
-
```ts
|
|
195
|
-
export default defineAgent({
|
|
196
|
-
tools: ["read", "grep"],
|
|
197
|
-
});
|
|
198
|
-
```
|
|
125
|
+
## Concurrency
|
|
199
126
|
|
|
200
|
-
`agent
|
|
201
|
-
when `tools` lists either name, or a file in `bot/tools/` uses it.
|
|
127
|
+
`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.
|
|
202
128
|
|
|
203
|
-
|
|
129
|
+
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
|
|
130
|
+
position, `GET /v1/sessions` reports `queued: true`, and the turn starts as
|
|
131
|
+
soon as a slot frees.
|
|
204
132
|
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
When every slot is busy, newly admitted turns queue FIFO instead of
|
|
208
|
-
failing: the stream records a durable `turn.queued` event with the
|
|
209
|
-
queue position, `GET /v1/sessions` reports `queued: true`, and each
|
|
210
|
-
queued turn starts as soon as a slot frees. A queued turn still counts
|
|
211
|
-
as running for busy semantics: follow-ups preempt it, and direct
|
|
212
|
-
write-effect tool calls get `409 session_busy`. Omit for unlimited.
|
|
133
|
+
A queued turn still counts as running. A follow-up preempts it, and a direct
|
|
134
|
+
write-effect tool call gets `409 session_busy`.
|
|
213
135
|
|
|
214
136
|
```ts
|
|
215
137
|
export default defineAgent({
|
|
@@ -219,15 +141,13 @@ export default defineAgent({
|
|
|
219
141
|
|
|
220
142
|
## Built-in tools
|
|
221
143
|
|
|
222
|
-
`builtinTools` opts into
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
warning, and like all server tools they run on the local runtime.
|
|
144
|
+
`builtinTools` opts into tools that Agent SDK provides. They behave like your
|
|
145
|
+
own server tools in turns, direct calls, `info`, and the playground. A tool you
|
|
146
|
+
write with the same name wins, with a warning.
|
|
226
147
|
|
|
227
|
-
`builtinTools: { reminders: true }` adds
|
|
228
|
-
current conversation
|
|
229
|
-
|
|
230
|
-
continuation key can't arm reminders. See
|
|
148
|
+
`builtinTools: { reminders: true }` adds `reminders_create`, `reminders_list`,
|
|
149
|
+
and `reminders_cancel`, bound to the current conversation. A session without a
|
|
150
|
+
continuation key can't set reminders. See
|
|
231
151
|
[Schedules and reminders](/docs/reference/schedules.md#reminders).
|
|
232
152
|
|
|
233
153
|
## Serve programmatically
|
|
@@ -245,36 +165,32 @@ console.log(`listening on ${handle.url}`);
|
|
|
245
165
|
// handle.createReminder(...), handle.agents, await handle.close()
|
|
246
166
|
```
|
|
247
167
|
|
|
248
|
-
`handle.agents` lists each mount as `slug
|
|
168
|
+
`handle.agents` lists each mount as `{ slug, url, info }`. `handle.project` is
|
|
169
|
+
deprecated.
|
|
249
170
|
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
`CURSOR_SERVICE_ACCOUNT_KEY`, or `agent-sdk login`.
|
|
171
|
+
`serve()` takes the same host settings as the [CLI](/docs/reference/cli.md) `serve` flags,
|
|
172
|
+
plus `discovery` for project-loading options and `mode: "single" | "multi"`.
|
|
173
|
+
Pass `apiKey`, or sign in the same way as the CLI, as
|
|
174
|
+
[Environment variables](/docs/reference/cli.md#environment-variables) describes.
|
|
255
175
|
|
|
256
176
|
## Inspect a project in tests
|
|
257
177
|
|
|
258
|
-
`loadProject(dir)` reads one project
|
|
178
|
+
`loadProject(dir)` reads one project without serving it. Its `info` matches the
|
|
179
|
+
`GET /v1/info` body.
|
|
259
180
|
|
|
260
181
|
```ts
|
|
261
182
|
import { loadProject } from "@grok/agent-sdk";
|
|
262
183
|
|
|
263
|
-
const
|
|
264
|
-
|
|
265
|
-
console.log(project.info.tools.map((tool) => tool.name));
|
|
184
|
+
const { info } = await loadProject("./my-agent", { strict: true });
|
|
185
|
+
expect(info.tools.map((t) => t.name)).toContain("inspect_pr");
|
|
266
186
|
```
|
|
267
187
|
|
|
268
|
-
`loadProject` throws `ProjectLoadError` when discovery reports an error
|
|
269
|
-
|
|
270
|
-
`
|
|
271
|
-
|
|
272
|
-
`serve` accepts that `Project` or a directory path.
|
|
188
|
+
`loadProject` throws `ProjectLoadError` when discovery reports an error, and
|
|
189
|
+
`{ strict: true }` makes it throw on a warning too. `error.diagnostics` lists
|
|
190
|
+
the findings, and each `path` is relative to the project directory. `serve`
|
|
191
|
+
accepts the loaded project or a directory path.
|
|
273
192
|
|
|
274
193
|
## Related
|
|
275
194
|
|
|
276
|
-
- [Instructions](/docs/reference/instructions.md)
|
|
277
|
-
|
|
278
|
-
- [CLI](/docs/reference/cli.md): the `serve` flags `serve()` accepts
|
|
279
|
-
- [Sessions](/docs/reference/sessions.md): workspaces, identifiers, and turn admission
|
|
280
|
-
- [Schedules](/docs/reference/schedules.md): reminder tools opted in here
|
|
195
|
+
- [Instructions](/docs/reference/instructions.md)
|
|
196
|
+
- [Sessions](/docs/reference/sessions.md)
|