@grok/agent-sdk 0.2.28 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (528) hide show
  1. package/AGENTS.md +29 -29
  2. package/dist/bin/agent-serve.d.ts +2 -2
  3. package/dist/bin/agent-serve.js +3 -3
  4. package/dist/channels/pagerduty/api.js +1 -1
  5. package/dist/channels/pagerduty/pagerduty-channel.d.ts +1 -1
  6. package/dist/channels/pagerduty/pagerduty-channel.d.ts.map +1 -1
  7. package/dist/channels/pagerduty/pagerduty-channel.js +1 -1
  8. package/dist/channels/pagerduty/replay.d.ts +1 -1
  9. package/dist/channels/pagerduty/replay.js +4 -4
  10. package/dist/channels/slack/cli-project.js +1 -1
  11. package/dist/docs/404.html +2 -2
  12. package/dist/docs/assets/{app.DF9vlcdn.js → app.BzTUBOAD.js} +4 -4
  13. package/dist/docs/assets/building-with-agents.md.BqJ7AAjG.js +6 -0
  14. package/dist/docs/assets/{building-with-agents.md.Bf1yH2tG.lean.js → building-with-agents.md.BqJ7AAjG.lean.js} +1 -1
  15. package/dist/docs/assets/changelog.md.BWhC6DET.js +1 -0
  16. package/dist/docs/assets/changelog.md.BWhC6DET.lean.js +1 -0
  17. package/dist/docs/assets/chunks/@localSearchIndexroot.CWxwVoCG.js +1 -0
  18. package/dist/docs/assets/chunks/{VPLocalSearchBox.D8OuwKO0.js → VPLocalSearchBox.DsnRlUT5.js} +1 -1
  19. package/dist/docs/assets/chunks/{arc.DCq_TCYV.js → arc.DH8GOhiv.js} +1 -1
  20. package/dist/docs/assets/chunks/{architectureDiagram-Q4EWVU46.PWRNTPbk.js → architectureDiagram-Q4EWVU46.9m9ObyuE.js} +1 -1
  21. package/dist/docs/assets/chunks/{baseUniq.BeRPvRUL.js → baseUniq.BXHpx1lE.js} +1 -1
  22. package/dist/docs/assets/chunks/{blockDiagram-DXYQGD6D.BuRmZVSo.js → blockDiagram-DXYQGD6D.xY3EX59q.js} +1 -1
  23. package/dist/docs/assets/chunks/{c4Diagram-AHTNJAMY.7DKSMwuv.js → c4Diagram-AHTNJAMY.DnqgMVgc.js} +1 -1
  24. package/dist/docs/assets/chunks/channel.Cctv0f7X.js +1 -0
  25. package/dist/docs/assets/chunks/{chunk-4BX2VUAB.7VrO9-9i.js → chunk-4BX2VUAB.BjFxK2A3.js} +1 -1
  26. package/dist/docs/assets/chunks/{chunk-4TB4RGXK.CHystNE2.js → chunk-4TB4RGXK.BujS_Spt.js} +1 -1
  27. package/dist/docs/assets/chunks/{chunk-55IACEB6.Nuh9TbTq.js → chunk-55IACEB6.YbTjhdaM.js} +1 -1
  28. package/dist/docs/assets/chunks/{chunk-EDXVE4YY.CA0EKugm.js → chunk-EDXVE4YY.DnQ8t4GC.js} +1 -1
  29. package/dist/docs/assets/chunks/{chunk-FMBD7UC4.F9_mp7U8.js → chunk-FMBD7UC4.B67AwAmj.js} +1 -1
  30. package/dist/docs/assets/chunks/{chunk-OYMX7WX6.CEU4QfE1.js → chunk-OYMX7WX6.DrZIAFOm.js} +1 -1
  31. package/dist/docs/assets/chunks/{chunk-QZHKN3VN.B8h_x9_i.js → chunk-QZHKN3VN.BLmmydkn.js} +1 -1
  32. package/dist/docs/assets/chunks/{chunk-YZCP3GAM.Btfb-rKg.js → chunk-YZCP3GAM.DaoOfw0O.js} +1 -1
  33. package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.DU5sqchW.js +1 -0
  34. package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.DU5sqchW.js +1 -0
  35. package/dist/docs/assets/chunks/clone.B9rdNt6j.js +1 -0
  36. package/dist/docs/assets/chunks/{cose-bilkent-S5V4N54A.DKvc96Wa.js → cose-bilkent-S5V4N54A.DMQuNhM5.js} +1 -1
  37. package/dist/docs/assets/chunks/{dagre-KV5264BT.CMo0cy1b.js → dagre-KV5264BT.CZoGVuUf.js} +1 -1
  38. package/dist/docs/assets/chunks/{diagram-5BDNPKRD.DDgMOQhB.js → diagram-5BDNPKRD.CLt9uOyL.js} +1 -1
  39. package/dist/docs/assets/chunks/{diagram-G4DWMVQ6.BdJnoIsU.js → diagram-G4DWMVQ6.DpczEm1G.js} +1 -1
  40. package/dist/docs/assets/chunks/{diagram-MMDJMWI5.oSvhAZaL.js → diagram-MMDJMWI5.D4r13DvJ.js} +1 -1
  41. package/dist/docs/assets/chunks/{diagram-TYMM5635.C9zZLIE-.js → diagram-TYMM5635.CYU9eGFu.js} +1 -1
  42. package/dist/docs/assets/chunks/{erDiagram-SMLLAGMA.BNhVyccy.js → erDiagram-SMLLAGMA.QA9naWEw.js} +1 -1
  43. package/dist/docs/assets/chunks/{flowDiagram-DWJPFMVM.BEFLLBiU.js → flowDiagram-DWJPFMVM.BbNoVZYd.js} +1 -1
  44. package/dist/docs/assets/chunks/{ganttDiagram-T4ZO3ILL.BdUzXBgY.js → ganttDiagram-T4ZO3ILL.IHjDoG7r.js} +1 -1
  45. package/dist/docs/assets/chunks/{gitGraphDiagram-UUTBAWPF.Rd3LlOIJ.js → gitGraphDiagram-UUTBAWPF.B21VMdf5.js} +1 -1
  46. package/dist/docs/assets/chunks/{graph.DnJC1GpG.js → graph.DgJ4L-8V.js} +1 -1
  47. package/dist/docs/assets/chunks/{infoDiagram-42DDH7IO.xv0xntDJ.js → infoDiagram-42DDH7IO.CQjrcthc.js} +1 -1
  48. package/dist/docs/assets/chunks/{ishikawaDiagram-UXIWVN3A.BaGIlviU.js → ishikawaDiagram-UXIWVN3A.D4tPGtVo.js} +1 -1
  49. package/dist/docs/assets/chunks/{journeyDiagram-VCZTEJTY.Cof_h0fp.js → journeyDiagram-VCZTEJTY.BD3WaNbQ.js} +1 -1
  50. package/dist/docs/assets/chunks/{kanban-definition-6JOO6SKY.C5GozFuU.js → kanban-definition-6JOO6SKY.Ca0o4Tqz.js} +1 -1
  51. package/dist/docs/assets/chunks/{layout.zc9UShLc.js → layout.DXXqX4MQ.js} +1 -1
  52. package/dist/docs/assets/chunks/{linear.BoqrFVcJ.js → linear.5c61gNw4.js} +1 -1
  53. package/dist/docs/assets/chunks/{min.DwIfr8hG.js → min.B1-NAjHX.js} +1 -1
  54. package/dist/docs/assets/chunks/{mindmap-definition-QFDTVHPH.Dkq2yTtp.js → mindmap-definition-QFDTVHPH.BELznv3-.js} +1 -1
  55. package/dist/docs/assets/chunks/{pieDiagram-DEJITSTG.B4CpTmHK.js → pieDiagram-DEJITSTG.qPzO1mq5.js} +1 -1
  56. package/dist/docs/assets/chunks/{quadrantDiagram-34T5L4WZ.BqXnFC9C.js → quadrantDiagram-34T5L4WZ.CxIvzbjX.js} +1 -1
  57. package/dist/docs/assets/chunks/{requirementDiagram-MS252O5E.DhIN2z-E.js → requirementDiagram-MS252O5E.CqA0iJx8.js} +1 -1
  58. package/dist/docs/assets/chunks/{sankeyDiagram-XADWPNL6.BhxUAmg2.js → sankeyDiagram-XADWPNL6.XRTutBnb.js} +1 -1
  59. package/dist/docs/assets/chunks/{sequenceDiagram-FGHM5R23.BqgU7HU-.js → sequenceDiagram-FGHM5R23.E--7bRLQ.js} +1 -1
  60. package/dist/docs/assets/chunks/{stateDiagram-FHFEXIEX.B1BCO18N.js → stateDiagram-FHFEXIEX.C4vGu8zq.js} +1 -1
  61. package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.ECMu2BdJ.js +1 -0
  62. package/dist/docs/assets/chunks/{theme.oV7rddEz.js → theme.DMj_7q3B.js} +2 -2
  63. package/dist/docs/assets/chunks/{timeline-definition-GMOUNBTQ.oRI8UwMC.js → timeline-definition-GMOUNBTQ.C7LgNVAL.js} +1 -1
  64. package/dist/docs/assets/chunks/{vennDiagram-DHZGUBPP.DmuWrIxN.js → vennDiagram-DHZGUBPP.HUwoZcy_.js} +1 -1
  65. package/dist/docs/assets/chunks/{wardley-RL74JXVD.CEBjM5ov.js → wardley-RL74JXVD.BxFEFYZS.js} +1 -1
  66. package/dist/docs/assets/chunks/{wardleyDiagram-NUSXRM2D.m5zsCOF9.js → wardleyDiagram-NUSXRM2D.B2pSo5rB.js} +1 -1
  67. package/dist/docs/assets/chunks/{xychartDiagram-5P7HB3ND.cPN-587n.js → xychartDiagram-5P7HB3ND.NQhMiOOL.js} +1 -1
  68. package/dist/docs/assets/deployment.md.BtqJrHhp.js +31 -0
  69. package/dist/docs/assets/{deployment.md.DDmjAVbg.lean.js → deployment.md.BtqJrHhp.lean.js} +1 -1
  70. package/dist/docs/assets/evals.md.Dne6VRmZ.js +49 -0
  71. package/dist/docs/assets/evals.md.Dne6VRmZ.lean.js +1 -0
  72. package/dist/docs/assets/{guides_agent-to-agent.md.D1D5f6Jc.js → guides_agent-to-agent.md.BcmSqL2z.js} +8 -8
  73. package/dist/docs/assets/guides_agent-to-agent.md.BcmSqL2z.lean.js +1 -0
  74. package/dist/docs/assets/{guides_bitbucket.md.DkjkBRU8.js → guides_bitbucket.md.BiA6ZMFW.js} +27 -27
  75. package/dist/docs/assets/{guides_bitbucket.md.DkjkBRU8.lean.js → guides_bitbucket.md.BiA6ZMFW.lean.js} +1 -1
  76. package/dist/docs/assets/guides_cloud-agents.md.CiXAW6on.js +9 -0
  77. package/dist/docs/assets/{guides_cloud-agents.md.Ceyjv0ul.lean.js → guides_cloud-agents.md.CiXAW6on.lean.js} +1 -1
  78. package/dist/docs/assets/guides_convert-automation.md.BvTxsJ8J.js +26 -0
  79. package/dist/docs/assets/{guides_convert-automation.md.BjraCvok.lean.js → guides_convert-automation.md.BvTxsJ8J.lean.js} +1 -1
  80. package/dist/docs/assets/{guides_github.md.CgN5sNbW.js → guides_github.md.6jiEH7dg.js} +11 -19
  81. package/dist/docs/assets/{guides_github.md.CgN5sNbW.lean.js → guides_github.md.6jiEH7dg.lean.js} +1 -1
  82. package/dist/docs/assets/{guides_gitlab.md.DCE0p7_w.js → guides_gitlab.md.DcKusOcU.js} +63 -73
  83. package/dist/docs/assets/{guides_gitlab.md.DCE0p7_w.lean.js → guides_gitlab.md.DcKusOcU.lean.js} +1 -1
  84. package/dist/docs/assets/guides_improve.md.o3WOGR7n.js +16 -0
  85. package/dist/docs/assets/{guides_improve.md.BFYtrtLE.lean.js → guides_improve.md.o3WOGR7n.lean.js} +1 -1
  86. package/dist/docs/assets/{guides_jev.md.Ccw4pedT.js → guides_jev.md.DGCzkMUN.js} +20 -60
  87. package/dist/docs/assets/{guides_jev.md.Ccw4pedT.lean.js → guides_jev.md.DGCzkMUN.lean.js} +1 -1
  88. package/dist/docs/assets/{guides_mcp-oauth.md.ekpWOZCC.js → guides_mcp-oauth.md.C-Sx_IPa.js} +3 -5
  89. package/dist/docs/assets/{guides_mcp-oauth.md.ekpWOZCC.lean.js → guides_mcp-oauth.md.C-Sx_IPa.lean.js} +1 -1
  90. package/dist/docs/assets/guides_migrate.md.BbhHYeCr.js +3 -0
  91. package/dist/docs/assets/{guides_migrate.md.RS9Eu-Xh.lean.js → guides_migrate.md.BbhHYeCr.lean.js} +1 -1
  92. package/dist/docs/assets/guides_opentelemetry.md.BRSktBHt.js +26 -0
  93. package/dist/docs/assets/guides_opentelemetry.md.BRSktBHt.lean.js +1 -0
  94. package/dist/docs/assets/guides_pagerduty.md.pMXUkZZc.js +61 -0
  95. package/dist/docs/assets/guides_pagerduty.md.pMXUkZZc.lean.js +1 -0
  96. package/dist/docs/assets/guides_slack.md.BgIGG9ur.js +82 -0
  97. package/dist/docs/assets/{guides_slack.md.BqiGSYGX.lean.js → guides_slack.md.BgIGG9ur.lean.js} +1 -1
  98. package/dist/docs/assets/{guides_webhooks.md.BJk63ZTs.js → guides_webhooks.md.B5DXt2v1.js} +7 -7
  99. package/dist/docs/assets/{guides_webhooks.md.BJk63ZTs.lean.js → guides_webhooks.md.B5DXt2v1.lean.js} +1 -1
  100. package/dist/docs/assets/hillclimbing.md.3TkdF79A.js +5 -0
  101. package/dist/docs/assets/hillclimbing.md.3TkdF79A.lean.js +1 -0
  102. package/dist/docs/assets/index.md.DRfaoRCZ.js +20 -0
  103. package/dist/docs/assets/index.md.DRfaoRCZ.lean.js +1 -0
  104. package/dist/docs/assets/quickstart.md.r-oE8nkX.js +113 -0
  105. package/dist/docs/assets/{quickstart.md.DaLk4ZIF.lean.js → quickstart.md.r-oE8nkX.lean.js} +1 -1
  106. package/dist/docs/assets/reference_access.md.C5lblfUC.js +1 -0
  107. package/dist/docs/assets/{reference_access.md.CExlH_mR.lean.js → reference_access.md.C5lblfUC.lean.js} +1 -1
  108. package/dist/docs/assets/reference_agent-config.md.C0Tp_Fk9.js +27 -0
  109. package/dist/docs/assets/{reference_agent-config.md.11E_xe--.lean.js → reference_agent-config.md.C0Tp_Fk9.lean.js} +1 -1
  110. package/dist/docs/assets/reference_artifacts.md.BJpAI7h9.js +17 -0
  111. package/dist/docs/assets/{reference_artifacts.md.C-hKR2hp.lean.js → reference_artifacts.md.BJpAI7h9.lean.js} +1 -1
  112. package/dist/docs/assets/reference_channels.md.CPWOpdsC.js +21 -0
  113. package/dist/docs/assets/{reference_channels.md.DsJfGSBJ.lean.js → reference_channels.md.CPWOpdsC.lean.js} +1 -1
  114. package/dist/docs/assets/reference_cli.md.B8GdpaRj.js +83 -0
  115. package/dist/docs/assets/reference_cli.md.B8GdpaRj.lean.js +1 -0
  116. package/dist/docs/assets/reference_connections.md.DoY4vrDH.js +54 -0
  117. package/dist/docs/assets/{reference_connections.md.BoAotr7_.lean.js → reference_connections.md.DoY4vrDH.lean.js} +1 -1
  118. package/dist/docs/assets/reference_evals.md.DgfUtfIc.js +69 -0
  119. package/dist/docs/assets/{reference_evals.md.DYKjGFi-.lean.js → reference_evals.md.DgfUtfIc.lean.js} +1 -1
  120. package/dist/docs/assets/{reference_extensions.md.pEVj72Xo.js → reference_extensions.md.DHbW6eOf.js} +6 -8
  121. package/dist/docs/assets/{reference_extensions.md.pEVj72Xo.lean.js → reference_extensions.md.DHbW6eOf.lean.js} +1 -1
  122. package/dist/docs/assets/reference_hooks.md.CSWmOwMM.js +39 -0
  123. package/dist/docs/assets/reference_hooks.md.CSWmOwMM.lean.js +1 -0
  124. package/dist/docs/assets/reference_http-api.md.C7Cb0r2J.js +7 -0
  125. package/dist/docs/assets/{reference_http-api.md._RWELr3d.lean.js → reference_http-api.md.C7Cb0r2J.lean.js} +1 -1
  126. package/dist/docs/assets/reference_instructions.md.CV6Qq0UX.js +14 -0
  127. package/dist/docs/assets/reference_instructions.md.CV6Qq0UX.lean.js +1 -0
  128. package/dist/docs/assets/reference_limits.md.CbdtFr4T.js +8 -0
  129. package/dist/docs/assets/reference_limits.md.CbdtFr4T.lean.js +1 -0
  130. package/dist/docs/assets/reference_memory.md.CdoJISM-.js +3 -0
  131. package/dist/docs/assets/{reference_memory.md.Dd7cyV9V.lean.js → reference_memory.md.CdoJISM-.lean.js} +1 -1
  132. package/dist/docs/assets/reference_playground.md.DIUsRAcy.js +1 -0
  133. package/dist/docs/assets/{reference_playground.md.CQiJk9CM.lean.js → reference_playground.md.DIUsRAcy.lean.js} +1 -1
  134. package/dist/docs/assets/reference_project-layout.md.9DiKoE16.js +26 -0
  135. package/dist/docs/assets/reference_project-layout.md.9DiKoE16.lean.js +1 -0
  136. package/dist/docs/assets/reference_schedules.md.RhQ9ZLo1.js +45 -0
  137. package/dist/docs/assets/{reference_schedules.md.RC47aFm4.lean.js → reference_schedules.md.RhQ9ZLo1.lean.js} +1 -1
  138. package/dist/docs/assets/reference_sessions.md.NXVQt9mP.js +22 -0
  139. package/dist/docs/assets/{reference_sessions.md.C7KFhWXV.lean.js → reference_sessions.md.NXVQt9mP.lean.js} +1 -1
  140. package/dist/docs/assets/{reference_skills.md.Dej2zQxi.js → reference_skills.md.DzCPNPkG.js} +4 -4
  141. package/dist/docs/assets/{reference_skills.md.Dej2zQxi.lean.js → reference_skills.md.DzCPNPkG.lean.js} +1 -1
  142. package/dist/docs/assets/reference_subagents.md.Dvpq2sUu.js +10 -0
  143. package/dist/docs/assets/{reference_subagents.md.CAhvW4yS.lean.js → reference_subagents.md.Dvpq2sUu.lean.js} +1 -1
  144. package/dist/docs/assets/reference_tools.md.B2OaR1Nb.js +62 -0
  145. package/dist/docs/assets/{reference_tools.md.DQr7Fnhu.lean.js → reference_tools.md.B2OaR1Nb.lean.js} +1 -1
  146. package/dist/docs/assets/templates_agentic-owners.md.B6ZmKAzT.js +13 -0
  147. package/dist/docs/assets/{templates_agentic-owners.md.Dh2nDSqg.lean.js → templates_agentic-owners.md.B6ZmKAzT.lean.js} +1 -1
  148. package/dist/docs/assets/templates_reviews.md.dr9Xv_KM.js +10 -0
  149. package/dist/docs/assets/templates_reviews.md.dr9Xv_KM.lean.js +1 -0
  150. package/dist/docs/assets/troubleshooting.md.DfKKvW1R.js +3 -0
  151. package/dist/docs/assets/{troubleshooting.md.AGJ3jDzj.lean.js → troubleshooting.md.DfKKvW1R.lean.js} +1 -1
  152. package/dist/docs/building-with-agents.html +41 -44
  153. package/dist/docs/building-with-agents.md +11 -104
  154. package/dist/docs/changelog.html +37 -37
  155. package/dist/docs/changelog.md +5 -145
  156. package/dist/docs/deployment.html +54 -54
  157. package/dist/docs/deployment.md +86 -265
  158. package/dist/docs/evals.html +52 -71
  159. package/dist/docs/evals.md +33 -127
  160. package/dist/docs/guides/agent-to-agent.html +43 -43
  161. package/dist/docs/guides/agent-to-agent.md +27 -64
  162. package/dist/docs/guides/bitbucket.html +62 -62
  163. package/dist/docs/guides/bitbucket.md +73 -134
  164. package/dist/docs/guides/cloud-agents.html +37 -37
  165. package/dist/docs/guides/cloud-agents.md +23 -53
  166. package/dist/docs/guides/convert-automation.html +39 -56
  167. package/dist/docs/guides/convert-automation.md +31 -115
  168. package/dist/docs/guides/github.html +46 -54
  169. package/dist/docs/guides/github.md +49 -131
  170. package/dist/docs/guides/gitlab.html +98 -108
  171. package/dist/docs/guides/gitlab.md +104 -184
  172. package/dist/docs/guides/improve.html +38 -43
  173. package/dist/docs/guides/improve.md +24 -90
  174. package/dist/docs/guides/jev.html +55 -95
  175. package/dist/docs/guides/jev.md +57 -159
  176. package/dist/docs/guides/mcp-oauth.html +38 -40
  177. package/dist/docs/guides/mcp-oauth.md +34 -69
  178. package/dist/docs/guides/migrate.html +38 -43
  179. package/dist/docs/guides/migrate.md +56 -130
  180. package/dist/docs/guides/opentelemetry.html +41 -43
  181. package/dist/docs/guides/opentelemetry.md +32 -27
  182. package/dist/docs/guides/pagerduty.html +50 -49
  183. package/dist/docs/guides/pagerduty.md +65 -199
  184. package/dist/docs/guides/slack.html +51 -57
  185. package/dist/docs/guides/slack.md +76 -205
  186. package/dist/docs/guides/webhooks.html +42 -42
  187. package/dist/docs/guides/webhooks.md +64 -146
  188. package/dist/docs/hashmap.json +1 -1
  189. package/dist/docs/hillclimbing.html +40 -42
  190. package/dist/docs/hillclimbing.md +40 -102
  191. package/dist/docs/index.html +55 -62
  192. package/dist/docs/index.md +49 -82
  193. package/dist/docs/llms-full.txt +2292 -5830
  194. package/dist/docs/llms.txt +9 -15
  195. package/dist/docs/quickstart.html +96 -153
  196. package/dist/docs/quickstart.md +93 -178
  197. package/dist/docs/reference/access.html +36 -36
  198. package/dist/docs/reference/access.md +7 -12
  199. package/dist/docs/reference/agent-config.html +43 -56
  200. package/dist/docs/reference/agent-config.md +93 -176
  201. package/dist/docs/reference/artifacts.html +38 -39
  202. package/dist/docs/reference/artifacts.md +38 -62
  203. package/dist/docs/reference/channels.html +38 -39
  204. package/dist/docs/reference/channels.md +102 -151
  205. package/dist/docs/reference/cli.html +68 -84
  206. package/dist/docs/reference/cli.md +233 -698
  207. package/dist/docs/reference/connections.html +45 -57
  208. package/dist/docs/reference/connections.md +83 -164
  209. package/dist/docs/reference/evals.html +66 -53
  210. package/dist/docs/reference/evals.md +97 -128
  211. package/dist/docs/reference/extensions.html +41 -43
  212. package/dist/docs/reference/extensions.md +37 -70
  213. package/dist/docs/reference/hooks.html +40 -52
  214. package/dist/docs/reference/hooks.md +62 -133
  215. package/dist/docs/reference/http-api.html +38 -42
  216. package/dist/docs/reference/http-api.md +66 -118
  217. package/dist/docs/reference/instructions.html +39 -39
  218. package/dist/docs/reference/instructions.md +19 -29
  219. package/dist/docs/reference/limits.html +38 -38
  220. package/dist/docs/reference/limits.md +9 -21
  221. package/dist/docs/reference/memory.html +37 -38
  222. package/dist/docs/reference/memory.md +38 -75
  223. package/dist/docs/reference/playground.html +36 -36
  224. package/dist/docs/reference/playground.md +14 -22
  225. package/dist/docs/reference/project-layout.html +49 -48
  226. package/dist/docs/reference/project-layout.md +38 -84
  227. package/dist/docs/reference/schedules.html +46 -48
  228. package/dist/docs/reference/schedules.md +59 -90
  229. package/dist/docs/reference/sessions.html +37 -37
  230. package/dist/docs/reference/sessions.md +66 -113
  231. package/dist/docs/reference/skills.html +39 -39
  232. package/dist/docs/reference/skills.md +11 -31
  233. package/dist/docs/reference/subagents.html +37 -37
  234. package/dist/docs/reference/subagents.md +17 -31
  235. package/dist/docs/reference/tools.html +47 -64
  236. package/dist/docs/reference/tools.md +48 -130
  237. package/dist/docs/templates/agentic-owners.html +38 -38
  238. package/dist/docs/templates/agentic-owners.md +50 -74
  239. package/dist/docs/templates/reviews.html +69 -0
  240. package/dist/docs/templates/reviews.md +71 -0
  241. package/dist/docs/troubleshooting.html +38 -36
  242. package/dist/docs/troubleshooting.md +48 -101
  243. package/dist/evals.d.ts +2 -2
  244. package/dist/extensions/jev/extension.d.ts +12 -2
  245. package/dist/extensions/jev/extension.d.ts.map +1 -1
  246. package/dist/extensions/jev/extension.js +4 -0
  247. package/dist/extensions/jev/lib/evaluate.d.ts +31 -4
  248. package/dist/extensions/jev/lib/evaluate.d.ts.map +1 -1
  249. package/dist/extensions/jev/lib/evaluate.js +18 -4
  250. package/dist/internal/cli/command.d.ts +1 -1
  251. package/dist/internal/cli/command.js +1 -1
  252. package/dist/internal/cli/commands/channels.js +6 -6
  253. package/dist/internal/cli/commands/develop.d.ts.map +1 -1
  254. package/dist/internal/cli/commands/develop.js +23 -14
  255. package/dist/internal/cli/commands/hosted.js +4 -4
  256. package/dist/internal/cli/commands/index.d.ts +1 -1
  257. package/dist/internal/cli/commands/index.d.ts.map +1 -1
  258. package/dist/internal/cli/commands/index.js +1 -1
  259. package/dist/internal/cli/commands/mcp.js +1 -1
  260. package/dist/internal/cli/commands/project.js +4 -4
  261. package/dist/internal/cli/commands/scaffold.d.ts.map +1 -1
  262. package/dist/internal/cli/commands/scaffold.js +9 -6
  263. package/dist/internal/cli/commands/serve.d.ts +1 -1
  264. package/dist/internal/cli/commands/serve.js +5 -5
  265. package/dist/internal/cli/commands/session.d.ts.map +1 -1
  266. package/dist/internal/cli/commands/session.js +12 -7
  267. package/dist/internal/cli/dispatch.d.ts +3 -3
  268. package/dist/internal/cli/dispatch.js +3 -3
  269. package/dist/internal/cli/errors.d.ts +1 -1
  270. package/dist/internal/cli/errors.d.ts.map +1 -1
  271. package/dist/internal/cli/errors.js +1 -1
  272. package/dist/internal/cli/flags.d.ts +2 -2
  273. package/dist/internal/cli/flags.d.ts.map +1 -1
  274. package/dist/internal/cli/flags.js +2 -2
  275. package/dist/internal/cli/help-command.d.ts +1 -1
  276. package/dist/internal/cli/help-command.js +2 -2
  277. package/dist/internal/cli/help.d.ts +7 -7
  278. package/dist/internal/cli/help.d.ts.map +1 -1
  279. package/dist/internal/cli/help.js +8 -8
  280. package/dist/internal/cli-ax.d.ts.map +1 -1
  281. package/dist/internal/cli-ax.js +3 -0
  282. package/dist/internal/cli-convert-automation.d.ts +1 -1
  283. package/dist/internal/cli-convert-automation.js +1 -1
  284. package/dist/internal/cli-deploy.js +1 -1
  285. package/dist/internal/cli-docs.js +1 -1
  286. package/dist/internal/cli-images.js +1 -1
  287. package/dist/internal/cli-migrate.d.ts +1 -1
  288. package/dist/internal/cli-migrate.js +1 -1
  289. package/dist/internal/cli-pagerduty.d.ts +1 -1
  290. package/dist/internal/cli-pagerduty.js +1 -1
  291. package/dist/internal/cli-skills.js +1 -1
  292. package/dist/internal/convert-automation/types.d.ts +1 -1
  293. package/dist/internal/convert-automation/types.js +1 -1
  294. package/dist/internal/cursor/credentials.js +1 -1
  295. package/dist/internal/deploy-client.d.ts +2 -2
  296. package/dist/internal/deploy-client.d.ts.map +1 -1
  297. package/dist/internal/deploy-manifest.d.ts +1 -0
  298. package/dist/internal/deploy-manifest.d.ts.map +1 -1
  299. package/dist/internal/deploy-manifest.js +0 -1
  300. package/dist/internal/discovery/agent-config.d.ts +2 -6
  301. package/dist/internal/discovery/agent-config.d.ts.map +1 -1
  302. package/dist/internal/discovery/agent-config.js +8 -25
  303. package/dist/internal/discovery/agent.d.ts.map +1 -1
  304. package/dist/internal/discovery/agent.js +2 -3
  305. package/dist/internal/discovery/project.d.ts.map +1 -1
  306. package/dist/internal/discovery/project.js +15 -0
  307. package/dist/internal/init-project.d.ts +7 -3
  308. package/dist/internal/init-project.d.ts.map +1 -1
  309. package/dist/internal/init-project.js +60 -12
  310. package/dist/internal/init-scaffold.d.ts +2 -1
  311. package/dist/internal/init-scaffold.d.ts.map +1 -1
  312. package/dist/internal/init-scaffold.js +20 -7
  313. package/dist/internal/peer-connections.js +1 -1
  314. package/dist/internal/reminder-runner.js +1 -1
  315. package/dist/internal/server.d.ts +1 -1
  316. package/dist/internal/session-cost.d.ts +4 -4
  317. package/dist/internal/session-cost.d.ts.map +1 -1
  318. package/dist/internal/session-cost.js +4 -4
  319. package/dist/internal/session-engine.d.ts +1 -1
  320. package/dist/internal/session-engine.js +2 -2
  321. package/dist/internal/shallow-clone.js +1 -1
  322. package/dist/playground/assets/index-D6mVn9og.js +62 -0
  323. package/dist/playground/assets/index-DlALM6gr.css +1 -0
  324. package/dist/playground/index.html +2 -2
  325. package/dist/types.d.ts +9 -22
  326. package/dist/types.d.ts.map +1 -1
  327. package/docs/README.md +49 -82
  328. package/docs/building-with-agents.md +11 -104
  329. package/docs/changelog.md +6 -146
  330. package/docs/deployment.md +86 -265
  331. package/docs/evals.md +34 -128
  332. package/docs/guides/agent-to-agent.md +27 -64
  333. package/docs/guides/bitbucket.md +73 -134
  334. package/docs/guides/cloud-agents.md +23 -53
  335. package/docs/guides/convert-automation.md +31 -115
  336. package/docs/guides/github.md +49 -131
  337. package/docs/guides/gitlab.md +104 -184
  338. package/docs/guides/improve.md +24 -90
  339. package/docs/guides/jev.md +57 -159
  340. package/docs/guides/mcp-oauth.md +34 -69
  341. package/docs/guides/migrate.md +56 -130
  342. package/docs/guides/opentelemetry.md +37 -27
  343. package/docs/guides/pagerduty.md +68 -200
  344. package/docs/guides/slack.md +76 -205
  345. package/docs/guides/webhooks.md +64 -146
  346. package/docs/hillclimbing.md +41 -103
  347. package/docs/quickstart.md +93 -178
  348. package/docs/reference/access.md +7 -12
  349. package/docs/reference/agent-config.md +93 -176
  350. package/docs/reference/artifacts.md +38 -62
  351. package/docs/reference/channels.md +102 -151
  352. package/docs/reference/cli.md +233 -698
  353. package/docs/reference/connections.md +83 -164
  354. package/docs/reference/evals.md +97 -128
  355. package/docs/reference/extensions.md +37 -70
  356. package/docs/reference/hooks.md +61 -132
  357. package/docs/reference/http-api.md +66 -118
  358. package/docs/reference/instructions.md +20 -30
  359. package/docs/reference/limits.md +10 -22
  360. package/docs/reference/memory.md +38 -75
  361. package/docs/reference/playground.md +14 -22
  362. package/docs/reference/project-layout.md +38 -84
  363. package/docs/reference/schedules.md +59 -90
  364. package/docs/reference/sessions.md +66 -113
  365. package/docs/reference/skills.md +12 -32
  366. package/docs/reference/subagents.md +17 -31
  367. package/docs/reference/tools.md +48 -130
  368. package/docs/templates/agentic-owners.md +50 -74
  369. package/docs/templates/reviews.md +76 -0
  370. package/docs/troubleshooting.md +48 -101
  371. package/package.json +3 -9
  372. package/skills/cli/SKILL.md +15 -15
  373. package/skills/create-agent/SKILL.md +20 -19
  374. package/skills/debug/SKILL.md +4 -4
  375. package/skills/deploy/SKILL.md +2 -2
  376. package/skills/evals/SKILL.md +8 -8
  377. package/skills/framework-map/SKILL.md +3 -3
  378. package/skills/github/SKILL.md +7 -7
  379. package/skills/hillclimb/SKILL.md +4 -4
  380. package/skills/mcp-auth/SKILL.md +3 -3
  381. package/skills/migrate-v2/SKILL.md +40 -41
  382. package/skills/otel/SKILL.md +2 -2
  383. package/skills/setup-slack/SKILL.md +8 -8
  384. package/templates/agentic-owners/README.md +5 -5
  385. package/templates/agentic-owners/bot/tools/record_review.ts +1 -1
  386. package/templates/agentic-owners/package.json +1 -1
  387. package/templates/agents-md/README.md +4 -4
  388. package/templates/agents-md/package.json +1 -1
  389. package/templates/code-wiki/README.md +3 -3
  390. package/templates/code-wiki/package.json +1 -1
  391. package/templates/demo/README.md +3 -3
  392. package/templates/demo/package.json +1 -1
  393. package/templates/pr-autofixer/package.json +1 -1
  394. package/templates/security-help/README.md +5 -5
  395. package/templates/security-help/package.json +1 -1
  396. package/templates/security-reviewer/README.md +3 -3
  397. package/templates/security-reviewer/package.json +1 -1
  398. package/templates/thermo-quality-review/README.md +4 -4
  399. package/templates/thermo-quality-review/package.json +1 -1
  400. package/templates/thermo-review/README.md +4 -4
  401. package/templates/thermo-review/package.json +1 -1
  402. package/templates/triage/README.md +3 -3
  403. package/templates/triage/overlays/jira/README.md +3 -3
  404. package/templates/triage/overlays/linear/README.md +3 -3
  405. package/templates/triage/package.json +1 -1
  406. package/dist/docs/assets/building-with-agents.md.Bf1yH2tG.js +0 -9
  407. package/dist/docs/assets/changelog.md.fZ-NNFeJ.js +0 -1
  408. package/dist/docs/assets/changelog.md.fZ-NNFeJ.lean.js +0 -1
  409. package/dist/docs/assets/chunks/@localSearchIndexroot.mfzjiOsL.js +0 -1
  410. package/dist/docs/assets/chunks/channel.goFR5lbe.js +0 -1
  411. package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.B2yLtFja.js +0 -1
  412. package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.B2yLtFja.js +0 -1
  413. package/dist/docs/assets/chunks/clone.CztV97Wu.js +0 -1
  414. package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.CZlVHdDZ.js +0 -1
  415. package/dist/docs/assets/deployment.md.DDmjAVbg.js +0 -31
  416. package/dist/docs/assets/evals.md.OjKb7tNA.js +0 -68
  417. package/dist/docs/assets/evals.md.OjKb7tNA.lean.js +0 -1
  418. package/dist/docs/assets/guides_agent-to-agent.md.D1D5f6Jc.lean.js +0 -1
  419. package/dist/docs/assets/guides_cloud-agents.md.Ceyjv0ul.js +0 -9
  420. package/dist/docs/assets/guides_convert-automation.md.BjraCvok.js +0 -43
  421. package/dist/docs/assets/guides_grokbot-agents.md.D0PpM_Gf.js +0 -15
  422. package/dist/docs/assets/guides_grokbot-agents.md.D0PpM_Gf.lean.js +0 -1
  423. package/dist/docs/assets/guides_hooks.md.BjeEiM7s.js +0 -54
  424. package/dist/docs/assets/guides_hooks.md.BjeEiM7s.lean.js +0 -1
  425. package/dist/docs/assets/guides_improve.md.BFYtrtLE.js +0 -21
  426. package/dist/docs/assets/guides_migrate.md.RS9Eu-Xh.js +0 -8
  427. package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.js +0 -28
  428. package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.lean.js +0 -1
  429. package/dist/docs/assets/guides_pagerduty.md.mnKXe9U0.js +0 -60
  430. package/dist/docs/assets/guides_pagerduty.md.mnKXe9U0.lean.js +0 -1
  431. package/dist/docs/assets/guides_slack.md.BqiGSYGX.js +0 -88
  432. package/dist/docs/assets/hillclimbing.md.By61f3uq.js +0 -7
  433. package/dist/docs/assets/hillclimbing.md.By61f3uq.lean.js +0 -1
  434. package/dist/docs/assets/index.md.CVRjO09Y.js +0 -27
  435. package/dist/docs/assets/index.md.CVRjO09Y.lean.js +0 -1
  436. package/dist/docs/assets/quickstart.md.DaLk4ZIF.js +0 -170
  437. package/dist/docs/assets/reference_access.md.CExlH_mR.js +0 -1
  438. package/dist/docs/assets/reference_agent-config.md.11E_xe--.js +0 -40
  439. package/dist/docs/assets/reference_artifacts.md.C-hKR2hp.js +0 -18
  440. package/dist/docs/assets/reference_channels.md.DsJfGSBJ.js +0 -22
  441. package/dist/docs/assets/reference_cli.md.DQ3dCgmk.js +0 -99
  442. package/dist/docs/assets/reference_cli.md.DQ3dCgmk.lean.js +0 -1
  443. package/dist/docs/assets/reference_connections.md.BoAotr7_.js +0 -66
  444. package/dist/docs/assets/reference_evals.md.DYKjGFi-.js +0 -56
  445. package/dist/docs/assets/reference_hooks.md.B-bwJuiG.js +0 -51
  446. package/dist/docs/assets/reference_hooks.md.B-bwJuiG.lean.js +0 -1
  447. package/dist/docs/assets/reference_http-api.md._RWELr3d.js +0 -11
  448. package/dist/docs/assets/reference_instructions.md.yL2hXLnl.js +0 -14
  449. package/dist/docs/assets/reference_instructions.md.yL2hXLnl.lean.js +0 -1
  450. package/dist/docs/assets/reference_limits.md.Da1HegjB.js +0 -8
  451. package/dist/docs/assets/reference_limits.md.Da1HegjB.lean.js +0 -1
  452. package/dist/docs/assets/reference_memory.md.Dd7cyV9V.js +0 -4
  453. package/dist/docs/assets/reference_playground.md.CQiJk9CM.js +0 -1
  454. package/dist/docs/assets/reference_project-layout.md.BamcPDUn.js +0 -25
  455. package/dist/docs/assets/reference_project-layout.md.BamcPDUn.lean.js +0 -1
  456. package/dist/docs/assets/reference_prompt.md.BMjm1Jp3.js +0 -9
  457. package/dist/docs/assets/reference_prompt.md.BMjm1Jp3.lean.js +0 -1
  458. package/dist/docs/assets/reference_schedules.md.RC47aFm4.js +0 -47
  459. package/dist/docs/assets/reference_sessions.md.C7KFhWXV.js +0 -22
  460. package/dist/docs/assets/reference_subagents.md.CAhvW4yS.js +0 -10
  461. package/dist/docs/assets/reference_tools.md.DQr7Fnhu.js +0 -79
  462. package/dist/docs/assets/templates_agentic-owners.md.Dh2nDSqg.js +0 -13
  463. package/dist/docs/assets/templates_security-reviewer.md.DnwXdnB5.js +0 -3
  464. package/dist/docs/assets/templates_security-reviewer.md.DnwXdnB5.lean.js +0 -1
  465. package/dist/docs/assets/templates_thermo-quality-review.md.MJIdHkzE.js +0 -3
  466. package/dist/docs/assets/templates_thermo-quality-review.md.MJIdHkzE.lean.js +0 -1
  467. package/dist/docs/assets/templates_thermo-review.md.DfN1OFOl.js +0 -3
  468. package/dist/docs/assets/templates_thermo-review.md.DfN1OFOl.lean.js +0 -1
  469. package/dist/docs/assets/templates_triage.md.BYWMloV4.js +0 -9
  470. package/dist/docs/assets/templates_triage.md.BYWMloV4.lean.js +0 -1
  471. package/dist/docs/assets/troubleshooting.md.AGJ3jDzj.js +0 -1
  472. package/dist/docs/guides/grokbot-agents.html +0 -74
  473. package/dist/docs/guides/grokbot-agents.md +0 -129
  474. package/dist/docs/guides/hooks.html +0 -113
  475. package/dist/docs/guides/hooks.md +0 -116
  476. package/dist/docs/reference/prompt.html +0 -68
  477. package/dist/docs/reference/prompt.md +0 -47
  478. package/dist/docs/templates/security-reviewer.html +0 -62
  479. package/dist/docs/templates/security-reviewer.md +0 -81
  480. package/dist/docs/templates/thermo-quality-review.html +0 -62
  481. package/dist/docs/templates/thermo-quality-review.md +0 -75
  482. package/dist/docs/templates/thermo-review.html +0 -62
  483. package/dist/docs/templates/thermo-review.md +0 -75
  484. package/dist/docs/templates/triage.html +0 -68
  485. package/dist/docs/templates/triage.md +0 -101
  486. package/dist/extensions/cursor-grokbot-agents/extension.d.ts +0 -71
  487. package/dist/extensions/cursor-grokbot-agents/extension.d.ts.map +0 -1
  488. package/dist/extensions/cursor-grokbot-agents/extension.js +0 -64
  489. package/dist/extensions/cursor-grokbot-agents/lib/agents.d.ts +0 -11
  490. package/dist/extensions/cursor-grokbot-agents/lib/agents.d.ts.map +0 -1
  491. package/dist/extensions/cursor-grokbot-agents/lib/agents.js +0 -31
  492. package/dist/extensions/cursor-grokbot-agents/lib/backend.d.ts +0 -56
  493. package/dist/extensions/cursor-grokbot-agents/lib/backend.d.ts.map +0 -1
  494. package/dist/extensions/cursor-grokbot-agents/lib/backend.js +0 -139
  495. package/dist/extensions/cursor-grokbot-agents/lib/contacts.d.ts +0 -28
  496. package/dist/extensions/cursor-grokbot-agents/lib/contacts.d.ts.map +0 -1
  497. package/dist/extensions/cursor-grokbot-agents/lib/contacts.js +0 -46
  498. package/dist/extensions/cursor-grokbot-agents/lib/conversation.d.ts +0 -53
  499. package/dist/extensions/cursor-grokbot-agents/lib/conversation.d.ts.map +0 -1
  500. package/dist/extensions/cursor-grokbot-agents/lib/conversation.js +0 -186
  501. package/dist/extensions/cursor-grokbot-agents/lib/inputs.d.ts +0 -4
  502. package/dist/extensions/cursor-grokbot-agents/lib/inputs.d.ts.map +0 -1
  503. package/dist/extensions/cursor-grokbot-agents/lib/inputs.js +0 -15
  504. package/dist/extensions/cursor-grokbot-agents/lib/lock.d.ts +0 -12
  505. package/dist/extensions/cursor-grokbot-agents/lib/lock.d.ts.map +0 -1
  506. package/dist/extensions/cursor-grokbot-agents/lib/lock.js +0 -24
  507. package/dist/extensions/cursor-grokbot-agents/skills/consult.md +0 -40
  508. package/dist/extensions/cursor-grokbot-agents/tools/ask.d.ts +0 -4
  509. package/dist/extensions/cursor-grokbot-agents/tools/ask.d.ts.map +0 -1
  510. package/dist/extensions/cursor-grokbot-agents/tools/ask.js +0 -26
  511. package/dist/extensions/cursor-grokbot-agents/tools/check.d.ts +0 -4
  512. package/dist/extensions/cursor-grokbot-agents/tools/check.d.ts.map +0 -1
  513. package/dist/extensions/cursor-grokbot-agents/tools/check.js +0 -21
  514. package/dist/extensions/cursor-grokbot-agents/tools/interrupt.d.ts +0 -4
  515. package/dist/extensions/cursor-grokbot-agents/tools/interrupt.d.ts.map +0 -1
  516. package/dist/extensions/cursor-grokbot-agents/tools/interrupt.js +0 -13
  517. package/dist/extensions/cursor-grokbot-agents/tools/list.d.ts +0 -4
  518. package/dist/extensions/cursor-grokbot-agents/tools/list.d.ts.map +0 -1
  519. package/dist/extensions/cursor-grokbot-agents/tools/list.js +0 -22
  520. package/dist/playground/assets/index-BMpVzZzC.css +0 -1
  521. package/dist/playground/assets/index-_3zz3yh8.js +0 -62
  522. package/docs/guides/grokbot-agents.md +0 -134
  523. package/docs/guides/hooks.md +0 -121
  524. package/docs/reference/prompt.md +0 -52
  525. package/docs/templates/security-reviewer.md +0 -86
  526. package/docs/templates/thermo-quality-review.md +0 -80
  527. package/docs/templates/thermo-review.md +0 -80
  528. package/docs/templates/triage.md +0 -106
@@ -5,9 +5,9 @@ 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)`: which model runs
9
- the agent and its local harness defaults.
10
- Everything is optional on the root agent.
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";
@@ -27,36 +27,25 @@ 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.5` with `effort=high`, `fast=true` on the root agent. Subagents omit it to inherit. |
31
- | `name` | string | Display name override. Defaults to the package name or directory name. |
32
- | `description` | string | What the agent is for. Required on subagents; the parent model reads it to decide when to delegate. Documentation-only on the root. |
33
- | `instructions` | string | Inline instructions. Prefer `instructions.md`; this exists for subagents and generated configs. |
34
- | `local` | `{ cwd?, workspaceDir?, sandbox? }` | Local harness defaults. See [Local options](#local-options). |
35
- | `persistent` | boolean | Keep one long-lived runtime for the hosted deployment. Defaults to `false`. See [Persistent hosting](#persistent-hosting). |
36
- | `hosting` | `{ egressDomains?, secretNames?, image? }` | Managed-hosting declarations read by `agent-sdk deploy`: the deployment's egress allowlist, the secret names the agent expects, and a container image for a [persistent agent](#persistent-hosting). Mounted [extensions](./extensions.md#build-an-extension) add their own. Ignored by local serving. |
37
- | `concurrency` | `{ maxRunningTurns? }` | Agent-wide concurrent turn limit. See [Concurrency](#concurrency). |
38
- | `builtinTools` | `{ reminders? }` | Framework-provided model-facing tools, opted in per capability. See [Built-in tools](#built-in-tools). |
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.5` with `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
- ## Model
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
- ```ts
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
- A plain string works when you don't need params:
46
+ Effort and speed are params, not id suffixes, so Agent SDK rejects an id like
47
+ `grok-4.5-fast`. Use the object form shown above to set params, or a plain
48
+ string when you don't need any:
60
49
 
61
50
  ```ts
62
51
  model: "composer-2.5",
@@ -64,157 +53,91 @@ model: "composer-2.5",
64
53
 
65
54
  ## Local options
66
55
 
67
- `local` sets local-harness defaults.
68
-
69
- `local.workspaceDir` points every session at one shared harness cwd,
70
- for agents that work inside an existing checkout. It takes precedence
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.
74
-
75
- `local.sandbox` runs the harness inside Cursor's local sandbox. It's
76
- off by default: shell then auto-approves and inherits the serve process
77
- environment, including any credentials the host holds. Turn it on for
78
- agents whose turns read untrusted input (webhook payloads, PR diffs,
79
- inbound chat). The boundary is in the tools, not in the prompt, so it
80
- holds when an injected prompt tells the model to ignore its instructions.
81
-
82
- BDK runs the file tools (`read`, `edit`, `delete`, `grep`, `glob`, `ls`)
83
- in the serve process, outside the sandbox. With `local.sandbox` on, these
84
- tools refuse a path outside the session workspace, after symlinks, with
85
- `Path is outside the workspace`. The read tools can also read the
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.
89
-
90
- ### Local cwd
56
+ `local.workspaceDir` points every session at one shared working directory, for
57
+ agents that work inside an existing checkout. It takes precedence over `cwd`,
58
+ and a per-send `workspaceDir` wins over both. Sessions share that tree, so one
59
+ turn's files are visible to the next.
91
60
 
92
- `local.cwd` sets the parent directory for local harness workspaces. Each
93
- session uses `<cwd>/<sessionId>` unless a per-send `workspaceDir` overrides
94
- it.
61
+ `local.sandbox` runs the agent inside Cursor's local sandbox. It's off by
62
+ default, so shell commands auto-approve and inherit the serve process
63
+ environment, including the host's credentials. Turn it on when turns read
64
+ untrusted input, such as webhook payloads, PR diffs, or inbound chat. The
65
+ sandbox limits the tools themselves, so an injected prompt can't talk the model
66
+ past it.
95
67
 
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.
68
+ Agent SDK runs the file tools (`read`, `edit`, `delete`, `grep`, `glob`, `ls`)
69
+ in the serve process, outside the sandbox. With `local.sandbox` on, they refuse
70
+ a path outside the session workspace with `Path is outside the workspace`. With
71
+ it off, they can reach any path the serve process can.
103
72
 
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.
73
+ ### Local cwd
113
74
 
114
- ```ts
115
- export default defineAgent({
116
- persistent: true,
117
- hosting: { image: "incident-bot-base" },
118
- });
119
- ```
75
+ `local.cwd` sets the parent directory for local session workspaces. Each
76
+ session uses `<cwd>/<sessionId>` unless a per-send `workspaceDir` overrides it.
120
77
 
121
- `hosting.image` names a container image that your team pushed with
122
- `agent-sdk image push`. The agent runs inside that image instead of the
123
- default Node 22 image. Only persistent agents can use it, and `deploy`
124
- rejects `hosting.image` on any other agent. A deploy pins the image it
125
- finds, so after you push a new image under the same name, deploy again
126
- to pick it up.
78
+ Session workspaces are real Cursor project directories, so the local agent reads
79
+ `AGENTS.md` and `.cursor` config from every ancestor directory. When you omit
80
+ `cwd` and the agent sits inside another git repo, such as a monorepo package,
81
+ Agent SDK uses a per-project directory under `~/.cache` instead, so the
82
+ enclosing checkout's rules, skills, and MCP servers stay out of the turn. An
83
+ agent at its own git root keeps its workspaces inside the project. Point `cwd`
84
+ at a checkout only when the agent should inherit that tree.
127
85
 
128
86
  ## Custom filesystem
129
87
 
130
- `fs` is mounted at `/`. Agent SDK mounts `/tmp` and `/agent/skills` over it.
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).
88
+ `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
89
 
138
90
  ## Harness tools
139
91
 
140
- Use `tools` to limit which built-in Cursor harness tools the model can
141
- call. Omit it to keep the standard toolset. When you set it, the model
142
- gets only the tools you list. An empty list disables all native
143
- built-in tools. New platform tools stay disabled until you add them.
92
+ Use `tools` to limit which built-in Cursor tools the model can call.
93
+ When you set it, the model gets only the tools you list. An empty list turns
94
+ off every built-in tool, and new platform tools stay off until you add them.
144
95
 
145
96
  ```ts
146
97
  export default defineAgent({
147
98
  model: "composer-2.5",
148
- // Read-only triage agent: search and read only.
149
- // No shell, no edits, no subagents.
99
+ // Read-only triage: no shell, no edits, no subagents.
150
100
  tools: ["read", "grep", "glob", "ls"],
151
101
  });
152
102
  ```
153
103
 
154
- Agent SDK always adds `"mcp"` to a configured allowlist, because
155
- authored server tools in `bot/tools/` reach the model over MCP. MCP
156
- can also expose declared connections and servers from the harness
157
- directory's ambient `.cursor` config. To exclude a checkout's MCP
158
- servers, point `local.cwd` outside the checkout. See
159
- [Local cwd](#local-cwd). `local.sandbox` makes MCP tool calls fail
160
- closed.
104
+ Agent SDK always adds `"mcp"` to a configured allowlist, because the server
105
+ tools in `bot/tools/` reach the model over MCP. With `local.sandbox` on, MCP
106
+ tool calls fail closed. An enclosing checkout can also add MCP servers, as
107
+ [Local cwd](#local-cwd) explains.
161
108
 
162
- Use the Cursor SDK's public tool names, including `"shell"`, `"read"`,
163
- `"edit"`, `"grep"`, `"glob"`, `"ls"`, and `"task"`. Unknown names
164
- fail the turn with a `ConfigurationError`. `"SemanticSearch"` and
165
- `"semSearch"` fail validation. Use `"grep"`. See
166
- [Migrate off semantic search](#migrate-off-semantic-search).
109
+ Use the Cursor SDK's public tool names, such as `"shell"`, `"read"`,
110
+ `"edit"`, `"grep"`, `"glob"`, `"ls"`, and `"task"`. An unknown name fails the
111
+ turn with a `ConfigurationError`, and `"SemanticSearch"` or `"semSearch"`
112
+ fails validation.
167
113
 
168
114
  Two names have broader effects:
169
115
 
170
- - `"shell"` also grants shell input. Tools with
171
- `execution: "agent"` need it to run their scripts. Discovery warns
172
- when your allowlist would prevent those tools from running.
173
- - `"task"` lets the root agent start subagents. Each subagent keeps
174
- its own curated toolset.
116
+ - `"shell"` also grants shell input. Tools with `execution: "agent"` need it
117
+ to run their scripts, and discovery warns when your allowlist blocks them.
118
+ - `"task"` lets the root agent start subagents. Each subagent keeps its own
119
+ toolset.
175
120
 
176
- The allowlist controls which tools the model can call. It does not
177
- isolate the serve host. For agents that process untrusted input, also
178
- set `local: { sandbox: true }`.
121
+ The allowlist doesn't isolate the serve host, so pair it with `local.sandbox`
122
+ for untrusted input.
179
123
 
180
124
  ## Migrate off semantic search
181
125
 
182
- Semantic search is removed. Use Grep.
183
-
184
- Delete `FileSystem.search` from a custom `fs`. Content search is `grep`. A
185
- `GrepQuery` has a regular expression `pattern`, and can set `path`,
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`.
126
+ Semantic search is removed, and `agent-sdk validate` reports
127
+ `Semantic search has been removed. Use Grep.` while a project still uses it.
128
+ [A turn fails or misbehaves](../troubleshooting.md#a-turn-fails-or-misbehaves) lists what to
129
+ delete and what to use instead.
193
130
 
194
- List `"grep"` in `tools`. Remove `"SemanticSearch"` and `"semSearch"`.
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
- ```
131
+ ## Concurrency
204
132
 
205
- `agent-sdk validate` reports `Semantic search has been removed. Use Grep.`
206
- when `tools` lists either name, or a file in `bot/tools/` uses it.
133
+ `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
134
 
208
- ## Concurrency
135
+ 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
136
+ position, `GET /v1/sessions` reports `queued: true`, and the turn starts as
137
+ soon as a slot frees.
209
138
 
210
- `concurrency.maxRunningTurns` caps how many model turns run at once
211
- across all of the agent's sessions (positive integer, hard cap 200).
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.
139
+ A queued turn still counts as running. A follow-up preempts it, and a direct
140
+ write-effect tool call gets `409 session_busy`.
218
141
 
219
142
  ```ts
220
143
  export default defineAgent({
@@ -224,15 +147,13 @@ export default defineAgent({
224
147
 
225
148
  ## Built-in tools
226
149
 
227
- `builtinTools` opts into framework-provided model-facing tools. Each
228
- enabled capability shows up as ordinary server tools, so turns, direct
229
- calls, `info`, and the playground treat them like authored tools. Authored tools with the same name win, with a
230
- warning, and like all server tools they run on the local runtime.
150
+ `builtinTools` opts into tools that Agent SDK provides. They behave like your
151
+ own server tools in turns, direct calls, `info`, and the playground. A tool you
152
+ write with the same name wins, with a warning.
231
153
 
232
- `builtinTools: { reminders: true }` adds three tools bound to the
233
- current conversation over `host.reminders`: `reminders_create`,
234
- `reminders_list`, and `reminders_cancel`. Sessions without a
235
- continuation key can't arm reminders. See
154
+ `builtinTools: { reminders: true }` adds `reminders_create`, `reminders_list`,
155
+ and `reminders_cancel`, bound to the current conversation. A session without a
156
+ continuation key can't set reminders. See
236
157
  [Schedules and reminders](./schedules.md#reminders).
237
158
 
238
159
  ## Serve programmatically
@@ -250,36 +171,32 @@ console.log(`listening on ${handle.url}`);
250
171
  // handle.createReminder(...), handle.agents, await handle.close()
251
172
  ```
252
173
 
253
- `handle.agents` lists each mount as `slug`, `url`, and `info`. `handle.project` is the first agent's project. It is deprecated.
174
+ `handle.agents` lists each mount as `{ slug, url, info }`. `handle.project` is
175
+ deprecated.
254
176
 
255
- Host settings match the documented [CLI](./cli.md) `serve` flags.
256
- `serve()` also accepts `discovery` (project-loading options) and
257
- `mode: "single" | "multi"`. Pass `apiKey` or use the same Cursor
258
- credential as the CLI: `CURSOR_API_KEY`, `CURSOR_API_KEY_FILE`,
259
- `CURSOR_SERVICE_ACCOUNT_KEY`, or `agent-sdk login`.
177
+ `serve()` takes the same host settings as the [CLI](./cli.md) `serve` flags,
178
+ plus `discovery` for project-loading options and `mode: "single" | "multi"`.
179
+ Pass `apiKey`, or sign in the same way as the CLI, as
180
+ [Environment variables](./cli.md#environment-variables) describes.
260
181
 
261
182
  ## Inspect a project in tests
262
183
 
263
- `loadProject(dir)` reads one project and does not serve it. The result is a `Project`. The only field is `info`. That object matches the `GET /v1/info` body for the project. `agent-sdk info --json` on a project directory prints `{ agents: [{ slug, ...info }] }`. It prints the bare object only when the single mount slug is empty.
184
+ `loadProject(dir)` reads one project without serving it. Its `info` matches the
185
+ `GET /v1/info` body.
264
186
 
265
187
  ```ts
266
188
  import { loadProject } from "@grok/agent-sdk";
267
189
 
268
- const project = await loadProject("./my-agent");
269
- console.log(project.info.name);
270
- console.log(project.info.tools.map((tool) => tool.name));
190
+ const { info } = await loadProject("./my-agent", { strict: true });
191
+ expect(info.tools.map((t) => t.name)).toContain("inspect_pr");
271
192
  ```
272
193
 
273
- `loadProject` throws `ProjectLoadError` when discovery reports an error. Pass `{ strict: true }` to throw on a warning as well. `error.diagnostics` lists the findings. Each `path` is relative to the project directory. A path outside that directory starts with `../`. `loadProject` does not take `importModule`. `serve` still accepts `discovery.importModule` for that override.
274
-
275
- `info.local` is `{ cwd }` when the project sets a cwd. The serve banner reads `agents[].info`.
276
-
277
- `serve` accepts that `Project` or a directory path.
194
+ `loadProject` throws `ProjectLoadError` when discovery reports an error, and
195
+ `{ strict: true }` makes it throw on a warning too. `error.diagnostics` lists
196
+ the findings, and each `path` is relative to the project directory. `serve`
197
+ accepts the loaded project or a directory path.
278
198
 
279
199
  ## Related
280
200
 
281
- - [Instructions](./instructions.md): the required half of a minimal
282
- agent
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
201
+ - [Instructions](./instructions.md)
202
+ - [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, reports,
9
- or decision records. An artifact kind defines the data it accepts, and
10
- the artifacts API tags or updates records by key. Records persist across
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
- Author `bot/artifacts.ts` with `defineArtifacts` from
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` | Map of accepted kind names to a non-empty `description` and optional Zod `schema` |
37
- | `agentTool` | Expose `tag_artifact` to the model; requires at least one declared kind |
38
- | `max` | Positive retention cap, default `1000`. Local and self-hosted servers evict the oldest-updated record; hosted deployments don't evict. |
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. With no registry, it
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
- Tools, hooks, channel handlers, channel `onStart`, schedules, and
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
- | Tag field | Contract |
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
- | `key` | Agent-wide upsert key; the same key updates one record across kinds |
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
- | `contents` | String or bytes served by the content route |
66
- | `contentType` | MIME type for `contents` |
67
- | `sessionId`, `turnId` | Attribute the artifact to a session or turn |
68
- | `source` | `"host"` or `"model"`; defaults to `"host"` |
69
-
70
- Tool, hook, result, and channel-event contexts are session-bound, so
71
- they fill `sessionId` and the current `turnId`. Channel routes,
72
- `onStart`, schedules, and reminders receive an unbound facade; pass
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 file or blob when the
76
- `sessionId` stays the same. Rebinding the key to another session without
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` server tool materializes from
93
- the kinds registry. Its input accepts the declared kinds and validates
94
- their data with the same schemas as host-side tagging. The kind
95
- descriptions tell the model which output each one represents.
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-updated
103
- first. HTTP callers can list records and download content through the
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 an artifact with a `sessionId` emits `artifact.tagged` on that
109
- session. Its event data contains `id`, `kind`, `key`, `title`, `data`,
110
- and `source`. See [Stream events](./sessions.md#stream-events) for the
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`.