@grok/agent-sdk 0.2.27 → 0.2.28

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 (1291) hide show
  1. package/AGENTS.md +19 -14
  2. package/CHANGELOG.md +1 -1
  3. package/README.md +15 -17
  4. package/dist/agent-v2-hosting.d.ts +13 -0
  5. package/dist/agent-v2-hosting.d.ts.map +1 -0
  6. package/dist/agent-v2-hosting.js +8 -0
  7. package/dist/artifacts.d.ts +1 -1
  8. package/dist/artifacts.js +1 -1
  9. package/dist/bin/agent-serve.d.ts +3 -15
  10. package/dist/bin/agent-serve.d.ts.map +1 -1
  11. package/dist/bin/agent-serve.js +30 -1628
  12. package/dist/channels/bitbucket/api.d.ts.map +1 -1
  13. package/dist/channels/bitbucket/api.js +3 -3
  14. package/dist/channels/bitbucket/binding.d.ts.map +1 -1
  15. package/dist/channels/bitbucket/binding.js +5 -5
  16. package/dist/channels/bitbucket/bitbucket-channel.d.ts.map +1 -1
  17. package/dist/channels/bitbucket/bitbucket-channel.js +1 -0
  18. package/dist/channels/bitbucket/bitbucket-webhook.d.ts.map +1 -1
  19. package/dist/channels/bitbucket/bitbucket-webhook.js +9 -6
  20. package/dist/channels/bitbucket/checks.d.ts.map +1 -1
  21. package/dist/channels/bitbucket/checks.js +4 -0
  22. package/dist/channels/bitbucket/events.d.ts.map +1 -1
  23. package/dist/channels/bitbucket/index.d.ts +1 -1
  24. package/dist/channels/bitbucket/index.js +1 -1
  25. package/dist/channels/bitbucket/replay.d.ts.map +1 -1
  26. package/dist/channels/bitbucket/replay.js +4 -3
  27. package/dist/channels/change-monitors/change-monitors-channel.d.ts.map +1 -1
  28. package/dist/channels/change-monitors/change-monitors-channel.js +15 -2
  29. package/dist/channels/change-monitors/claim.d.ts +5 -0
  30. package/dist/channels/change-monitors/claim.d.ts.map +1 -0
  31. package/dist/channels/change-monitors/claim.js +6 -0
  32. package/dist/channels/change-monitors/index.d.ts +1 -0
  33. package/dist/channels/change-monitors/index.d.ts.map +1 -1
  34. package/dist/channels/change-monitors/index.js +1 -0
  35. package/dist/channels/change-monitors/types.d.ts.map +1 -1
  36. package/dist/channels/deployments/deployments-channel.d.ts +1 -1
  37. package/dist/channels/deployments/deployments-channel.js +1 -1
  38. package/dist/channels/deployments/index.d.ts +1 -1
  39. package/dist/channels/deployments/index.js +1 -1
  40. package/dist/channels/deployments/types.d.ts.map +1 -1
  41. package/dist/channels/github/api.d.ts +11 -0
  42. package/dist/channels/github/api.d.ts.map +1 -1
  43. package/dist/channels/github/api.js +29 -4
  44. package/dist/channels/github/binding.d.ts +5 -3
  45. package/dist/channels/github/binding.d.ts.map +1 -1
  46. package/dist/channels/github/binding.js +16 -9
  47. package/dist/channels/github/github-channel.d.ts +7 -2
  48. package/dist/channels/github/github-channel.d.ts.map +1 -1
  49. package/dist/channels/github/github-channel.js +20 -11
  50. package/dist/channels/github/index.d.ts +1 -1
  51. package/dist/channels/github/index.js +1 -1
  52. package/dist/channels/github/progress.d.ts.map +1 -1
  53. package/dist/channels/github/progress.js +4 -0
  54. package/dist/channels/github/state.d.ts +2 -2
  55. package/dist/channels/github/state.d.ts.map +1 -1
  56. package/dist/channels/github/types.d.ts +7 -7
  57. package/dist/channels/github/types.d.ts.map +1 -1
  58. package/dist/channels/gitlab/api.d.ts +2 -2
  59. package/dist/channels/gitlab/api.d.ts.map +1 -1
  60. package/dist/channels/gitlab/api.js +25 -14
  61. package/dist/channels/gitlab/binding.d.ts.map +1 -1
  62. package/dist/channels/gitlab/binding.js +2 -3
  63. package/dist/channels/gitlab/checks.d.ts.map +1 -1
  64. package/dist/channels/gitlab/checks.js +4 -0
  65. package/dist/channels/gitlab/events.d.ts.map +1 -1
  66. package/dist/channels/gitlab/gitlab-channel.d.ts.map +1 -1
  67. package/dist/channels/gitlab/gitlab-channel.js +4 -7
  68. package/dist/channels/gitlab/gitlab-webhook.d.ts.map +1 -1
  69. package/dist/channels/gitlab/gitlab-webhook.js +11 -8
  70. package/dist/channels/gitlab/index.d.ts +1 -1
  71. package/dist/channels/gitlab/index.js +1 -1
  72. package/dist/channels/gitlab/replay.d.ts.map +1 -1
  73. package/dist/channels/gitlab/replay.js +2 -0
  74. package/dist/channels/gitlab/types.d.ts.map +1 -1
  75. package/dist/channels/issues/claim.d.ts +5 -0
  76. package/dist/channels/issues/claim.d.ts.map +1 -0
  77. package/dist/channels/issues/claim.js +6 -0
  78. package/dist/channels/issues/index.d.ts +1 -0
  79. package/dist/channels/issues/index.d.ts.map +1 -1
  80. package/dist/channels/issues/index.js +1 -0
  81. package/dist/channels/issues/issues-channel.d.ts.map +1 -1
  82. package/dist/channels/issues/issues-channel.js +16 -3
  83. package/dist/channels/issues/types.d.ts +2 -2
  84. package/dist/channels/issues/types.d.ts.map +1 -1
  85. package/dist/channels/origin/api.d.ts.map +1 -1
  86. package/dist/channels/origin/api.js +3 -3
  87. package/dist/channels/origin/index.d.ts +1 -1
  88. package/dist/channels/origin/index.js +1 -1
  89. package/dist/channels/origin/origin-channel.d.ts.map +1 -1
  90. package/dist/channels/origin/origin-channel.js +6 -6
  91. package/dist/channels/origin/origin-webhook.d.ts.map +1 -1
  92. package/dist/channels/origin/origin-webhook.js +2 -5
  93. package/dist/channels/pagerduty/api.d.ts.map +1 -1
  94. package/dist/channels/pagerduty/api.js +2 -1
  95. package/dist/channels/pagerduty/index.d.ts +1 -1
  96. package/dist/channels/pagerduty/index.js +1 -1
  97. package/dist/channels/pagerduty/pagerduty-channel.d.ts.map +1 -1
  98. package/dist/channels/pagerduty/pagerduty-channel.js +1 -0
  99. package/dist/channels/pagerduty/pagerduty-webhook.d.ts.map +1 -1
  100. package/dist/channels/pagerduty/pagerduty-webhook.js +20 -11
  101. package/dist/channels/pagerduty/payload.d.ts.map +1 -1
  102. package/dist/channels/pagerduty/payload.js +2 -3
  103. package/dist/channels/pagerduty/replay.d.ts.map +1 -1
  104. package/dist/channels/pagerduty/replay.js +4 -1
  105. package/dist/channels/pagerduty/self-user.d.ts.map +1 -1
  106. package/dist/channels/pagerduty/self-user.js +8 -9
  107. package/dist/channels/runs/runs-channel.d.ts.map +1 -1
  108. package/dist/channels/runs/runs-channel.js +8 -2
  109. package/dist/channels/runs/types.d.ts +2 -2
  110. package/dist/channels/runs/types.d.ts.map +1 -1
  111. package/dist/channels/slack/agentic-delivery.d.ts +20 -1
  112. package/dist/channels/slack/agentic-delivery.d.ts.map +1 -1
  113. package/dist/channels/slack/agentic-delivery.js +77 -12
  114. package/dist/channels/slack/agentic-signals.d.ts +2 -0
  115. package/dist/channels/slack/agentic-signals.d.ts.map +1 -1
  116. package/dist/channels/slack/agentic-signals.js +24 -7
  117. package/dist/channels/slack/api.d.ts +1 -1
  118. package/dist/channels/slack/api.d.ts.map +1 -1
  119. package/dist/channels/slack/api.js +12 -13
  120. package/dist/channels/slack/approvals.d.ts.map +1 -1
  121. package/dist/channels/slack/approvals.js +5 -4
  122. package/dist/channels/slack/attachments.d.ts.map +1 -1
  123. package/dist/channels/slack/attachments.js +34 -9
  124. package/dist/channels/slack/auth.d.ts.map +1 -1
  125. package/dist/channels/slack/auth.js +3 -1
  126. package/dist/channels/slack/bot-mentions.d.ts.map +1 -1
  127. package/dist/channels/slack/bot-mentions.js +2 -4
  128. package/dist/channels/slack/cli-project.d.ts.map +1 -1
  129. package/dist/channels/slack/cli-project.js +7 -10
  130. package/dist/channels/slack/constants.d.ts +7 -0
  131. package/dist/channels/slack/constants.d.ts.map +1 -1
  132. package/dist/channels/slack/constants.js +7 -0
  133. package/dist/channels/slack/defaults.d.ts +12 -0
  134. package/dist/channels/slack/defaults.d.ts.map +1 -1
  135. package/dist/channels/slack/defaults.js +10 -2
  136. package/dist/channels/slack/dispatch.d.ts +7 -1
  137. package/dist/channels/slack/dispatch.d.ts.map +1 -1
  138. package/dist/channels/slack/dispatch.js +88 -13
  139. package/dist/channels/slack/doctor.d.ts.map +1 -1
  140. package/dist/channels/slack/doctor.js +11 -11
  141. package/dist/channels/slack/inbound.d.ts +7 -0
  142. package/dist/channels/slack/inbound.d.ts.map +1 -1
  143. package/dist/channels/slack/inbound.js +25 -4
  144. package/dist/channels/slack/index.d.ts +2 -2
  145. package/dist/channels/slack/index.d.ts.map +1 -1
  146. package/dist/channels/slack/index.js +2 -2
  147. package/dist/channels/slack/init.d.ts +2 -0
  148. package/dist/channels/slack/init.d.ts.map +1 -1
  149. package/dist/channels/slack/init.js +10 -2
  150. package/dist/channels/slack/interactive.d.ts +6 -1
  151. package/dist/channels/slack/interactive.d.ts.map +1 -1
  152. package/dist/channels/slack/interactive.js +15 -25
  153. package/dist/channels/slack/manifest.d.ts.map +1 -1
  154. package/dist/channels/slack/manifest.js +15 -12
  155. package/dist/channels/slack/message-body.d.ts.map +1 -1
  156. package/dist/channels/slack/message-body.js +2 -4
  157. package/dist/channels/slack/nudge-carrier.d.ts.map +1 -1
  158. package/dist/channels/slack/nudge-carrier.js +27 -1
  159. package/dist/channels/slack/nudge-store.d.ts.map +1 -1
  160. package/dist/channels/slack/nudge-store.js +8 -3
  161. package/dist/channels/slack/placeholder.d.ts +3 -0
  162. package/dist/channels/slack/placeholder.d.ts.map +1 -1
  163. package/dist/channels/slack/placeholder.js +6 -5
  164. package/dist/channels/slack/recording-sink.d.ts.map +1 -1
  165. package/dist/channels/slack/recording-sink.js +4 -3
  166. package/dist/channels/slack/sender-name.d.ts.map +1 -1
  167. package/dist/channels/slack/sender-name.js +2 -3
  168. package/dist/channels/slack/slack-channel.d.ts +1 -3
  169. package/dist/channels/slack/slack-channel.d.ts.map +1 -1
  170. package/dist/channels/slack/slack-channel.js +63 -86
  171. package/dist/channels/slack/thread-context.d.ts.map +1 -1
  172. package/dist/channels/slack/thread-context.js +4 -9
  173. package/dist/channels/slack/tool-cards.d.ts.map +1 -1
  174. package/dist/channels/slack/tool-cards.js +4 -0
  175. package/dist/channels/slack/types.d.ts +19 -4
  176. package/dist/channels/slack/types.d.ts.map +1 -1
  177. package/dist/channels/slack/upload.d.ts +2 -0
  178. package/dist/channels/slack/upload.d.ts.map +1 -1
  179. package/dist/channels/slack/upload.js +49 -12
  180. package/dist/channels/slack/user-info.d.ts.map +1 -1
  181. package/dist/channels/slack/user-info.js +3 -6
  182. package/dist/channels.d.ts +11 -11
  183. package/dist/channels.d.ts.map +1 -1
  184. package/dist/channels.js +57 -30
  185. package/dist/connections.d.ts +1 -1
  186. package/dist/connections.js +1 -1
  187. package/dist/docs/404.html +4 -4
  188. package/dist/docs/architecture.svg +1 -1
  189. package/dist/docs/assets/{app.wA5xBBcd.js → app.DF9vlcdn.js} +4 -4
  190. package/dist/docs/assets/building-with-agents.md.Bf1yH2tG.js +9 -0
  191. package/dist/docs/assets/building-with-agents.md.Bf1yH2tG.lean.js +1 -0
  192. package/dist/docs/assets/changelog.md.fZ-NNFeJ.js +1 -0
  193. package/dist/docs/assets/changelog.md.fZ-NNFeJ.lean.js +1 -0
  194. package/dist/docs/assets/chunks/@localSearchIndexroot.mfzjiOsL.js +1 -0
  195. package/dist/docs/assets/chunks/{VPLocalSearchBox.C29HLCVL.js → VPLocalSearchBox.D8OuwKO0.js} +1 -1
  196. package/dist/docs/assets/chunks/{arc.BOaoYWmh.js → arc.DCq_TCYV.js} +1 -1
  197. package/dist/docs/assets/chunks/{architectureDiagram-Q4EWVU46.MfG0itQh.js → architectureDiagram-Q4EWVU46.PWRNTPbk.js} +1 -1
  198. package/dist/docs/assets/chunks/{baseUniq.CUeJciCF.js → baseUniq.BeRPvRUL.js} +1 -1
  199. package/dist/docs/assets/chunks/{blockDiagram-DXYQGD6D.BrXMZRtK.js → blockDiagram-DXYQGD6D.BuRmZVSo.js} +1 -1
  200. package/dist/docs/assets/chunks/{c4Diagram-AHTNJAMY.DfkDHeB9.js → c4Diagram-AHTNJAMY.7DKSMwuv.js} +1 -1
  201. package/dist/docs/assets/chunks/channel.goFR5lbe.js +1 -0
  202. package/dist/docs/assets/chunks/{chunk-4BX2VUAB.xKz8CiXK.js → chunk-4BX2VUAB.7VrO9-9i.js} +1 -1
  203. package/dist/docs/assets/chunks/{chunk-4TB4RGXK.kkfBh4zk.js → chunk-4TB4RGXK.CHystNE2.js} +1 -1
  204. package/dist/docs/assets/chunks/{chunk-55IACEB6.BClJGb94.js → chunk-55IACEB6.Nuh9TbTq.js} +1 -1
  205. package/dist/docs/assets/chunks/{chunk-EDXVE4YY.P9BpQ9L3.js → chunk-EDXVE4YY.CA0EKugm.js} +1 -1
  206. package/dist/docs/assets/chunks/{chunk-FMBD7UC4.R4iYi58S.js → chunk-FMBD7UC4.F9_mp7U8.js} +1 -1
  207. package/dist/docs/assets/chunks/{chunk-OYMX7WX6.Cpn8L1dw.js → chunk-OYMX7WX6.CEU4QfE1.js} +1 -1
  208. package/dist/docs/assets/chunks/{chunk-QZHKN3VN.BLftECqU.js → chunk-QZHKN3VN.B8h_x9_i.js} +1 -1
  209. package/dist/docs/assets/chunks/{chunk-YZCP3GAM.BWDV1AYt.js → chunk-YZCP3GAM.Btfb-rKg.js} +1 -1
  210. package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.B2yLtFja.js +1 -0
  211. package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.B2yLtFja.js +1 -0
  212. package/dist/docs/assets/chunks/clone.CztV97Wu.js +1 -0
  213. package/dist/docs/assets/chunks/{cose-bilkent-S5V4N54A.DGpAcJ55.js → cose-bilkent-S5V4N54A.DKvc96Wa.js} +1 -1
  214. package/dist/docs/assets/chunks/{dagre-KV5264BT.BBXxGEaD.js → dagre-KV5264BT.CMo0cy1b.js} +1 -1
  215. package/dist/docs/assets/chunks/{diagram-5BDNPKRD.EKqOwmK2.js → diagram-5BDNPKRD.DDgMOQhB.js} +1 -1
  216. package/dist/docs/assets/chunks/{diagram-G4DWMVQ6.CB8pdkoZ.js → diagram-G4DWMVQ6.BdJnoIsU.js} +1 -1
  217. package/dist/docs/assets/chunks/{diagram-MMDJMWI5.aHh4WGg9.js → diagram-MMDJMWI5.oSvhAZaL.js} +1 -1
  218. package/dist/docs/assets/chunks/{diagram-TYMM5635.YIsbRH20.js → diagram-TYMM5635.C9zZLIE-.js} +1 -1
  219. package/dist/docs/assets/chunks/{erDiagram-SMLLAGMA.B3bTCW_e.js → erDiagram-SMLLAGMA.BNhVyccy.js} +1 -1
  220. package/dist/docs/assets/chunks/{flowDiagram-DWJPFMVM.M81hXIXZ.js → flowDiagram-DWJPFMVM.BEFLLBiU.js} +1 -1
  221. package/dist/docs/assets/chunks/{ganttDiagram-T4ZO3ILL.BKg7WY--.js → ganttDiagram-T4ZO3ILL.BdUzXBgY.js} +1 -1
  222. package/dist/docs/assets/chunks/{gitGraphDiagram-UUTBAWPF.CLEMZgO3.js → gitGraphDiagram-UUTBAWPF.Rd3LlOIJ.js} +1 -1
  223. package/dist/docs/assets/chunks/{graph.DS38W_Q-.js → graph.DnJC1GpG.js} +1 -1
  224. package/dist/docs/assets/chunks/{infoDiagram-42DDH7IO.BTiWTi82.js → infoDiagram-42DDH7IO.xv0xntDJ.js} +1 -1
  225. package/dist/docs/assets/chunks/{ishikawaDiagram-UXIWVN3A.DcqY_KQL.js → ishikawaDiagram-UXIWVN3A.BaGIlviU.js} +1 -1
  226. package/dist/docs/assets/chunks/{journeyDiagram-VCZTEJTY.0lQNZ40U.js → journeyDiagram-VCZTEJTY.Cof_h0fp.js} +1 -1
  227. package/dist/docs/assets/chunks/{kanban-definition-6JOO6SKY.L5sKlf7X.js → kanban-definition-6JOO6SKY.C5GozFuU.js} +1 -1
  228. package/dist/docs/assets/chunks/{layout.7u4gFhQa.js → layout.zc9UShLc.js} +1 -1
  229. package/dist/docs/assets/chunks/{linear.D5v33SOb.js → linear.BoqrFVcJ.js} +1 -1
  230. package/dist/docs/assets/chunks/{min.Dc9uCxf9.js → min.DwIfr8hG.js} +1 -1
  231. package/dist/docs/assets/chunks/{mindmap-definition-QFDTVHPH.B56nGoB_.js → mindmap-definition-QFDTVHPH.Dkq2yTtp.js} +1 -1
  232. package/dist/docs/assets/chunks/{pieDiagram-DEJITSTG.Cba8e8lS.js → pieDiagram-DEJITSTG.B4CpTmHK.js} +1 -1
  233. package/dist/docs/assets/chunks/{quadrantDiagram-34T5L4WZ.2YjBycHF.js → quadrantDiagram-34T5L4WZ.BqXnFC9C.js} +1 -1
  234. package/dist/docs/assets/chunks/{requirementDiagram-MS252O5E.D4P5RqVI.js → requirementDiagram-MS252O5E.DhIN2z-E.js} +1 -1
  235. package/dist/docs/assets/chunks/{sankeyDiagram-XADWPNL6.C0Hn8NUm.js → sankeyDiagram-XADWPNL6.BhxUAmg2.js} +1 -1
  236. package/dist/docs/assets/chunks/{sequenceDiagram-FGHM5R23.BZm7EaoT.js → sequenceDiagram-FGHM5R23.BqgU7HU-.js} +1 -1
  237. package/dist/docs/assets/chunks/{stateDiagram-FHFEXIEX.DcR4f3X2.js → stateDiagram-FHFEXIEX.B1BCO18N.js} +1 -1
  238. package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.CZlVHdDZ.js +1 -0
  239. package/dist/docs/assets/chunks/{theme.DvfKzyXq.js → theme.oV7rddEz.js} +2 -2
  240. package/dist/docs/assets/chunks/{timeline-definition-GMOUNBTQ.CgDh96vg.js → timeline-definition-GMOUNBTQ.oRI8UwMC.js} +1 -1
  241. package/dist/docs/assets/chunks/{vennDiagram-DHZGUBPP.B4fagbC8.js → vennDiagram-DHZGUBPP.DmuWrIxN.js} +1 -1
  242. package/dist/docs/assets/chunks/{wardley-RL74JXVD.Ck68omim.js → wardley-RL74JXVD.CEBjM5ov.js} +1 -1
  243. package/dist/docs/assets/chunks/{wardleyDiagram-NUSXRM2D.DBUg0bvz.js → wardleyDiagram-NUSXRM2D.m5zsCOF9.js} +1 -1
  244. package/dist/docs/assets/chunks/{xychartDiagram-5P7HB3ND.DnKSGQE1.js → xychartDiagram-5P7HB3ND.cPN-587n.js} +1 -1
  245. package/dist/docs/assets/deployment.md.DDmjAVbg.js +31 -0
  246. package/dist/docs/assets/deployment.md.DDmjAVbg.lean.js +1 -0
  247. package/dist/docs/assets/{evals.md.CHR34K1Y.js → evals.md.OjKb7tNA.js} +9 -9
  248. package/dist/docs/assets/{guides_agent-to-agent.md.CwL5cwuE.js → guides_agent-to-agent.md.D1D5f6Jc.js} +7 -7
  249. package/dist/docs/assets/guides_agent-to-agent.md.D1D5f6Jc.lean.js +1 -0
  250. package/dist/docs/assets/{guides_bitbucket.md.CKUayYtD.js → guides_bitbucket.md.DkjkBRU8.js} +3 -3
  251. package/dist/docs/assets/guides_cloud-agents.md.Ceyjv0ul.js +9 -0
  252. package/dist/docs/assets/guides_cloud-agents.md.Ceyjv0ul.lean.js +1 -0
  253. package/dist/docs/assets/{guides_convert-automation.md.DMEX9nF-.js → guides_convert-automation.md.BjraCvok.js} +11 -11
  254. package/dist/docs/assets/guides_convert-automation.md.BjraCvok.lean.js +1 -0
  255. package/dist/docs/assets/{guides_github.md.TuNiZAOQ.js → guides_github.md.CgN5sNbW.js} +14 -14
  256. package/dist/docs/assets/{guides_github.md.TuNiZAOQ.lean.js → guides_github.md.CgN5sNbW.lean.js} +1 -1
  257. package/dist/docs/assets/{guides_gitlab.md.CtNI4fSH.js → guides_gitlab.md.DCE0p7_w.js} +3 -3
  258. package/dist/docs/assets/guides_grokbot-agents.md.D0PpM_Gf.js +15 -0
  259. package/dist/docs/assets/{guides_grokbot-agents.md.BwAykJ7U.lean.js → guides_grokbot-agents.md.D0PpM_Gf.lean.js} +1 -1
  260. package/dist/docs/assets/{guides_hooks.md.B2XfGX50.js → guides_hooks.md.BjeEiM7s.js} +4 -4
  261. package/dist/docs/assets/{guides_hooks.md.B2XfGX50.lean.js → guides_hooks.md.BjeEiM7s.lean.js} +1 -1
  262. package/dist/docs/assets/{guides_improve.md.CZKVt1cT.js → guides_improve.md.BFYtrtLE.js} +4 -4
  263. package/dist/docs/assets/{guides_improve.md.CZKVt1cT.lean.js → guides_improve.md.BFYtrtLE.lean.js} +1 -1
  264. package/dist/docs/assets/{guides_jev.md.D7XH4JH3.js → guides_jev.md.Ccw4pedT.js} +10 -10
  265. package/dist/docs/assets/{guides_mcp-oauth.md.Cxq2TxBB.js → guides_mcp-oauth.md.ekpWOZCC.js} +8 -8
  266. package/dist/docs/assets/{guides_mcp-oauth.md.Cxq2TxBB.lean.js → guides_mcp-oauth.md.ekpWOZCC.lean.js} +1 -1
  267. package/dist/docs/assets/guides_migrate.md.RS9Eu-Xh.js +8 -0
  268. package/dist/docs/assets/guides_migrate.md.RS9Eu-Xh.lean.js +1 -0
  269. package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.js +28 -0
  270. package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.lean.js +1 -0
  271. package/dist/docs/assets/{guides_pagerduty.md.BHXMcMtx.js → guides_pagerduty.md.mnKXe9U0.js} +10 -10
  272. package/dist/docs/assets/{guides_slack.md.ClIyi7FI.js → guides_slack.md.BqiGSYGX.js} +21 -8
  273. package/dist/docs/assets/{guides_slack.md.ClIyi7FI.lean.js → guides_slack.md.BqiGSYGX.lean.js} +1 -1
  274. package/dist/docs/assets/{guides_webhooks.md.Cpdc3BDX.js → guides_webhooks.md.BJk63ZTs.js} +9 -5
  275. package/dist/docs/assets/{guides_webhooks.md.Cpdc3BDX.lean.js → guides_webhooks.md.BJk63ZTs.lean.js} +1 -1
  276. package/dist/docs/assets/{hillclimbing.md.Dxvd-0gT.js → hillclimbing.md.By61f3uq.js} +2 -2
  277. package/dist/docs/assets/index.md.CVRjO09Y.js +27 -0
  278. package/dist/docs/assets/index.md.CVRjO09Y.lean.js +1 -0
  279. package/dist/docs/assets/{quickstart.md.D8JDfkKO.js → quickstart.md.DaLk4ZIF.js} +10 -10
  280. package/dist/docs/assets/quickstart.md.DaLk4ZIF.lean.js +1 -0
  281. package/dist/docs/assets/reference_access.md.CExlH_mR.js +1 -0
  282. package/dist/docs/assets/reference_access.md.CExlH_mR.lean.js +1 -0
  283. package/dist/docs/assets/{reference_agent-config.md.CZrbHOfT.js → reference_agent-config.md.11E_xe--.js} +10 -8
  284. package/dist/docs/assets/{reference_agent-config.md.CZrbHOfT.lean.js → reference_agent-config.md.11E_xe--.lean.js} +1 -1
  285. package/dist/docs/assets/{reference_artifacts.md.DLV9MZES.js → reference_artifacts.md.C-hKR2hp.js} +2 -2
  286. package/dist/docs/assets/reference_channels.md.DsJfGSBJ.js +22 -0
  287. package/dist/docs/assets/{reference_channels.md.CNNIS6K7.lean.js → reference_channels.md.DsJfGSBJ.lean.js} +1 -1
  288. package/dist/docs/assets/reference_cli.md.DQ3dCgmk.js +99 -0
  289. package/dist/docs/assets/reference_cli.md.DQ3dCgmk.lean.js +1 -0
  290. package/dist/docs/assets/{reference_connections.md.BJE2Zllp.js → reference_connections.md.BoAotr7_.js} +7 -7
  291. package/dist/docs/assets/{reference_evals.md.Ccwp4x3o.js → reference_evals.md.DYKjGFi-.js} +11 -11
  292. package/dist/docs/assets/{reference_extensions.md.DKxTuCIw.js → reference_extensions.md.pEVj72Xo.js} +9 -9
  293. package/dist/docs/assets/{reference_extensions.md.DKxTuCIw.lean.js → reference_extensions.md.pEVj72Xo.lean.js} +1 -1
  294. package/dist/docs/assets/{reference_hooks.md.CROr0QgC.js → reference_hooks.md.B-bwJuiG.js} +5 -5
  295. package/dist/docs/assets/{reference_http-api.md.Dji-DD_Z.js → reference_http-api.md._RWELr3d.js} +1 -1
  296. package/dist/docs/assets/{reference_instructions.md.BYMVxAkw.js → reference_instructions.md.yL2hXLnl.js} +1 -1
  297. package/dist/docs/assets/reference_limits.md.Da1HegjB.js +8 -0
  298. package/dist/docs/assets/reference_limits.md.Da1HegjB.lean.js +1 -0
  299. package/dist/docs/assets/reference_memory.md.Dd7cyV9V.js +4 -0
  300. package/dist/docs/assets/reference_playground.md.CQiJk9CM.js +1 -0
  301. package/dist/docs/assets/{reference_project-layout.md.mFcS8yDD.js → reference_project-layout.md.BamcPDUn.js} +4 -4
  302. package/dist/docs/assets/{reference_prompt.md.DqPh71XN.js → reference_prompt.md.BMjm1Jp3.js} +2 -2
  303. package/dist/docs/assets/{reference_schedules.md.BqWnJES4.js → reference_schedules.md.RC47aFm4.js} +4 -4
  304. package/dist/docs/assets/{reference_sessions.md.Bi6lHttM.js → reference_sessions.md.C7KFhWXV.js} +1 -1
  305. package/dist/docs/assets/{reference_skills.md.Ckddg6KX.js → reference_skills.md.Dej2zQxi.js} +2 -2
  306. package/dist/docs/assets/{reference_skills.md.Ckddg6KX.lean.js → reference_skills.md.Dej2zQxi.lean.js} +1 -1
  307. package/dist/docs/assets/{reference_subagents.md.ChNGh6HK.js → reference_subagents.md.CAhvW4yS.js} +1 -1
  308. package/dist/docs/assets/{reference_tools.md.Bo0UfT0a.js → reference_tools.md.DQr7Fnhu.js} +10 -10
  309. package/dist/docs/assets/{reference_tools.md.Bo0UfT0a.lean.js → reference_tools.md.DQr7Fnhu.lean.js} +1 -1
  310. package/dist/docs/assets/{style.B9o0luvp.css → style.DK0YX1WL.css} +1 -1
  311. package/dist/docs/assets/{templates_agentic-owners.md.CTEnR0jp.js → templates_agentic-owners.md.Dh2nDSqg.js} +4 -4
  312. package/dist/docs/assets/templates_security-reviewer.md.DnwXdnB5.js +3 -0
  313. package/dist/docs/assets/templates_thermo-quality-review.md.MJIdHkzE.js +3 -0
  314. package/dist/docs/assets/{templates_thermo-quality-review.md.B77UyTrX.lean.js → templates_thermo-quality-review.md.MJIdHkzE.lean.js} +1 -1
  315. package/dist/docs/assets/templates_thermo-review.md.DfN1OFOl.js +3 -0
  316. package/dist/docs/assets/{templates_thermo-review.md.DRJ7mC5U.lean.js → templates_thermo-review.md.DfN1OFOl.lean.js} +1 -1
  317. package/dist/docs/assets/{templates_triage.md.CNN6b0JZ.js → templates_triage.md.BYWMloV4.js} +4 -4
  318. package/dist/docs/assets/troubleshooting.md.AGJ3jDzj.js +1 -0
  319. package/dist/docs/building-with-agents.html +46 -46
  320. package/dist/docs/building-with-agents.md +15 -15
  321. package/dist/docs/changelog.html +39 -39
  322. package/dist/docs/changelog.md +47 -11
  323. package/dist/docs/deployment.html +52 -52
  324. package/dist/docs/deployment.md +110 -48
  325. package/dist/docs/evals.html +47 -47
  326. package/dist/docs/evals.md +11 -11
  327. package/dist/docs/guides/agent-to-agent.html +45 -45
  328. package/dist/docs/guides/agent-to-agent.md +7 -7
  329. package/dist/docs/guides/bitbucket.html +41 -41
  330. package/dist/docs/guides/bitbucket.md +5 -5
  331. package/dist/docs/guides/cloud-agents.html +41 -41
  332. package/dist/docs/guides/cloud-agents.md +3 -3
  333. package/dist/docs/guides/convert-automation.html +49 -49
  334. package/dist/docs/guides/convert-automation.md +16 -15
  335. package/dist/docs/guides/github.html +50 -50
  336. package/dist/docs/guides/github.md +16 -16
  337. package/dist/docs/guides/gitlab.html +41 -41
  338. package/dist/docs/guides/gitlab.md +5 -5
  339. package/dist/docs/guides/grokbot-agents.html +40 -40
  340. package/dist/docs/guides/grokbot-agents.md +8 -14
  341. package/dist/docs/guides/hooks.html +40 -40
  342. package/dist/docs/guides/hooks.md +3 -3
  343. package/dist/docs/guides/improve.html +40 -40
  344. package/dist/docs/guides/improve.md +2 -2
  345. package/dist/docs/guides/jev.html +48 -48
  346. package/dist/docs/guides/jev.md +10 -10
  347. package/dist/docs/guides/mcp-oauth.html +45 -45
  348. package/dist/docs/guides/mcp-oauth.md +8 -8
  349. package/dist/docs/guides/migrate.html +43 -42
  350. package/dist/docs/guides/migrate.md +34 -27
  351. package/dist/docs/guides/opentelemetry.html +50 -59
  352. package/dist/docs/guides/opentelemetry.md +61 -130
  353. package/dist/docs/guides/pagerduty.html +48 -48
  354. package/dist/docs/guides/pagerduty.md +18 -18
  355. package/dist/docs/guides/slack.html +58 -45
  356. package/dist/docs/guides/slack.md +82 -11
  357. package/dist/docs/guides/webhooks.html +46 -42
  358. package/dist/docs/guides/webhooks.md +61 -3
  359. package/dist/docs/hashmap.json +1 -1
  360. package/dist/docs/hillclimbing.html +39 -39
  361. package/dist/docs/hillclimbing.md +2 -2
  362. package/dist/docs/index.html +42 -42
  363. package/dist/docs/index.md +14 -15
  364. package/dist/docs/llms-full.txt +1238 -1243
  365. package/dist/docs/llms.txt +13 -13
  366. package/dist/docs/quickstart.html +48 -48
  367. package/dist/docs/quickstart.md +20 -20
  368. package/dist/docs/reference/access.html +60 -0
  369. package/dist/docs/reference/access.md +22 -0
  370. package/dist/docs/reference/agent-config.html +46 -44
  371. package/dist/docs/reference/agent-config.md +54 -12
  372. package/dist/docs/reference/artifacts.html +39 -39
  373. package/dist/docs/reference/artifacts.md +2 -2
  374. package/dist/docs/reference/channels.html +39 -39
  375. package/dist/docs/reference/channels.md +29 -9
  376. package/dist/docs/reference/cli.html +96 -100
  377. package/dist/docs/reference/cli.md +363 -366
  378. package/dist/docs/reference/connections.html +44 -44
  379. package/dist/docs/reference/connections.md +9 -9
  380. package/dist/docs/reference/evals.html +48 -48
  381. package/dist/docs/reference/evals.md +13 -13
  382. package/dist/docs/reference/extensions.html +46 -46
  383. package/dist/docs/reference/extensions.md +10 -10
  384. package/dist/docs/reference/hooks.html +42 -42
  385. package/dist/docs/reference/hooks.md +11 -11
  386. package/dist/docs/reference/http-api.html +39 -39
  387. package/dist/docs/reference/http-api.md +1 -1
  388. package/dist/docs/reference/instructions.html +39 -39
  389. package/dist/docs/reference/instructions.md +1 -1
  390. package/dist/docs/reference/limits.html +67 -0
  391. package/dist/docs/reference/limits.md +37 -0
  392. package/dist/docs/reference/memory.html +40 -40
  393. package/dist/docs/reference/memory.md +7 -7
  394. package/dist/docs/reference/playground.html +38 -38
  395. package/dist/docs/reference/playground.md +1 -1
  396. package/dist/docs/reference/project-layout.html +41 -41
  397. package/dist/docs/reference/project-layout.md +6 -6
  398. package/dist/docs/reference/prompt.html +39 -39
  399. package/dist/docs/reference/prompt.md +2 -2
  400. package/dist/docs/reference/schedules.html +42 -42
  401. package/dist/docs/reference/schedules.md +4 -4
  402. package/dist/docs/reference/sessions.html +39 -39
  403. package/dist/docs/reference/sessions.md +3 -3
  404. package/dist/docs/reference/skills.html +39 -39
  405. package/dist/docs/reference/skills.md +2 -2
  406. package/dist/docs/reference/subagents.html +39 -39
  407. package/dist/docs/reference/subagents.md +1 -1
  408. package/dist/docs/reference/tools.html +47 -47
  409. package/dist/docs/reference/tools.md +31 -21
  410. package/dist/docs/templates/agentic-owners.html +41 -41
  411. package/dist/docs/templates/agentic-owners.md +7 -7
  412. package/dist/docs/templates/security-reviewer.html +39 -39
  413. package/dist/docs/templates/security-reviewer.md +6 -6
  414. package/dist/docs/templates/thermo-quality-review.html +40 -40
  415. package/dist/docs/templates/thermo-quality-review.md +7 -7
  416. package/dist/docs/templates/thermo-review.html +40 -40
  417. package/dist/docs/templates/thermo-review.md +7 -7
  418. package/dist/docs/templates/triage.html +41 -41
  419. package/dist/docs/templates/triage.md +9 -9
  420. package/dist/docs/troubleshooting.html +38 -38
  421. package/dist/docs/troubleshooting.md +24 -22
  422. package/dist/evals/assertions.d.ts.map +1 -1
  423. package/dist/evals/assertions.js +2 -2
  424. package/dist/evals/expect.d.ts.map +1 -1
  425. package/dist/evals/expect.js +9 -1
  426. package/dist/evals/judge.js +2 -2
  427. package/dist/evals/loaders.d.ts +3 -3
  428. package/dist/evals/loaders.d.ts.map +1 -1
  429. package/dist/evals/loaders.js +6 -3
  430. package/dist/evals/matchers.d.ts +1 -1
  431. package/dist/evals/matchers.d.ts.map +1 -1
  432. package/dist/evals/matchers.js +40 -6
  433. package/dist/evals/reporters.d.ts +2 -2
  434. package/dist/evals/reporters.js +2 -2
  435. package/dist/evals/results.d.ts +1 -1
  436. package/dist/evals/results.js +1 -1
  437. package/dist/evals.d.ts +1 -1
  438. package/dist/evals.js +1 -1
  439. package/dist/executors.d.ts +1 -1
  440. package/dist/executors.d.ts.map +1 -1
  441. package/dist/executors.js +2 -2
  442. package/dist/extensions/cursor-cloud-agents/extension.d.ts +1 -1
  443. package/dist/extensions/cursor-cloud-agents/extension.js +1 -1
  444. package/dist/extensions/cursor-cloud-agents/lib/backend.d.ts.map +1 -1
  445. package/dist/extensions/cursor-cloud-agents/lib/backend.js +13 -2
  446. package/dist/extensions/cursor-cloud-agents/reminders/cloud-agent-stop-watch.js +3 -3
  447. package/dist/extensions/cursor-grokbot-agents/extension.d.ts +7 -13
  448. package/dist/extensions/cursor-grokbot-agents/extension.d.ts.map +1 -1
  449. package/dist/extensions/cursor-grokbot-agents/extension.js +7 -13
  450. package/dist/extensions/cursor-grokbot-agents/lib/backend.d.ts +6 -6
  451. package/dist/extensions/cursor-grokbot-agents/lib/backend.d.ts.map +1 -1
  452. package/dist/extensions/cursor-grokbot-agents/lib/backend.js +8 -7
  453. package/dist/extensions/cursor-grokbot-agents/lib/conversation.d.ts +6 -6
  454. package/dist/extensions/cursor-grokbot-agents/lib/conversation.js +6 -6
  455. package/dist/extensions/improve/extension.d.ts +1 -1
  456. package/dist/extensions/improve/extension.js +1 -1
  457. package/dist/extensions/jev/extension.d.ts +1 -1
  458. package/dist/extensions/jev/extension.js +1 -1
  459. package/dist/extensions/jev/lib/evaluate.d.ts +2 -2
  460. package/dist/extensions/jev/lib/evaluate.d.ts.map +1 -1
  461. package/dist/extensions/jev/lib/evaluate.js +26 -7
  462. package/dist/extensions/jev/skills/gated-write.md +1 -1
  463. package/dist/extensions/slack-communication/extension.d.ts +1 -1
  464. package/dist/extensions/slack-communication/extension.js +1 -1
  465. package/dist/extensions/slack-communication/skills/slack-voice.js +1 -1
  466. package/dist/extensions/slack-communication/tools/post-file.d.ts.map +1 -1
  467. package/dist/extensions/slack-communication/tools/post-file.js +45 -2
  468. package/dist/extensions.d.ts +2 -2
  469. package/dist/extensions.d.ts.map +1 -1
  470. package/dist/extensions.js +7 -3
  471. package/dist/files-backends/cursor-hosted.d.ts.map +1 -1
  472. package/dist/files-backends/cursor-hosted.js +5 -0
  473. package/dist/files-backends/local-fs.d.ts.map +1 -1
  474. package/dist/files-backends/local-fs.js +4 -3
  475. package/dist/filesystem.d.ts +24 -54
  476. package/dist/filesystem.d.ts.map +1 -1
  477. package/dist/filesystem.js +172 -104
  478. package/dist/hooks.d.ts +1 -1
  479. package/dist/hooks.js +1 -1
  480. package/dist/index.d.ts +11 -4
  481. package/dist/index.d.ts.map +1 -1
  482. package/dist/index.js +10 -3
  483. package/dist/internal/advertise-tools.d.ts +3 -3
  484. package/dist/internal/advertise-tools.d.ts.map +1 -1
  485. package/dist/internal/advertise-tools.js +9 -5
  486. package/dist/internal/artifacts-store.d.ts.map +1 -1
  487. package/dist/internal/artifacts-store.js +15 -6
  488. package/dist/internal/as-of.d.ts.map +1 -1
  489. package/dist/internal/as-of.js +4 -3
  490. package/dist/internal/authored-alias-hooks.d.ts +1 -20
  491. package/dist/internal/authored-alias-hooks.d.ts.map +1 -1
  492. package/dist/internal/authored-alias-hooks.js +54 -7
  493. package/dist/internal/authored-loaders.d.ts +2 -2
  494. package/dist/internal/authored-loaders.d.ts.map +1 -1
  495. package/dist/internal/authored-loaders.js +38 -13
  496. package/dist/internal/brand.d.ts.map +1 -1
  497. package/dist/internal/brand.js +25 -2
  498. package/dist/internal/builtin-tools/artifacts.d.ts.map +1 -1
  499. package/dist/internal/builtin-tools/artifacts.js +19 -3
  500. package/dist/internal/channel-dispatch.d.ts.map +1 -1
  501. package/dist/internal/channel-dispatch.js +1 -1
  502. package/dist/internal/channel-state.d.ts.map +1 -1
  503. package/dist/internal/channel-state.js +13 -8
  504. package/dist/internal/chat-client.d.ts.map +1 -1
  505. package/dist/internal/chat-client.js +14 -5
  506. package/dist/internal/cli/command.d.ts +134 -0
  507. package/dist/internal/cli/command.d.ts.map +1 -0
  508. package/dist/internal/cli/command.js +54 -0
  509. package/dist/internal/cli/commands/channels.d.ts +26 -0
  510. package/dist/internal/cli/commands/channels.d.ts.map +1 -0
  511. package/dist/internal/cli/commands/channels.js +524 -0
  512. package/dist/internal/cli/commands/develop.d.ts +15 -0
  513. package/dist/internal/cli/commands/develop.d.ts.map +1 -0
  514. package/dist/internal/cli/commands/develop.js +568 -0
  515. package/dist/internal/cli/commands/hosted.d.ts +22 -0
  516. package/dist/internal/cli/commands/hosted.d.ts.map +1 -0
  517. package/dist/internal/cli/commands/hosted.js +407 -0
  518. package/dist/internal/cli/commands/index.d.ts +4 -0
  519. package/dist/internal/cli/commands/index.d.ts.map +1 -0
  520. package/dist/internal/cli/commands/index.js +84 -0
  521. package/dist/internal/cli/commands/mcp.d.ts +6 -0
  522. package/dist/internal/cli/commands/mcp.d.ts.map +1 -0
  523. package/dist/internal/cli/commands/mcp.js +89 -0
  524. package/dist/internal/cli/commands/project.d.ts +5 -0
  525. package/dist/internal/cli/commands/project.d.ts.map +1 -0
  526. package/dist/internal/cli/commands/project.js +136 -0
  527. package/dist/internal/cli/commands/scaffold.d.ts +12 -0
  528. package/dist/internal/cli/commands/scaffold.d.ts.map +1 -0
  529. package/dist/internal/cli/commands/scaffold.js +279 -0
  530. package/dist/internal/cli/commands/serve.d.ts +11 -0
  531. package/dist/internal/cli/commands/serve.d.ts.map +1 -0
  532. package/dist/internal/cli/commands/serve.js +370 -0
  533. package/dist/internal/cli/commands/session.d.ts +7 -0
  534. package/dist/internal/cli/commands/session.d.ts.map +1 -0
  535. package/dist/internal/cli/commands/session.js +354 -0
  536. package/dist/internal/cli/dispatch.d.ts +46 -0
  537. package/dist/internal/cli/dispatch.d.ts.map +1 -0
  538. package/dist/internal/cli/dispatch.js +385 -0
  539. package/dist/internal/cli/errors.d.ts +51 -0
  540. package/dist/internal/cli/errors.d.ts.map +1 -0
  541. package/dist/internal/cli/errors.js +142 -0
  542. package/dist/internal/cli/flags.d.ts +186 -0
  543. package/dist/internal/cli/flags.d.ts.map +1 -0
  544. package/dist/internal/cli/flags.js +167 -0
  545. package/dist/internal/cli/help-command.d.ts +7 -0
  546. package/dist/internal/cli/help-command.d.ts.map +1 -0
  547. package/dist/internal/cli/help-command.js +60 -0
  548. package/dist/internal/cli/help.d.ts +63 -0
  549. package/dist/internal/cli/help.d.ts.map +1 -0
  550. package/dist/internal/cli/help.js +203 -0
  551. package/dist/internal/cli/io.d.ts +11 -0
  552. package/dist/internal/cli/io.d.ts.map +1 -0
  553. package/dist/internal/cli/io.js +33 -0
  554. package/dist/internal/cli/output.d.ts +54 -0
  555. package/dist/internal/cli/output.d.ts.map +1 -0
  556. package/dist/internal/cli/output.js +132 -0
  557. package/dist/internal/cli/value-kinds.d.ts +20 -0
  558. package/dist/internal/cli/value-kinds.d.ts.map +1 -0
  559. package/dist/internal/cli/value-kinds.js +70 -0
  560. package/dist/internal/cli-ax.d.ts +35 -20
  561. package/dist/internal/cli-ax.d.ts.map +1 -1
  562. package/dist/internal/cli-ax.js +436 -365
  563. package/dist/internal/cli-convert-automation.d.ts +3 -1
  564. package/dist/internal/cli-convert-automation.d.ts.map +1 -1
  565. package/dist/internal/cli-convert-automation.js +52 -20
  566. package/dist/internal/cli-cursor.js +5 -1
  567. package/dist/internal/cli-deploy.d.ts +23 -9
  568. package/dist/internal/cli-deploy.d.ts.map +1 -1
  569. package/dist/internal/cli-deploy.js +234 -508
  570. package/dist/internal/cli-docs.d.ts +1 -1
  571. package/dist/internal/cli-docs.js +3 -2
  572. package/dist/internal/cli-github.js +1 -0
  573. package/dist/internal/cli-images.d.ts.map +1 -1
  574. package/dist/internal/cli-images.js +44 -14
  575. package/dist/internal/cli-invocation.d.ts +22 -0
  576. package/dist/internal/cli-invocation.d.ts.map +1 -0
  577. package/dist/internal/cli-invocation.js +86 -0
  578. package/dist/internal/cli-manifest.d.ts +4 -1
  579. package/dist/internal/cli-manifest.d.ts.map +1 -1
  580. package/dist/internal/cli-manifest.js +16 -4
  581. package/dist/internal/cli-mcp-oauth.d.ts +7 -11
  582. package/dist/internal/cli-mcp-oauth.d.ts.map +1 -1
  583. package/dist/internal/cli-mcp-oauth.js +24 -104
  584. package/dist/internal/cli-mcp.d.ts +17 -28
  585. package/dist/internal/cli-mcp.d.ts.map +1 -1
  586. package/dist/internal/cli-mcp.js +64 -304
  587. package/dist/internal/cli-migrate.d.ts +2 -0
  588. package/dist/internal/cli-migrate.d.ts.map +1 -1
  589. package/dist/internal/cli-migrate.js +42 -14
  590. package/dist/internal/cli-skills.d.ts +30 -2
  591. package/dist/internal/cli-skills.d.ts.map +1 -1
  592. package/dist/internal/cli-skills.js +63 -3
  593. package/dist/internal/cli-slack-context.d.ts +91 -0
  594. package/dist/internal/cli-slack-context.d.ts.map +1 -0
  595. package/dist/internal/cli-slack-context.js +112 -0
  596. package/dist/internal/cli-slack-manual.d.ts +2 -0
  597. package/dist/internal/cli-slack-manual.d.ts.map +1 -1
  598. package/dist/internal/cli-slack-manual.js +12 -0
  599. package/dist/internal/cli-slack.d.ts +1 -49
  600. package/dist/internal/cli-slack.d.ts.map +1 -1
  601. package/dist/internal/cli-slack.js +27 -147
  602. package/dist/internal/cloud-merge.d.ts +2 -4
  603. package/dist/internal/cloud-merge.d.ts.map +1 -1
  604. package/dist/internal/cloud-merge.js +2 -7
  605. package/dist/internal/continuation-channel.d.ts.map +1 -1
  606. package/dist/internal/continuation-channel.js +10 -22
  607. package/dist/internal/continuation-identity.d.ts +33 -12
  608. package/dist/internal/continuation-identity.d.ts.map +1 -1
  609. package/dist/internal/continuation-identity.js +161 -43
  610. package/dist/internal/continuation-registration.d.ts +26 -0
  611. package/dist/internal/continuation-registration.d.ts.map +1 -0
  612. package/dist/internal/continuation-registration.js +35 -0
  613. package/dist/internal/conversation-mirror.d.ts.map +1 -1
  614. package/dist/internal/conversation-mirror.js +23 -14
  615. package/dist/internal/convert-automation/convert-workflow.d.ts.map +1 -1
  616. package/dist/internal/convert-automation/convert-workflow.js +28 -22
  617. package/dist/internal/convert-automation/types.d.ts +1 -1
  618. package/dist/internal/convert-automation/types.js +1 -1
  619. package/dist/internal/cursor/account-mcp.js +1 -1
  620. package/dist/internal/cursor/backend-client.d.ts.map +1 -1
  621. package/dist/internal/cursor/backend-client.js +6 -8
  622. package/dist/internal/cursor/bound-secret-file.d.ts.map +1 -1
  623. package/dist/internal/cursor/bound-secret-file.js +2 -1
  624. package/dist/internal/cursor/credentials.d.ts +4 -17
  625. package/dist/internal/cursor/credentials.d.ts.map +1 -1
  626. package/dist/internal/cursor/credentials.js +11 -27
  627. package/dist/internal/cursor/session-token.d.ts.map +1 -1
  628. package/dist/internal/cursor/session-token.js +3 -4
  629. package/dist/internal/cursor/store-api-client.d.ts.map +1 -1
  630. package/dist/internal/cursor/store-api-client.js +3 -2
  631. package/dist/internal/cursor-agent-template.d.ts +1 -1
  632. package/dist/internal/cursor-agent-template.d.ts.map +1 -1
  633. package/dist/internal/cursor-agent-template.js +2 -2
  634. package/dist/internal/cursor-deployment-relay.d.ts.map +1 -1
  635. package/dist/internal/cursor-deployment-relay.js +24 -2
  636. package/dist/internal/cursor-event-relay.d.ts.map +1 -1
  637. package/dist/internal/cursor-event-relay.js +26 -2
  638. package/dist/internal/cursor-relay-core.d.ts.map +1 -1
  639. package/dist/internal/cursor-relay-core.js +22 -3
  640. package/dist/internal/deploy-client.d.ts +102 -92
  641. package/dist/internal/deploy-client.d.ts.map +1 -1
  642. package/dist/internal/deploy-client.js +143 -178
  643. package/dist/internal/deploy-manifest.d.ts +2 -2
  644. package/dist/internal/deploy-manifest.d.ts.map +1 -1
  645. package/dist/internal/deploy-manifest.js +6 -6
  646. package/dist/internal/describe-error.d.ts +4 -0
  647. package/dist/internal/describe-error.d.ts.map +1 -1
  648. package/dist/internal/describe-error.js +20 -0
  649. package/dist/internal/discovery/agent-config.d.ts +1 -5
  650. package/dist/internal/discovery/agent-config.d.ts.map +1 -1
  651. package/dist/internal/discovery/agent-config.js +5 -11
  652. package/dist/internal/discovery/agent.d.ts.map +1 -1
  653. package/dist/internal/discovery/agent.js +24 -30
  654. package/dist/internal/discovery/channels.d.ts.map +1 -1
  655. package/dist/internal/discovery/channels.js +2 -0
  656. package/dist/internal/discovery/connections.d.ts.map +1 -1
  657. package/dist/internal/discovery/connections.js +6 -4
  658. package/dist/internal/discovery/context.d.ts.map +1 -1
  659. package/dist/internal/discovery/context.js +6 -1
  660. package/dist/internal/discovery/extension-overlay.d.ts +1 -1
  661. package/dist/internal/discovery/extension-overlay.d.ts.map +1 -1
  662. package/dist/internal/discovery/extension-overlay.js +1 -0
  663. package/dist/internal/discovery/extensions.d.ts.map +1 -1
  664. package/dist/internal/discovery/extensions.js +12 -5
  665. package/dist/internal/discovery/fs.d.ts.map +1 -1
  666. package/dist/internal/discovery/fs.js +2 -1
  667. package/dist/internal/discovery/hooks.d.ts.map +1 -1
  668. package/dist/internal/discovery/hooks.js +1 -0
  669. package/dist/internal/discovery/info.d.ts.map +1 -1
  670. package/dist/internal/discovery/info.js +0 -3
  671. package/dist/internal/discovery/instructions.d.ts.map +1 -1
  672. package/dist/internal/discovery/instructions.js +4 -1
  673. package/dist/internal/discovery/instrumentation.js +1 -1
  674. package/dist/internal/discovery/modules.d.ts.map +1 -1
  675. package/dist/internal/discovery/modules.js +4 -1
  676. package/dist/internal/discovery/project.js +1 -1
  677. package/dist/internal/discovery/reminders.d.ts.map +1 -1
  678. package/dist/internal/discovery/reminders.js +1 -0
  679. package/dist/internal/discovery/runtime.d.ts +0 -16
  680. package/dist/internal/discovery/runtime.d.ts.map +1 -1
  681. package/dist/internal/discovery/runtime.js +2 -47
  682. package/dist/internal/discovery/schedules.d.ts.map +1 -1
  683. package/dist/internal/discovery/schedules.js +1 -0
  684. package/dist/internal/discovery/services.d.ts.map +1 -1
  685. package/dist/internal/discovery/services.js +3 -1
  686. package/dist/internal/discovery/skills.d.ts.map +1 -1
  687. package/dist/internal/discovery/skills.js +1 -0
  688. package/dist/internal/discovery/tools.d.ts +1 -1
  689. package/dist/internal/discovery/tools.d.ts.map +1 -1
  690. package/dist/internal/discovery/tools.js +3 -1
  691. package/dist/internal/discovery.d.ts +1 -1
  692. package/dist/internal/discovery.d.ts.map +1 -1
  693. package/dist/internal/discovery.js +1 -1
  694. package/dist/internal/distribution.d.ts +9 -14
  695. package/dist/internal/distribution.d.ts.map +1 -1
  696. package/dist/internal/distribution.js +54 -18
  697. package/dist/internal/docs-site.d.ts.map +1 -1
  698. package/dist/internal/docs-site.js +15 -2
  699. package/dist/internal/dry-run.d.ts +32 -0
  700. package/dist/internal/dry-run.d.ts.map +1 -0
  701. package/dist/internal/dry-run.js +62 -0
  702. package/dist/internal/duration.d.ts.map +1 -1
  703. package/dist/internal/duration.js +1 -0
  704. package/dist/internal/estimate-cost.d.ts.map +1 -1
  705. package/dist/internal/estimate-cost.js +12 -5
  706. package/dist/internal/eval-run-store.d.ts.map +1 -1
  707. package/dist/internal/eval-run-store.js +6 -5
  708. package/dist/internal/eval-runner.d.ts +0 -2
  709. package/dist/internal/eval-runner.d.ts.map +1 -1
  710. package/dist/internal/eval-runner.js +3 -3
  711. package/dist/internal/evals-client.d.ts.map +1 -1
  712. package/dist/internal/evals-client.js +60 -15
  713. package/dist/internal/event-log.d.ts.map +1 -1
  714. package/dist/internal/event-log.js +3 -11
  715. package/dist/internal/event-mapper.d.ts.map +1 -1
  716. package/dist/internal/event-mapper.js +33 -15
  717. package/dist/internal/expected-delivery-failure.d.ts.map +1 -1
  718. package/dist/internal/expected-delivery-failure.js +5 -4
  719. package/dist/internal/fetch-text.d.ts +8 -0
  720. package/dist/internal/fetch-text.d.ts.map +1 -0
  721. package/dist/internal/fetch-text.js +32 -0
  722. package/dist/internal/filesystem/errors.d.ts.map +1 -1
  723. package/dist/internal/filesystem/errors.js +8 -0
  724. package/dist/internal/filesystem/scratch.js +1 -4
  725. package/dist/internal/filesystem/sdk-schemas.d.ts +19 -19
  726. package/dist/internal/filesystem/sdk-schemas.d.ts.map +1 -1
  727. package/dist/internal/filesystem/sdk-schemas.js +15 -21
  728. package/dist/internal/filesystem/tools.d.ts +15 -4
  729. package/dist/internal/filesystem/tools.d.ts.map +1 -1
  730. package/dist/internal/filesystem/tools.js +33 -47
  731. package/dist/internal/filesystem/walk.d.ts.map +1 -1
  732. package/dist/internal/filesystem/walk.js +4 -0
  733. package/dist/internal/framework-file-storage.d.ts.map +1 -1
  734. package/dist/internal/framework-file-storage.js +2 -1
  735. package/dist/internal/frontmatter.d.ts.map +1 -1
  736. package/dist/internal/frontmatter.js +5 -1
  737. package/dist/internal/github-fanout.js +2 -1
  738. package/dist/internal/guest-network.d.ts.map +1 -1
  739. package/dist/internal/guest-network.js +6 -0
  740. package/dist/internal/handleAgentServeTrigger.d.ts +8 -0
  741. package/dist/internal/handleAgentServeTrigger.d.ts.map +1 -1
  742. package/dist/internal/handleAgentServeTrigger.js +27 -1
  743. package/dist/internal/host-kv.d.ts.map +1 -1
  744. package/dist/internal/host-kv.js +4 -2
  745. package/dist/internal/host-otel.d.ts.map +1 -1
  746. package/dist/internal/host-otel.js +2 -8
  747. package/dist/internal/host-platforms.d.ts.map +1 -1
  748. package/dist/internal/host-platforms.js +17 -10
  749. package/dist/internal/hosted-catch-protocol.d.ts.map +1 -1
  750. package/dist/internal/hosted-catch-protocol.js +26 -9
  751. package/dist/internal/hosted-catch.d.ts +13 -10
  752. package/dist/internal/hosted-catch.d.ts.map +1 -1
  753. package/dist/internal/hosted-catch.js +23 -11
  754. package/dist/internal/hosted-delivery-protocol.d.ts +1 -1
  755. package/dist/internal/hosted-delivery-protocol.d.ts.map +1 -1
  756. package/dist/internal/hosted-delivery-protocol.js +75 -45
  757. package/dist/internal/hosted-delivery.d.ts +1 -2
  758. package/dist/internal/hosted-delivery.d.ts.map +1 -1
  759. package/dist/internal/hosted-delivery.js +27 -32
  760. package/dist/internal/hosted-execution-diag.d.ts.map +1 -1
  761. package/dist/internal/hosted-execution-diag.js +11 -13
  762. package/dist/internal/hosted-execution-flush.js +1 -1
  763. package/dist/internal/hosted-execution-latency.d.ts.map +1 -1
  764. package/dist/internal/hosted-execution-latency.js +12 -1
  765. package/dist/internal/hosted-hints.d.ts +16 -0
  766. package/dist/internal/hosted-hints.d.ts.map +1 -0
  767. package/dist/internal/hosted-hints.js +23 -0
  768. package/dist/internal/hosted-managed-automation.d.ts.map +1 -1
  769. package/dist/internal/hosted-managed-automation.js +1 -0
  770. package/dist/internal/hosted-session-fixture.d.ts +26 -0
  771. package/dist/internal/hosted-session-fixture.d.ts.map +1 -0
  772. package/dist/internal/hosted-session-fixture.js +34 -0
  773. package/dist/internal/hosted-session-view.d.ts +48 -0
  774. package/dist/internal/hosted-session-view.d.ts.map +1 -0
  775. package/dist/internal/hosted-session-view.js +305 -0
  776. package/dist/internal/http-channel.d.ts.map +1 -1
  777. package/dist/internal/http-channel.js +8 -5
  778. package/dist/internal/http-control-plane-session.d.ts.map +1 -1
  779. package/dist/internal/http-control-plane-session.js +8 -9
  780. package/dist/internal/init-interview.js +2 -2
  781. package/dist/internal/init-project.d.ts +7 -13
  782. package/dist/internal/init-project.d.ts.map +1 -1
  783. package/dist/internal/init-project.js +10 -20
  784. package/dist/internal/init-scaffold.js +2 -2
  785. package/dist/internal/inline-stdio-define-stub.d.ts +1 -1
  786. package/dist/internal/inline-stdio-define-stub.d.ts.map +1 -1
  787. package/dist/internal/inline-stdio-define-stub.js +1 -1
  788. package/dist/internal/inline-stdio-mcp.d.ts.map +1 -1
  789. package/dist/internal/inline-stdio-mcp.js +31 -8
  790. package/dist/internal/install-cursor-skills.d.ts +22 -15
  791. package/dist/internal/install-cursor-skills.d.ts.map +1 -1
  792. package/dist/internal/install-cursor-skills.js +66 -31
  793. package/dist/internal/interview/agent-questions.d.ts.map +1 -1
  794. package/dist/internal/interview/agent-questions.js +4 -1
  795. package/dist/internal/interview/question.d.ts +1 -1
  796. package/dist/internal/interview/question.js +1 -1
  797. package/dist/internal/json-schema.d.ts +3 -2
  798. package/dist/internal/json-schema.d.ts.map +1 -1
  799. package/dist/internal/json-schema.js +83 -3
  800. package/dist/internal/json-value.d.ts +20 -0
  801. package/dist/internal/json-value.d.ts.map +1 -0
  802. package/dist/internal/json-value.js +56 -0
  803. package/dist/internal/logs-client.d.ts +4 -25
  804. package/dist/internal/logs-client.d.ts.map +1 -1
  805. package/dist/internal/logs-client.js +17 -174
  806. package/dist/internal/mcp-endpoint.d.ts +1 -1
  807. package/dist/internal/mcp-endpoint.js +2 -1
  808. package/dist/internal/mcp-host.d.ts.map +1 -1
  809. package/dist/internal/mcp-host.js +22 -9
  810. package/dist/internal/mcp-oauth.d.ts +2 -2
  811. package/dist/internal/mcp-oauth.d.ts.map +1 -1
  812. package/dist/internal/mcp-oauth.js +61 -8
  813. package/dist/internal/named-webhook-secret.d.ts +12 -0
  814. package/dist/internal/named-webhook-secret.d.ts.map +1 -1
  815. package/dist/internal/named-webhook-secret.js +18 -0
  816. package/dist/internal/otel/bind-telemetry.d.ts +26 -0
  817. package/dist/internal/otel/bind-telemetry.d.ts.map +1 -0
  818. package/dist/internal/otel/bind-telemetry.js +36 -0
  819. package/dist/internal/otel/collector.d.ts.map +1 -1
  820. package/dist/internal/otel/collector.js +94 -42
  821. package/dist/internal/otel/config.d.ts.map +1 -1
  822. package/dist/internal/otel/config.js +4 -3
  823. package/dist/internal/otel/conversation-span-processor.d.ts.map +1 -1
  824. package/dist/internal/otel/conversation-span-processor.js +5 -2
  825. package/dist/internal/otel/customer.d.ts +1 -5
  826. package/dist/internal/otel/customer.d.ts.map +1 -1
  827. package/dist/internal/otel/customer.js +35 -13
  828. package/dist/internal/otel/http.d.ts +1 -1
  829. package/dist/internal/otel/http.d.ts.map +1 -1
  830. package/dist/internal/otel/http.js +5 -3
  831. package/dist/internal/otel/propagation.d.ts +3 -2
  832. package/dist/internal/otel/propagation.d.ts.map +1 -1
  833. package/dist/internal/otel/propagation.js +3 -2
  834. package/dist/internal/otel/reserved-attributes.d.ts +8 -0
  835. package/dist/internal/otel/reserved-attributes.d.ts.map +1 -0
  836. package/dist/internal/otel/reserved-attributes.js +24 -0
  837. package/dist/internal/otel/runtime.d.ts.map +1 -1
  838. package/dist/internal/otel/runtime.js +9 -2
  839. package/dist/internal/otel/session-telemetry.d.ts +22 -0
  840. package/dist/internal/otel/session-telemetry.d.ts.map +1 -0
  841. package/dist/internal/otel/session-telemetry.js +30 -0
  842. package/dist/internal/otel/telemetry-attributes.d.ts +7 -0
  843. package/dist/internal/otel/telemetry-attributes.d.ts.map +1 -0
  844. package/dist/internal/otel/telemetry-attributes.js +35 -0
  845. package/dist/internal/otel/telemetry-processor.d.ts +7 -0
  846. package/dist/internal/otel/telemetry-processor.d.ts.map +1 -0
  847. package/dist/internal/otel/telemetry-processor.js +47 -0
  848. package/dist/internal/otel/tool-error-class.d.ts.map +1 -1
  849. package/dist/internal/otel/tool-error-class.js +4 -0
  850. package/dist/internal/package-inline-stdio.d.ts.map +1 -1
  851. package/dist/internal/package-inline-stdio.js +2 -2
  852. package/dist/internal/persistent-stage-log-mirror.js +2 -5
  853. package/dist/internal/platform-timers.d.ts.map +1 -1
  854. package/dist/internal/platform-timers.js +32 -1
  855. package/dist/internal/playground/toolchain.d.ts.map +1 -1
  856. package/dist/internal/playground/toolchain.js +16 -3
  857. package/dist/internal/playground-proxy.d.ts +6 -27
  858. package/dist/internal/playground-proxy.d.ts.map +1 -1
  859. package/dist/internal/playground-proxy.js +25 -83
  860. package/dist/internal/private-file.d.ts +2 -0
  861. package/dist/internal/private-file.d.ts.map +1 -0
  862. package/dist/internal/private-file.js +8 -0
  863. package/dist/internal/reminder-control-plane-protocol.d.ts.map +1 -1
  864. package/dist/internal/reminder-control-plane-protocol.js +4 -2
  865. package/dist/internal/reminder-runner.d.ts.map +1 -1
  866. package/dist/internal/reminder-runner.js +12 -25
  867. package/dist/internal/reminder-schedule.js +1 -1
  868. package/dist/internal/reminder-store.d.ts.map +1 -1
  869. package/dist/internal/reminder-store.js +16 -21
  870. package/dist/internal/request-headers.d.ts +2 -2
  871. package/dist/internal/request-headers.d.ts.map +1 -1
  872. package/dist/internal/request-headers.js +1 -1
  873. package/dist/internal/resolve-prod-target.d.ts +9 -65
  874. package/dist/internal/resolve-prod-target.d.ts.map +1 -1
  875. package/dist/internal/resolve-prod-target.js +20 -187
  876. package/dist/internal/resolved-connections.js +1 -1
  877. package/dist/internal/{factory-resource-channel.d.ts → resource-channel.d.ts} +10 -10
  878. package/dist/internal/resource-channel.d.ts.map +1 -0
  879. package/dist/internal/{factory-resource-channel.js → resource-channel.js} +9 -7
  880. package/dist/internal/run-client.d.ts.map +1 -1
  881. package/dist/internal/run-client.js +4 -1
  882. package/dist/internal/sdk-runner.d.ts +2 -2
  883. package/dist/internal/sdk-runner.d.ts.map +1 -1
  884. package/dist/internal/sdk-runner.js +19 -16
  885. package/dist/internal/sdk-subagent-inherit-support.d.ts.map +1 -1
  886. package/dist/internal/sdk-subagent-inherit-support.js +3 -2
  887. package/dist/internal/serve-restart.d.ts +3 -0
  888. package/dist/internal/serve-restart.d.ts.map +1 -1
  889. package/dist/internal/serve-restart.js +8 -4
  890. package/dist/internal/server.d.ts +4 -0
  891. package/dist/internal/server.d.ts.map +1 -1
  892. package/dist/internal/server.js +71 -64
  893. package/dist/internal/session-cost.d.ts +4 -4
  894. package/dist/internal/session-cost.d.ts.map +1 -1
  895. package/dist/internal/session-cost.js +5 -5
  896. package/dist/internal/session-engine.d.ts +22 -8
  897. package/dist/internal/session-engine.d.ts.map +1 -1
  898. package/dist/internal/session-engine.js +170 -75
  899. package/dist/internal/session-links.js +2 -1
  900. package/dist/internal/session-live-publisher.d.ts +0 -7
  901. package/dist/internal/session-live-publisher.d.ts.map +1 -1
  902. package/dist/internal/session-live-publisher.js +20 -7
  903. package/dist/internal/session-run-log.d.ts.map +1 -1
  904. package/dist/internal/session-run-log.js +19 -5
  905. package/dist/internal/session-store.d.ts.map +1 -1
  906. package/dist/internal/session-store.js +17 -3
  907. package/dist/internal/sessions-client.d.ts +2 -0
  908. package/dist/internal/sessions-client.d.ts.map +1 -1
  909. package/dist/internal/sessions-client.js +44 -10
  910. package/dist/internal/shallow-clone.d.ts +258 -0
  911. package/dist/internal/shallow-clone.d.ts.map +1 -0
  912. package/dist/internal/shallow-clone.js +644 -0
  913. package/dist/internal/slack-bot-scopes.d.ts +3 -0
  914. package/dist/internal/slack-bot-scopes.d.ts.map +1 -0
  915. package/dist/internal/slack-bot-scopes.js +2 -0
  916. package/dist/internal/slack-manifest-opt-in.d.ts +26 -0
  917. package/dist/internal/slack-manifest-opt-in.d.ts.map +1 -0
  918. package/dist/internal/slack-manifest-opt-in.js +63 -0
  919. package/dist/internal/slack-provision-client.d.ts +8 -24
  920. package/dist/internal/slack-provision-client.d.ts.map +1 -1
  921. package/dist/internal/slack-provision-client.js +21 -20
  922. package/dist/internal/slack-thread-key.d.ts +8 -3
  923. package/dist/internal/slack-thread-key.d.ts.map +1 -1
  924. package/dist/internal/slack-thread-key.js +6 -6
  925. package/dist/internal/sqlite-experimental-warning.js +1 -1
  926. package/dist/internal/start-log-store.d.ts.map +1 -1
  927. package/dist/internal/start-log-store.js +2 -5
  928. package/dist/internal/storage-coordinator.d.ts.map +1 -1
  929. package/dist/internal/storage-coordinator.js +49 -20
  930. package/dist/internal/stored-eval-run.d.ts +17 -0
  931. package/dist/internal/stored-eval-run.d.ts.map +1 -0
  932. package/dist/internal/stored-eval-run.js +305 -0
  933. package/dist/internal/stream-progress.d.ts.map +1 -1
  934. package/dist/internal/stream-progress.js +1 -1
  935. package/dist/internal/tcp-address.d.ts +4 -0
  936. package/dist/internal/tcp-address.d.ts.map +1 -0
  937. package/dist/internal/tcp-address.js +8 -0
  938. package/dist/internal/terminal-style.js +2 -2
  939. package/dist/internal/testing/pagerduty-continuation-fixtures.d.ts +1 -1
  940. package/dist/internal/testing/pagerduty-continuation-fixtures.js +1 -1
  941. package/dist/internal/testing/scm-continuation-fixtures.d.ts +1 -1
  942. package/dist/internal/testing/scm-continuation-fixtures.js +1 -1
  943. package/dist/internal/testing/slack-continuation-fixtures.d.ts +12 -6
  944. package/dist/internal/testing/slack-continuation-fixtures.d.ts.map +1 -1
  945. package/dist/internal/testing/slack-continuation-fixtures.js +74 -3
  946. package/dist/internal/tool-call-retry.d.ts +35 -7
  947. package/dist/internal/tool-call-retry.d.ts.map +1 -1
  948. package/dist/internal/tool-call-retry.js +108 -108
  949. package/dist/internal/tool-catalog.d.ts.map +1 -1
  950. package/dist/internal/tool-catalog.js +7 -2
  951. package/dist/internal/tool-policy.d.ts +20 -7
  952. package/dist/internal/tool-policy.d.ts.map +1 -1
  953. package/dist/internal/tool-policy.js +39 -11
  954. package/dist/internal/tool-result.d.ts +0 -5
  955. package/dist/internal/tool-result.d.ts.map +1 -1
  956. package/dist/internal/tool-result.js +26 -6
  957. package/dist/internal/trajectory.d.ts.map +1 -1
  958. package/dist/internal/trajectory.js +5 -1
  959. package/dist/internal/turn-outbox.d.ts.map +1 -1
  960. package/dist/internal/turn-outbox.js +1 -0
  961. package/dist/internal/update-check.d.ts +2 -0
  962. package/dist/internal/update-check.d.ts.map +1 -1
  963. package/dist/internal/update-check.js +4 -0
  964. package/dist/internal/workspace.d.ts +3 -4
  965. package/dist/internal/workspace.d.ts.map +1 -1
  966. package/dist/internal/workspace.js +5 -5
  967. package/dist/kv/memory-kv.d.ts +1 -1
  968. package/dist/kv/memory-kv.js +1 -1
  969. package/dist/kv.d.ts +9 -2
  970. package/dist/kv.d.ts.map +1 -1
  971. package/dist/kv.js +10 -2
  972. package/dist/memory.d.ts +1 -1
  973. package/dist/memory.js +1 -1
  974. package/dist/otel-public.d.ts +2 -1
  975. package/dist/otel-public.d.ts.map +1 -1
  976. package/dist/otel-public.js +2 -1
  977. package/dist/otel.d.ts.map +1 -1
  978. package/dist/otel.js +6 -2
  979. package/dist/playground/assets/cursor-icons-16-QUmxS7q3.woff2 +0 -0
  980. package/dist/playground/assets/index-BMpVzZzC.css +1 -0
  981. package/dist/playground/assets/index-_3zz3yh8.js +62 -0
  982. package/dist/playground/index.html +2 -2
  983. package/dist/prompt.d.ts +1 -1
  984. package/dist/prompt.js +1 -1
  985. package/dist/public-deprecated.d.ts +11 -12
  986. package/dist/public-deprecated.d.ts.map +1 -1
  987. package/dist/public-deprecated.js +8 -9
  988. package/dist/reminders.d.ts +2 -2
  989. package/dist/reminders.js +2 -2
  990. package/dist/schedules.d.ts +1 -1
  991. package/dist/schedules.js +1 -1
  992. package/dist/scm.d.ts +2 -0
  993. package/dist/scm.d.ts.map +1 -0
  994. package/dist/scm.js +1 -0
  995. package/dist/skills.d.ts +1 -1
  996. package/dist/skills.js +1 -1
  997. package/dist/storage-backends/cursor-hosted.d.ts.map +1 -1
  998. package/dist/storage-backends/cursor-hosted.js +5 -3
  999. package/dist/storage-backends/file-kv.d.ts +3 -2
  1000. package/dist/storage-backends/file-kv.d.ts.map +1 -1
  1001. package/dist/storage-backends/file-kv.js +20 -8
  1002. package/dist/storage.d.ts +2 -3
  1003. package/dist/storage.d.ts.map +1 -1
  1004. package/dist/storage.js +9 -5
  1005. package/dist/telemetry.d.ts +12 -0
  1006. package/dist/telemetry.d.ts.map +1 -0
  1007. package/dist/telemetry.js +11 -0
  1008. package/dist/tools.d.ts +1 -1
  1009. package/dist/tools.d.ts.map +1 -1
  1010. package/dist/tools.js +2 -1
  1011. package/dist/types.d.ts +54 -41
  1012. package/dist/types.d.ts.map +1 -1
  1013. package/dist/types.js +4 -4
  1014. package/docs/README.md +16 -17
  1015. package/docs/building-with-agents.md +16 -16
  1016. package/docs/changelog.md +48 -12
  1017. package/docs/deployment.md +111 -49
  1018. package/docs/evals.md +11 -11
  1019. package/docs/guides/agent-to-agent.md +8 -8
  1020. package/docs/guides/bitbucket.md +5 -5
  1021. package/docs/guides/cloud-agents.md +4 -4
  1022. package/docs/guides/convert-automation.md +17 -16
  1023. package/docs/guides/github.md +16 -16
  1024. package/docs/guides/gitlab.md +5 -5
  1025. package/docs/guides/grokbot-agents.md +8 -14
  1026. package/docs/guides/hooks.md +3 -3
  1027. package/docs/guides/improve.md +2 -2
  1028. package/docs/guides/jev.md +10 -10
  1029. package/docs/guides/mcp-oauth.md +8 -8
  1030. package/docs/guides/migrate.md +35 -28
  1031. package/docs/guides/opentelemetry.md +61 -130
  1032. package/docs/guides/pagerduty.md +18 -18
  1033. package/docs/guides/slack.md +82 -11
  1034. package/docs/guides/webhooks.md +61 -3
  1035. package/docs/hillclimbing.md +2 -2
  1036. package/docs/quickstart.md +21 -21
  1037. package/docs/reference/access.md +27 -0
  1038. package/docs/reference/agent-config.md +54 -12
  1039. package/docs/reference/artifacts.md +2 -2
  1040. package/docs/reference/channels.md +29 -9
  1041. package/docs/reference/cli.md +364 -367
  1042. package/docs/reference/connections.md +9 -9
  1043. package/docs/reference/evals.md +13 -13
  1044. package/docs/reference/extensions.md +10 -10
  1045. package/docs/reference/hooks.md +11 -11
  1046. package/docs/reference/http-api.md +1 -1
  1047. package/docs/reference/instructions.md +1 -1
  1048. package/docs/reference/limits.md +42 -0
  1049. package/docs/reference/memory.md +7 -7
  1050. package/docs/reference/playground.md +1 -1
  1051. package/docs/reference/project-layout.md +6 -6
  1052. package/docs/reference/prompt.md +2 -2
  1053. package/docs/reference/schedules.md +4 -4
  1054. package/docs/reference/sessions.md +3 -3
  1055. package/docs/reference/skills.md +2 -2
  1056. package/docs/reference/subagents.md +1 -1
  1057. package/docs/reference/tools.md +31 -21
  1058. package/docs/templates/agentic-owners.md +7 -7
  1059. package/docs/templates/security-reviewer.md +6 -6
  1060. package/docs/templates/thermo-quality-review.md +7 -7
  1061. package/docs/templates/thermo-review.md +7 -7
  1062. package/docs/templates/triage.md +9 -9
  1063. package/docs/troubleshooting.md +24 -22
  1064. package/package.json +51 -92
  1065. package/scripts/install-cursor-skills.mjs +2 -2
  1066. package/skills/cli/SKILL.md +125 -0
  1067. package/skills/create-agent/SKILL.md +11 -9
  1068. package/skills/debug/SKILL.md +3 -3
  1069. package/skills/deploy/SKILL.md +46 -43
  1070. package/skills/evals/SKILL.md +7 -7
  1071. package/skills/framework-map/SKILL.md +8 -7
  1072. package/skills/github/SKILL.md +4 -4
  1073. package/skills/hillclimb/SKILL.md +3 -3
  1074. package/skills/migrate-v2/SKILL.md +50 -53
  1075. package/skills/otel/SKILL.md +36 -6
  1076. package/skills/setup-slack/SKILL.md +3 -3
  1077. package/templates/agentic-owners/README.md +1 -1
  1078. package/templates/agentic-owners/bot/agent.ts +1 -1
  1079. package/templates/agentic-owners/bot/channels/github.ts +1 -1
  1080. package/templates/agentic-owners/bot/lib/github.ts +2 -2
  1081. package/templates/agentic-owners/bot/lib/owners/parse.ts +1 -1
  1082. package/templates/agentic-owners/bot/lib/owners/policyMode.ts +6 -2
  1083. package/templates/agentic-owners/bot/lib/review.ts +7 -3
  1084. package/templates/agentic-owners/bot/tools/record_review.ts +2 -2
  1085. package/templates/agentic-owners/evals/evals.config.ts +1 -1
  1086. package/templates/agentic-owners/evals/owners.eval.ts +1 -1
  1087. package/templates/agentic-owners/package.json +2 -2
  1088. package/templates/agents-md/README.md +1 -1
  1089. package/templates/agents-md/bot/agent.ts +1 -1
  1090. package/templates/agents-md/bot/channels/github.ts +1 -1
  1091. package/templates/agents-md/bot/channels/queue.ts +5 -3
  1092. package/templates/agents-md/bot/channels/slack.ts +1 -1
  1093. package/templates/agents-md/bot/lib/collect.ts +1 -1
  1094. package/templates/agents-md/bot/schedules/weekly.ts +6 -6
  1095. package/templates/agents-md/bot/tools/apply_agents.ts +2 -2
  1096. package/templates/agents-md/evals/agents.eval.ts +1 -1
  1097. package/templates/agents-md/evals/evals.config.ts +1 -1
  1098. package/templates/agents-md/package.json +2 -2
  1099. package/templates/code-wiki/README.md +1 -1
  1100. package/templates/code-wiki/bot/agent.ts +1 -1
  1101. package/templates/code-wiki/bot/channels/github.ts +3 -3
  1102. package/templates/code-wiki/bot/tools/apply_wiki.ts +3 -3
  1103. package/templates/code-wiki/evals/evals.config.ts +1 -1
  1104. package/templates/code-wiki/evals/wiki.eval.ts +1 -1
  1105. package/templates/code-wiki/package.json +2 -2
  1106. package/templates/demo/README.md +1 -1
  1107. package/templates/demo/bot/agent.ts +1 -1
  1108. package/templates/demo/bot/channels/github.ts +7 -3
  1109. package/templates/demo/bot/channels/queue.ts +5 -5
  1110. package/templates/demo/bot/lib/collect.ts +2 -2
  1111. package/templates/demo/bot/tools/record_demo.ts +2 -2
  1112. package/templates/demo/evals/demo.eval.ts +1 -1
  1113. package/templates/demo/evals/evals.config.ts +1 -1
  1114. package/templates/demo/package.json +2 -2
  1115. package/templates/pr-autofixer/bot/agent.ts +1 -1
  1116. package/templates/pr-autofixer/bot/channels/drive.ts +1 -1
  1117. package/templates/pr-autofixer/bot/channels/github.ts +3 -3
  1118. package/templates/pr-autofixer/bot/channels/slack.ts +1 -1
  1119. package/templates/pr-autofixer/bot/hooks/bind-agent.ts +1 -1
  1120. package/templates/pr-autofixer/bot/lib/affinity.ts +1 -1
  1121. package/templates/pr-autofixer/bot/lib/drive.ts +2 -2
  1122. package/templates/pr-autofixer/bot/lib/merge-watch.ts +4 -4
  1123. package/templates/pr-autofixer/bot/lib/pr-state.ts +1 -1
  1124. package/templates/pr-autofixer/bot/lib/start-drive.ts +2 -2
  1125. package/templates/pr-autofixer/bot/lib/webhook-buffer.ts +1 -1
  1126. package/templates/pr-autofixer/bot/lib/webhook-routing.ts +1 -1
  1127. package/templates/pr-autofixer/bot/tools/drive_pr.ts +1 -1
  1128. package/templates/pr-autofixer/evals/coordinator.eval.ts +1 -1
  1129. package/templates/pr-autofixer/evals/evals.config.ts +1 -1
  1130. package/templates/pr-autofixer/package.json +2 -2
  1131. package/templates/security-help/.gitignore +4 -0
  1132. package/templates/security-help/README.md +1 -1
  1133. package/templates/security-help/bot/agent.ts +1 -1
  1134. package/templates/security-help/bot/channels/github.ts +1 -1
  1135. package/templates/security-help/bot/channels/slack.ts +1 -1
  1136. package/templates/security-help/bot/lib/pr-first-pass.ts +3 -3
  1137. package/templates/security-help/evals/evals.config.ts +1 -1
  1138. package/templates/security-help/evals/security-help.eval.ts +1 -1
  1139. package/templates/security-help/package.json +1 -1
  1140. package/templates/security-reviewer/README.md +1 -1
  1141. package/templates/security-reviewer/bot/agent.ts +1 -1
  1142. package/templates/security-reviewer/bot/channels/github.ts +2 -2
  1143. package/templates/security-reviewer/bot/tools/post_findings.ts +2 -2
  1144. package/templates/security-reviewer/evals/evals.config.ts +1 -1
  1145. package/templates/security-reviewer/evals/review.eval.ts +1 -1
  1146. package/templates/security-reviewer/package.json +2 -2
  1147. package/templates/thermo-quality-review/README.md +1 -1
  1148. package/templates/thermo-quality-review/bot/agent.ts +1 -1
  1149. package/templates/thermo-quality-review/bot/channels/github.ts +2 -2
  1150. package/templates/thermo-quality-review/bot/tools/post_findings.ts +2 -2
  1151. package/templates/thermo-quality-review/evals/evals.config.ts +1 -1
  1152. package/templates/thermo-quality-review/evals/review.eval.ts +1 -1
  1153. package/templates/thermo-quality-review/package.json +2 -2
  1154. package/templates/thermo-review/README.md +1 -1
  1155. package/templates/thermo-review/bot/agent.ts +1 -1
  1156. package/templates/thermo-review/bot/channels/github.ts +2 -2
  1157. package/templates/thermo-review/bot/tools/post_findings.ts +2 -2
  1158. package/templates/thermo-review/evals/evals.config.ts +1 -1
  1159. package/templates/thermo-review/evals/review.eval.ts +1 -1
  1160. package/templates/thermo-review/package.json +2 -2
  1161. package/templates/triage/README.md +2 -2
  1162. package/templates/triage/bot/agent.ts +1 -1
  1163. package/templates/triage/bot/channels/queue.ts +5 -5
  1164. package/templates/triage/bot/channels/webhook.ts +5 -5
  1165. package/templates/triage/bot/hooks/memory.ts +1 -1
  1166. package/templates/triage/bot/lib/actuate.ts +2 -2
  1167. package/templates/triage/bot/tools/record_triage.ts +1 -1
  1168. package/templates/triage/evals/evals.config.ts +1 -1
  1169. package/templates/triage/evals/triage.eval.ts +1 -1
  1170. package/templates/triage/overlays/jira/README.md +1 -1
  1171. package/templates/triage/overlays/jira/bot/mcp-connections/tracker.ts +1 -1
  1172. package/templates/triage/overlays/linear/README.md +1 -1
  1173. package/templates/triage/overlays/linear/bot/mcp-connections/tracker.ts +1 -1
  1174. package/templates/triage/package.json +2 -2
  1175. package/dist/bin/agent-sdk.js +0 -2
  1176. package/dist/docs/assets/building-with-agents.md.FZXrY8Nk.js +0 -9
  1177. package/dist/docs/assets/building-with-agents.md.FZXrY8Nk.lean.js +0 -1
  1178. package/dist/docs/assets/changelog.md.BvHRIiMH.js +0 -1
  1179. package/dist/docs/assets/changelog.md.BvHRIiMH.lean.js +0 -1
  1180. package/dist/docs/assets/chunks/@localSearchIndexroot.BoDEJQWv.js +0 -1
  1181. package/dist/docs/assets/chunks/channel.D2BTz0L-.js +0 -1
  1182. package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.DqByliAC.js +0 -1
  1183. package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.DqByliAC.js +0 -1
  1184. package/dist/docs/assets/chunks/clone.CldT1lbQ.js +0 -1
  1185. package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.Bb4oMe0P.js +0 -1
  1186. package/dist/docs/assets/deployment.md.3MMWuPeV.js +0 -31
  1187. package/dist/docs/assets/deployment.md.3MMWuPeV.lean.js +0 -1
  1188. package/dist/docs/assets/guides_agent-to-agent.md.CwL5cwuE.lean.js +0 -1
  1189. package/dist/docs/assets/guides_cloud-agents.md.BzbzcOyj.js +0 -9
  1190. package/dist/docs/assets/guides_cloud-agents.md.BzbzcOyj.lean.js +0 -1
  1191. package/dist/docs/assets/guides_convert-automation.md.DMEX9nF-.lean.js +0 -1
  1192. package/dist/docs/assets/guides_export-grokbot.md.qo5bxi4h.js +0 -55
  1193. package/dist/docs/assets/guides_export-grokbot.md.qo5bxi4h.lean.js +0 -1
  1194. package/dist/docs/assets/guides_grokbot-agents.md.BwAykJ7U.js +0 -15
  1195. package/dist/docs/assets/guides_migrate.md.CQlGaBKX.js +0 -7
  1196. package/dist/docs/assets/guides_migrate.md.CQlGaBKX.lean.js +0 -1
  1197. package/dist/docs/assets/guides_opentelemetry.md.D4wO7_8v.js +0 -37
  1198. package/dist/docs/assets/guides_opentelemetry.md.D4wO7_8v.lean.js +0 -1
  1199. package/dist/docs/assets/index.md.CAnsLl8D.js +0 -27
  1200. package/dist/docs/assets/index.md.CAnsLl8D.lean.js +0 -1
  1201. package/dist/docs/assets/quickstart.md.D8JDfkKO.lean.js +0 -1
  1202. package/dist/docs/assets/reference_channels.md.CNNIS6K7.js +0 -22
  1203. package/dist/docs/assets/reference_cli.md.1o_TqKdt.js +0 -103
  1204. package/dist/docs/assets/reference_cli.md.1o_TqKdt.lean.js +0 -1
  1205. package/dist/docs/assets/reference_memory.md.BwyJXYZe.js +0 -4
  1206. package/dist/docs/assets/reference_playground.md.q4MI-0td.js +0 -1
  1207. package/dist/docs/assets/templates_grokbot-agents.md.DgpPEs7B.js +0 -5
  1208. package/dist/docs/assets/templates_grokbot-agents.md.DgpPEs7B.lean.js +0 -1
  1209. package/dist/docs/assets/templates_security-reviewer.md.Gh6EF9Us.js +0 -3
  1210. package/dist/docs/assets/templates_thermo-quality-review.md.B77UyTrX.js +0 -3
  1211. package/dist/docs/assets/templates_thermo-review.md.DRJ7mC5U.js +0 -3
  1212. package/dist/docs/assets/troubleshooting.md.DFnoTDlQ.js +0 -1
  1213. package/dist/docs/guides/export-grokbot.html +0 -114
  1214. package/dist/docs/guides/export-grokbot.md +0 -239
  1215. package/dist/docs/templates/grokbot-agents.html +0 -64
  1216. package/dist/docs/templates/grokbot-agents.md +0 -55
  1217. package/dist/internal/cli-init-grokbot.d.ts +0 -29
  1218. package/dist/internal/cli-init-grokbot.d.ts.map +0 -1
  1219. package/dist/internal/cli-init-grokbot.js +0 -181
  1220. package/dist/internal/convert-grokbot/answers.d.ts +0 -127
  1221. package/dist/internal/convert-grokbot/answers.d.ts.map +0 -1
  1222. package/dist/internal/convert-grokbot/answers.js +0 -445
  1223. package/dist/internal/convert-grokbot/bot.d.ts +0 -50
  1224. package/dist/internal/convert-grokbot/bot.d.ts.map +0 -1
  1225. package/dist/internal/convert-grokbot/bot.js +0 -72
  1226. package/dist/internal/convert-grokbot/checks.d.ts +0 -26
  1227. package/dist/internal/convert-grokbot/checks.d.ts.map +0 -1
  1228. package/dist/internal/convert-grokbot/checks.js +0 -170
  1229. package/dist/internal/convert-grokbot/convert.d.ts +0 -60
  1230. package/dist/internal/convert-grokbot/convert.d.ts.map +0 -1
  1231. package/dist/internal/convert-grokbot/convert.js +0 -470
  1232. package/dist/internal/convert-grokbot/handoff.d.ts +0 -44
  1233. package/dist/internal/convert-grokbot/handoff.d.ts.map +0 -1
  1234. package/dist/internal/convert-grokbot/handoff.js +0 -160
  1235. package/dist/internal/convert-grokbot/recipe.d.ts +0 -61
  1236. package/dist/internal/convert-grokbot/recipe.d.ts.map +0 -1
  1237. package/dist/internal/convert-grokbot/recipe.js +0 -94
  1238. package/dist/internal/convert-grokbot/routine.d.ts +0 -51
  1239. package/dist/internal/convert-grokbot/routine.d.ts.map +0 -1
  1240. package/dist/internal/convert-grokbot/routine.js +0 -128
  1241. package/dist/internal/convert-grokbot/slack.d.ts +0 -28
  1242. package/dist/internal/convert-grokbot/slack.d.ts.map +0 -1
  1243. package/dist/internal/convert-grokbot/slack.js +0 -50
  1244. package/dist/internal/factory-resource-channel.d.ts.map +0 -1
  1245. package/dist/internal/legacy-command-guard.d.ts +0 -24
  1246. package/dist/internal/legacy-command-guard.d.ts.map +0 -1
  1247. package/dist/internal/legacy-command-guard.js +0 -47
  1248. package/dist/internal/runtime-dispatch-runner.d.ts +0 -25
  1249. package/dist/internal/runtime-dispatch-runner.d.ts.map +0 -1
  1250. package/dist/internal/runtime-dispatch-runner.js +0 -35
  1251. package/dist/internal/testing/factory-resource-fixtures.d.ts +0 -64
  1252. package/dist/internal/testing/factory-resource-fixtures.d.ts.map +0 -1
  1253. package/dist/internal/testing/factory-resource-fixtures.js +0 -55
  1254. package/dist/playground/assets/cursor-icons-16-DfKNljMZ.woff2 +0 -0
  1255. package/dist/playground/assets/index-B3_YohwW.js +0 -62
  1256. package/dist/playground/assets/index-Cn3-adsJ.css +0 -1
  1257. package/docs/guides/export-grokbot.md +0 -244
  1258. package/docs/templates/grokbot-agents.md +0 -60
  1259. package/schemas/grokbot-answers.schema.json +0 -354
  1260. package/templates/grokbot-agents/README.md +0 -27
  1261. package/templates/grokbot-agents/bot/agent.ts +0 -6
  1262. package/templates/grokbot-agents/bot/extensions/grokbot.ts +0 -5
  1263. package/templates/grokbot-agents/bot/instructions.md +0 -7
  1264. package/templates/grokbot-agents/evals/evals.config.ts +0 -5
  1265. package/templates/grokbot-agents/evals/grokbot-agents.eval.ts +0 -18
  1266. package/templates/grokbot-agents/init.json +0 -18
  1267. package/templates/grokbot-agents/package.json +0 -17
  1268. package/templates/grokbot-agents/tsconfig.json +0 -12
  1269. /package/dist/docs/assets/{evals.md.CHR34K1Y.lean.js → evals.md.OjKb7tNA.lean.js} +0 -0
  1270. /package/dist/docs/assets/{guides_bitbucket.md.CKUayYtD.lean.js → guides_bitbucket.md.DkjkBRU8.lean.js} +0 -0
  1271. /package/dist/docs/assets/{guides_gitlab.md.CtNI4fSH.lean.js → guides_gitlab.md.DCE0p7_w.lean.js} +0 -0
  1272. /package/dist/docs/assets/{guides_jev.md.D7XH4JH3.lean.js → guides_jev.md.Ccw4pedT.lean.js} +0 -0
  1273. /package/dist/docs/assets/{guides_pagerduty.md.BHXMcMtx.lean.js → guides_pagerduty.md.mnKXe9U0.lean.js} +0 -0
  1274. /package/dist/docs/assets/{hillclimbing.md.Dxvd-0gT.lean.js → hillclimbing.md.By61f3uq.lean.js} +0 -0
  1275. /package/dist/docs/assets/{reference_artifacts.md.DLV9MZES.lean.js → reference_artifacts.md.C-hKR2hp.lean.js} +0 -0
  1276. /package/dist/docs/assets/{reference_connections.md.BJE2Zllp.lean.js → reference_connections.md.BoAotr7_.lean.js} +0 -0
  1277. /package/dist/docs/assets/{reference_evals.md.Ccwp4x3o.lean.js → reference_evals.md.DYKjGFi-.lean.js} +0 -0
  1278. /package/dist/docs/assets/{reference_hooks.md.CROr0QgC.lean.js → reference_hooks.md.B-bwJuiG.lean.js} +0 -0
  1279. /package/dist/docs/assets/{reference_http-api.md.Dji-DD_Z.lean.js → reference_http-api.md._RWELr3d.lean.js} +0 -0
  1280. /package/dist/docs/assets/{reference_instructions.md.BYMVxAkw.lean.js → reference_instructions.md.yL2hXLnl.lean.js} +0 -0
  1281. /package/dist/docs/assets/{reference_memory.md.BwyJXYZe.lean.js → reference_memory.md.Dd7cyV9V.lean.js} +0 -0
  1282. /package/dist/docs/assets/{reference_playground.md.q4MI-0td.lean.js → reference_playground.md.CQiJk9CM.lean.js} +0 -0
  1283. /package/dist/docs/assets/{reference_project-layout.md.mFcS8yDD.lean.js → reference_project-layout.md.BamcPDUn.lean.js} +0 -0
  1284. /package/dist/docs/assets/{reference_prompt.md.DqPh71XN.lean.js → reference_prompt.md.BMjm1Jp3.lean.js} +0 -0
  1285. /package/dist/docs/assets/{reference_schedules.md.BqWnJES4.lean.js → reference_schedules.md.RC47aFm4.lean.js} +0 -0
  1286. /package/dist/docs/assets/{reference_sessions.md.Bi6lHttM.lean.js → reference_sessions.md.C7KFhWXV.lean.js} +0 -0
  1287. /package/dist/docs/assets/{reference_subagents.md.ChNGh6HK.lean.js → reference_subagents.md.CAhvW4yS.lean.js} +0 -0
  1288. /package/dist/docs/assets/{templates_agentic-owners.md.CTEnR0jp.lean.js → templates_agentic-owners.md.Dh2nDSqg.lean.js} +0 -0
  1289. /package/dist/docs/assets/{templates_security-reviewer.md.Gh6EF9Us.lean.js → templates_security-reviewer.md.DnwXdnB5.lean.js} +0 -0
  1290. /package/dist/docs/assets/{templates_triage.md.CNN6b0JZ.lean.js → templates_triage.md.BYWMloV4.lean.js} +0 -0
  1291. /package/dist/docs/assets/{troubleshooting.md.DFnoTDlQ.lean.js → troubleshooting.md.AGJ3jDzj.lean.js} +0 -0
@@ -1,4 +1,4 @@
1
- import{_ as i,c as a,o as e,a3 as t}from"./chunks/framework.BNw1pucY.js";const c=JSON.parse(`{"title":"MCP connections","description":"Pull in tools from MCP servers: remote, stdio, the signed-in Cursor account's connectors, and peer agents.","frontmatter":{"title":"MCP connections","description":"Pull in tools from MCP servers: remote, stdio, the signed-in Cursor account's connectors, and peer agents."},"headers":[],"relativePath":"reference/connections.md","filePath":"reference/connections.md"}`),n={name:"reference/connections.md"};function h(l,s,o,p,r,k){return e(),a("div",null,[...s[0]||(s[0]=[t(`<h1 id="mcp-connections" tabindex="-1">MCP connections <a class="header-anchor" href="#mcp-connections" aria-label="Permalink to &quot;MCP connections&quot;">​</a></h1><p>An MCP connection gives the agent tools from an MCP server. Define one file per server under <code>bot/mcp-connections/</code>; the filename becomes the server name. Default-export <code>defineConnection</code> from <code>@cursor/bdk/connections</code>. The transport is remote HTTP, local stdio, the signed-in Cursor account&#39;s connectors, or a peer agent addressed by slug.</p><p>Put a server in <code>bot/host-connections/</code> when only host tools should call it. Host connections use the same <code>defineConnection</code> shape and support <code>bdk mcp oauth</code>; the model and playground don&#39;t see them.</p><h2 id="remote-mcp-server" tabindex="-1">Remote MCP server <a class="header-anchor" href="#remote-mcp-server" aria-label="Permalink to &quot;Remote MCP server&quot;">​</a></h2><p>Point an MCP connection at a remote server with a URL.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { defineConnection } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@cursor/bdk/connections&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
1
+ import{_ as i,c as a,o as e,a3 as t}from"./chunks/framework.BNw1pucY.js";const c=JSON.parse(`{"title":"MCP connections","description":"Pull in tools from MCP servers: remote, stdio, the signed-in Cursor account's connectors, and peer agents.","frontmatter":{"title":"MCP connections","description":"Pull in tools from MCP servers: remote, stdio, the signed-in Cursor account's connectors, and peer agents."},"headers":[],"relativePath":"reference/connections.md","filePath":"reference/connections.md"}`),n={name:"reference/connections.md"};function h(l,s,o,p,r,k){return e(),a("div",null,[...s[0]||(s[0]=[t(`<h1 id="mcp-connections" tabindex="-1">MCP connections <a class="header-anchor" href="#mcp-connections" aria-label="Permalink to &quot;MCP connections&quot;">​</a></h1><p>An MCP connection gives the agent tools from an MCP server. Define one file per server under <code>bot/mcp-connections/</code>; the filename becomes the server name. Default-export <code>defineConnection</code> from <code>@grok/agent-sdk/connections</code>. The transport is remote HTTP, local stdio, the signed-in Cursor account&#39;s connectors, or a peer agent addressed by slug.</p><p>Put a server in <code>bot/host-connections/</code> when only host tools should call it. Host connections use the same <code>defineConnection</code> shape and support <code>agent-sdk mcp oauth</code>; the model and playground don&#39;t see them.</p><h2 id="remote-mcp-server" tabindex="-1">Remote MCP server <a class="header-anchor" href="#remote-mcp-server" aria-label="Permalink to &quot;Remote MCP server&quot;">​</a></h2><p>Point an MCP connection at a remote server with a URL.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { defineConnection } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@grok/agent-sdk/connections&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
2
2
  <span class="line"></span>
3
3
  <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> defineConnection</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
4
4
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> url: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;https://mcp.linear.app/mcp&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
@@ -7,16 +7,16 @@ import{_ as i,c as a,o as e,a3 as t}from"./chunks/framework.BNw1pucY.js";const c
7
7
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> command: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;slack-mcp-server&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
8
8
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> args: [</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;--transport&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;stdio&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">],</span></span>
9
9
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> env: { SLACK_MCP_XOXB_TOKEN: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;\${SLACK_BOT_TOKEN}&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
10
- <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>That timing is the point of the template. Your connection file is imported once, when the project loads, and a hosted deployment has none of its secrets in the environment yet, because the platform passes them to the agent per request. So a <code>process.env.SLACK_BOT_TOKEN</code> read at the top of the file captures an empty string and keeps sending it for the life of the process, while the same file works locally because <code>.env.local</code> was read before the import. The template form is right in both places.</p><p><code>bdk validate</code> warns about a template the environment does not define and names the variable. It stays a warning rather than an error, since a hosted deployment resolves it later. An unset variable resolves to an empty value at connect time, which the server reports as an auth failure.</p><h2 id="host-mcp-oauth" tabindex="-1">Host MCP OAuth <a class="header-anchor" href="#host-mcp-oauth" aria-label="Permalink to &quot;Host MCP OAuth&quot;">​</a></h2><p>For servers that speak OAuth, set <code>oauth: true</code> and authorize with the CLI or mid-run Connect. Tokens live in <code>mcp-auth.json</code> under the CLI config directory of the machine that authorized them. A hosted agent reaches OAuth servers through a <a href="#cursor-account-mcp-connection">Cursor account connection</a> instead.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> defineConnection</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
10
+ <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>That timing is the point of the template. Your connection file is imported once, when the project loads, and a hosted deployment has none of its secrets in the environment yet, because the platform passes them to the agent per request. So a <code>process.env.SLACK_BOT_TOKEN</code> read at the top of the file captures an empty string and keeps sending it for the life of the process, while the same file works locally because <code>.env.local</code> was read before the import. The template form is right in both places.</p><p><code>agent-sdk validate</code> warns about a template the environment does not define and names the variable. It stays a warning rather than an error, since a hosted deployment resolves it later. An unset variable resolves to an empty value at connect time, which the server reports as an auth failure.</p><h2 id="host-mcp-oauth" tabindex="-1">Host MCP OAuth <a class="header-anchor" href="#host-mcp-oauth" aria-label="Permalink to &quot;Host MCP OAuth&quot;">​</a></h2><p>For servers that speak OAuth, set <code>oauth: true</code> and authorize with the CLI or mid-run Connect. Tokens live in <code>mcp-auth.json</code> under the CLI config directory of the machine that authorized them. A hosted agent reaches OAuth servers through a <a href="#cursor-account-mcp-connection">Cursor account connection</a> instead.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> defineConnection</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
11
11
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> url: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;https://mcp.example.com/inventory&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
12
12
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> oauth: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">true</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
13
- <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>bdk mcp oauth inventory # browser PKCE → local mcp-auth.json</span></span></code></pre></div><p>Full walkthrough: <a href="./../guides/mcp-oauth.html">Host MCP OAuth</a>. Companion skill: <a href="./../../skills/mcp-auth/SKILL.html"><code>skills/mcp-auth/SKILL.md</code></a>.</p><h2 id="per-session-auth" tabindex="-1">Per-session auth <a class="header-anchor" href="#per-session-auth" aria-label="Permalink to &quot;Per-session auth&quot;">​</a></h2><p>For http/sse connections whose credential depends on who the session is for, declare an <code>auth</code> callback instead of static headers. It runs host-side with the session&#39;s <code>SessionInfo</code> and returns headers merged over the static ones:</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> defineConnection</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
13
+ <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>agent-sdk mcp oauth inventory # browser PKCE → local mcp-auth.json</span></span></code></pre></div><p>Full walkthrough: <a href="./../guides/mcp-oauth.html">Host MCP OAuth</a>. Companion skill: <a href="./../../skills/mcp-auth/SKILL.html"><code>skills/mcp-auth/SKILL.md</code></a>.</p><h2 id="per-session-auth" tabindex="-1">Per-session auth <a class="header-anchor" href="#per-session-auth" aria-label="Permalink to &quot;Per-session auth&quot;">​</a></h2><p>For http/sse connections whose credential depends on who the session is for, declare an <code>auth</code> callback instead of static headers. It runs host-side with the session&#39;s <code>SessionInfo</code> and returns headers merged over the static ones:</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> defineConnection</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
14
14
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> url: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;https://api.cursor.com/v1/mcp/plugins&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
15
15
  <span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> auth</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">async</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">session</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=&gt;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ({</span></span>
16
16
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> headers: { Authorization: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">\`Bearer \${</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">await</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> grantFor</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">(</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">session</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">)</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">}\`</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
17
17
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }),</span></span>
18
18
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> advertiseTools: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">true</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
19
- <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>The callback is evaluated on every turn, including reminder fires and post-restart follow-ups, so the identity always comes from the session itself, never from state parked in memory. The model never sees a downstream account parameter and cannot choose the account. A callback that throws fails the turn: a turn never silently runs without the connection&#39;s identity. <code>host.mcp</code> calls from server tools keep the static headers only. You can&#39;t combine <code>auth</code> with <code>oauth: true</code>; the host OAuth provider owns the Authorization header.</p><p>Derive the identity from durable session facts: <code>session.auth</code>, <code>session.id</code>, or your channel&#39;s own session state. Do not key it off <code>session.continuationKey</code>. The HTTP channel rotates that key after every accepted follow-up, so an account mapping keyed on it breaks mid-conversation.</p><p><code>auth</code> works attached or advertised. Advertise the auth connection instead of attaching it next to a stateful stdio server.</p><h2 id="advertise-tools" tabindex="-1">Advertise tools <a class="header-anchor" href="#advertise-tools" aria-label="Permalink to &quot;Advertise tools {#advertise-tools}&quot;">​</a></h2><p>Set <code>advertiseTools: true</code> when the model should call an MCP server&#39;s tools by name. BDK preserves each tool&#39;s description, input and output schemas, and MCP annotations. Exposed names normalize invalid characters and add numeric suffixes to avoid collisions.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> defineConnection</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
19
+ <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>The callback is evaluated on every turn, including reminder fires and post-restart follow-ups, so the identity always comes from the session itself, never from state parked in memory. The model never sees a downstream account parameter and cannot choose the account. A callback that throws fails the turn: a turn never silently runs without the connection&#39;s identity. <code>host.mcp</code> calls from server tools keep the static headers only. You can&#39;t combine <code>auth</code> with <code>oauth: true</code>; the host OAuth provider owns the Authorization header.</p><p>Derive the identity from durable session facts: <code>session.auth</code>, <code>session.id</code>, or your channel&#39;s own session state. Do not key it off <code>session.continuationKey</code>. The HTTP channel rotates that key after every accepted follow-up, so an account mapping keyed on it breaks mid-conversation.</p><p><code>auth</code> works attached or advertised. Advertise the auth connection instead of attaching it next to a stateful stdio server.</p><h2 id="advertise-tools" tabindex="-1">Advertise tools <a class="header-anchor" href="#advertise-tools" aria-label="Permalink to &quot;Advertise tools {#advertise-tools}&quot;">​</a></h2><p>Set <code>advertiseTools: true</code> when the model should call an MCP server&#39;s tools by name. Agent SDK preserves each tool&#39;s description, input and output schemas, and MCP annotations. Exposed names normalize invalid characters and add numeric suffixes to avoid collisions.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> defineConnection</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
20
20
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> url: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;https://api.cursor.com/v1/mcp/plugins&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
21
21
  <span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> auth</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">async</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">session</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=&gt;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ({ headers: </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">await</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> headersForSession</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(session) }),</span></span>
22
22
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> advertiseTools: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">true</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
@@ -32,7 +32,7 @@ import{_ as i,c as a,o as e,a3 as t}from"./chunks/framework.BNw1pucY.js";const c
32
32
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> command: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;node&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
33
33
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> args: [</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;--import&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;tsx&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;mcp/units-server.ts&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">],</span></span>
34
34
  <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // env, cwd</span></span>
35
- <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>This suits small purpose-built servers, like a <code>units</code> converter shipped next to the agent.</p><p>To run TypeScript in the agent environment, author the tools on the connection instead. BDK packages authored tools as stdio MCP, so you write only <code>execute</code>.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> defineConnection</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
35
+ <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>This suits small purpose-built servers, like a <code>units</code> converter shipped next to the agent.</p><p>To run TypeScript in the agent environment, author the tools on the connection instead. Agent SDK packages authored tools as stdio MCP, so you write only <code>execute</code>.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> defineConnection</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
36
36
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> tools: {</span></span>
37
37
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> probe_agent_tool: {</span></span>
38
38
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> description: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;Prove the tool ran in the agent environment.&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
@@ -50,11 +50,11 @@ import{_ as i,c as a,o as e,a3 as t}from"./chunks/framework.BNw1pucY.js";const c
50
50
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> cursorAccount: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">true</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
51
51
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> servers: [</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;Linear&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">],</span></span>
52
52
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> advertiseTools: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">true</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
53
- <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>Name the file <code>account.ts</code>. <code>cursor.ts</code> collides with the IDE <code>cursor</code> MCP namespace. <code>advertiseTools: true</code> puts connector tools on local turns by name.</p><p>The host must be signed in (<code>bdk login</code>, <code>CURSOR_API_KEY</code>, or <code>CURSOR_SERVICE_ACCOUNT_KEY</code>). <code>serve</code> fails at startup otherwise.</p><p>Use a <code>{ command }</code> connection for stdio servers.</p><div class="caution custom-block github-alert"><p class="custom-block-title">CAUTION</p><p>Whoever can talk to the agent can drive these connectors, because they are ordinary agent tools. <code>serve</code> refuses to start when <code>--allow-anonymous</code> is combined with account MCP connections unless you also pass <code>--allow-anonymous-cursor-account-mcp</code> (trusted boundary only; for example an SSO proxy or the hosted alias token). Prefer <code>--bearer-token</code> on shared hosts.</p></div><h2 id="peer-mcp-connection" tabindex="-1">Peer MCP connection <a class="header-anchor" href="#peer-mcp-connection" aria-label="Permalink to &quot;Peer MCP connection {#peer-mcp-connection}&quot;">​</a></h2><p><code>{ agent: &quot;&lt;slug&gt;&quot; }</code> addresses another agent without configuring a URL, headers, or secrets. On a local multi-agent serve, the target is another mount slug. On Cursor-managed hosting, it is the lowercase deployment slug of another agent on the same team.</p><p>On a local multi-agent serve, the model gets the peer&#39;s <code>ask</code> and <code>check</code> tools, plus <code>call_tool</code> when the peer has server tools, and can delegate work to it:</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> defineConnection</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
53
+ <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>Name the file <code>account.ts</code>. <code>cursor.ts</code> collides with the IDE <code>cursor</code> MCP namespace. <code>advertiseTools: true</code> puts connector tools on local turns by name.</p><p>The host must be signed in (<code>agent-sdk login</code>, <code>CURSOR_API_KEY</code>, or <code>CURSOR_SERVICE_ACCOUNT_KEY</code>). <code>serve</code> fails at startup otherwise.</p><p>Use a <code>{ command }</code> connection for stdio servers.</p><div class="caution custom-block github-alert"><p class="custom-block-title">CAUTION</p><p>Whoever can talk to the agent can drive these connectors, because they are ordinary agent tools. <code>serve</code> refuses to start when <code>--allow-anonymous</code> is combined with account MCP connections unless you also pass <code>--allow-anonymous-cursor-account-mcp</code> (trusted boundary only; for example an SSO proxy or the hosted alias token). Prefer <code>--bearer-token</code> on shared hosts.</p></div><h2 id="peer-mcp-connection" tabindex="-1">Peer MCP connection <a class="header-anchor" href="#peer-mcp-connection" aria-label="Permalink to &quot;Peer MCP connection {#peer-mcp-connection}&quot;">​</a></h2><p><code>{ agent: &quot;&lt;slug&gt;&quot; }</code> addresses another agent without configuring a URL, headers, or secrets. On a local multi-agent serve, the target is another mount slug. On Cursor-managed hosting, it is the lowercase deployment slug of another agent on the same team.</p><p>On a local multi-agent serve, the model gets the peer&#39;s <code>ask</code> and <code>check</code> tools, plus <code>call_tool</code> when the peer has server tools, and can delegate work to it:</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> defineConnection</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
54
54
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> agent: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;weather-agent&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
55
55
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> description: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;Delegate weather questions to the weather agent.&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
56
56
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>Declare the connection only on the caller. The specialist needs no matching configuration.</p><p>In a local multi-agent serve, unknown slugs and self-references fail at startup. A single-agent serve omits peers with a warning unless its hosting platform sets <code>--peers-url</code>. Walkthrough: <a href="./../guides/agent-to-agent.html#delegate-a-question-to-a-specialist">Peer agents</a>.</p><h2 id="call-mcp-from-host-code" tabindex="-1">Call MCP from host code <a class="header-anchor" href="#call-mcp-from-host-code" aria-label="Permalink to &quot;Call MCP from host code&quot;">​</a></h2><p>A file under <code>bot/mcp-connections/</code> is available to the Cursor agent, to server tools through <code>ctx.host.mcp</code>, and to channel and schedule handlers through <code>args.host.mcp</code>. Host connections skip the model.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// bot/tools/search_linear.ts</span></span>
57
- <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { defineTool } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@cursor/bdk/tools&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
57
+ <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { defineTool } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@grok/agent-sdk/tools&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
58
58
  <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { z } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;zod&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
59
59
  <span class="line"></span>
60
60
  <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> defineTool</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
@@ -1,4 +1,4 @@
1
- import{_ as e,c as a,o as i,a3 as t}from"./chunks/framework.BNw1pucY.js";const k=JSON.parse('{"title":"Evals","description":"Define eval cases, drive turns, assert trajectories, and interpret results.","frontmatter":{"title":"Evals","description":"Define eval cases, drive turns, assert trajectories, and interpret results."},"headers":[],"relativePath":"reference/evals.md","filePath":"reference/evals.md"}'),n={name:"reference/evals.md"};function d(l,s,h,r,o,p){return i(),a("div",null,[...s[0]||(s[0]=[t(`<h1 id="evals" tabindex="-1">Evals <a class="header-anchor" href="#evals" aria-label="Permalink to &quot;Evals&quot;">​</a></h1><p>Evals run fixed cases against an agent and record whether its turns, tools, events, and output meet a contract. Files under the project-root <code>evals/</code> directory define cases with <code>@cursor/bdk/evals</code>; the runner discovers their IDs, executes them, and reports every assertion. See the <a href="./../evals.html">Evals guide</a> for the regression workflow.</p><h2 id="eval-discovery-and-case-ids" tabindex="-1">Eval discovery and case IDs <a class="header-anchor" href="#eval-discovery-and-case-ids" aria-label="Permalink to &quot;Eval discovery and case IDs&quot;">​</a></h2><p>Eval files live under the project-root <code>evals/</code> directory and end in <code>.eval.ts</code> or <code>.eval.js</code>. The path under that directory becomes the eval ID:</p><ul><li><code>evals/readiness.eval.ts</code> becomes <code>readiness</code>.</li><li><code>evals/builds/api.eval.ts</code> becomes <code>builds/api</code>.</li><li><code>evals/builds/index.eval.ts</code> becomes <code>builds</code>.</li></ul><p>Export one <code>defineEval</code> with either <code>test</code> or <code>cases</code>, not both. A case ID appends one path segment to the file ID:</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> defineEval</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
1
+ import{_ as e,c as a,o as i,a3 as t}from"./chunks/framework.BNw1pucY.js";const k=JSON.parse('{"title":"Evals","description":"Define eval cases, drive turns, assert trajectories, and interpret results.","frontmatter":{"title":"Evals","description":"Define eval cases, drive turns, assert trajectories, and interpret results."},"headers":[],"relativePath":"reference/evals.md","filePath":"reference/evals.md"}'),n={name:"reference/evals.md"};function d(l,s,h,r,o,p){return i(),a("div",null,[...s[0]||(s[0]=[t(`<h1 id="evals" tabindex="-1">Evals <a class="header-anchor" href="#evals" aria-label="Permalink to &quot;Evals&quot;">​</a></h1><p>Evals run fixed cases against an agent and record whether its turns, tools, events, and output meet a contract. Files under the project-root <code>evals/</code> directory define cases with <code>@grok/agent-sdk/evals</code>; the runner discovers their IDs, executes them, and reports every assertion. See the <a href="./../evals.html">Evals guide</a> for the regression workflow.</p><h2 id="eval-discovery-and-case-ids" tabindex="-1">Eval discovery and case IDs <a class="header-anchor" href="#eval-discovery-and-case-ids" aria-label="Permalink to &quot;Eval discovery and case IDs&quot;">​</a></h2><p>Eval files live under the project-root <code>evals/</code> directory and end in <code>.eval.ts</code> or <code>.eval.js</code>. The path under that directory becomes the eval ID:</p><ul><li><code>evals/readiness.eval.ts</code> becomes <code>readiness</code>.</li><li><code>evals/builds/api.eval.ts</code> becomes <code>builds/api</code>.</li><li><code>evals/builds/index.eval.ts</code> becomes <code>builds</code>.</li></ul><p>Export one <code>defineEval</code> with either <code>test</code> or <code>cases</code>, not both. A case ID appends one path segment to the file ID:</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> defineEval</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
2
2
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> tags: [</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;smoke&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">],</span></span>
3
3
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> cases: [</span></span>
4
4
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
@@ -16,7 +16,7 @@ import{_ as e,c as a,o as i,a3 as t}from"./chunks/framework.BNw1pucY.js";const k
16
16
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
17
17
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
18
18
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ],</span></span>
19
- <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>Those cases are <code>prs/checkout</code> and <code>prs/search</code> when the file is <code>evals/prs.eval.ts</code>. Case IDs must be unique single path segments.</p><p>A file can also export an array of <code>defineEval</code> calls. The runner names them with zero-padded indexes such as <code>sql/0000</code>. Named <code>cases</code> give handwritten scenarios stable IDs; arrays fit loaded datasets.</p><p><code>iterations</code> repeats one datapoint from 1 to 100 times. For <code>iterations: 3</code>, <code>weather/nyc</code> expands to <code>weather/nyc/1</code>, <code>weather/nyc/2</code>, and <code>weather/nyc/3</code>; selecting <code>weather/nyc</code> runs all three.</p><h2 id="eval-configuration" tabindex="-1">Eval configuration <a class="header-anchor" href="#eval-configuration" aria-label="Permalink to &quot;Eval configuration&quot;">​</a></h2><p>Every running suite needs <code>evals/evals.config.ts</code> with <code>maxConcurrency</code>:</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { defineEvalConfig } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@cursor/bdk/evals&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
19
+ <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>Those cases are <code>prs/checkout</code> and <code>prs/search</code> when the file is <code>evals/prs.eval.ts</code>. Case IDs must be unique single path segments.</p><p>A file can also export an array of <code>defineEval</code> calls. The runner names them with zero-padded indexes such as <code>sql/0000</code>. Named <code>cases</code> give handwritten scenarios stable IDs; arrays fit loaded datasets.</p><p><code>iterations</code> repeats one datapoint from 1 to 100 times. For <code>iterations: 3</code>, <code>weather/nyc</code> expands to <code>weather/nyc/1</code>, <code>weather/nyc/2</code>, and <code>weather/nyc/3</code>; selecting <code>weather/nyc</code> runs all three.</p><h2 id="eval-configuration" tabindex="-1">Eval configuration <a class="header-anchor" href="#eval-configuration" aria-label="Permalink to &quot;Eval configuration&quot;">​</a></h2><p>Every running suite needs <code>evals/evals.config.ts</code> with <code>maxConcurrency</code>:</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { defineEvalConfig } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@grok/agent-sdk/evals&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
20
20
  <span class="line"></span>
21
21
  <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> defineEvalConfig</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
22
22
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> maxConcurrency: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">20</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
@@ -26,14 +26,14 @@ import{_ as e,c as a,o as i,a3 as t}from"./chunks/framework.BNw1pucY.js";const k
26
26
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> input: { verdict: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;review&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
27
27
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> status: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;completed&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
28
28
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> count: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">1</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
29
- <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>Tool status is <code>completed</code>, <code>failed</code>, <code>pending</code>, or <code>rejected</code>. Subagent matchers accept <code>output</code>, <code>status</code>, <code>count</code>, and <code>callId</code>. Event matchers accept <code>data</code> and <code>count</code>.</p><h2 id="expectation-builders" tabindex="-1">Expectation builders <a class="header-anchor" href="#expectation-builders" aria-label="Permalink to &quot;Expectation builders&quot;">​</a></h2><p>Import builders from <code>@cursor/bdk/evals</code>:</p><table tabindex="0"><thead><tr><th>Builder</th><th>Default severity</th></tr></thead><tbody><tr><td>\`includes(string</td><td>RegExp)\`</td></tr><tr><td><code>equals(value)</code></td><td>Hard gate</td></tr><tr><td><code>matches(schema)</code></td><td>Hard gate</td></tr><tr><td><code>satisfies(predicate, label)</code></td><td>Hard gate</td></tr><tr><td><code>similarity(expected)</code></td><td>Soft score</td></tr></tbody></table><p><code>matches</code> accepts Standard Schema implementations such as Zod. <code>normalizedSimilarity(value, expected)</code> returns the same 0-to-1 value used by <code>similarity</code>.</p><h2 id="severity-and-verdicts" tabindex="-1">Severity and verdicts <a class="header-anchor" href="#severity-and-verdicts" aria-label="Permalink to &quot;Severity and verdicts&quot;">​</a></h2><p>Every assertion returns a severity handle:</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">t.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">succeeded</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">();</span></span>
29
+ <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>Tool status is <code>completed</code>, <code>failed</code>, <code>pending</code>, or <code>rejected</code>. Subagent matchers accept <code>output</code>, <code>status</code>, <code>count</code>, and <code>callId</code>. Event matchers accept <code>data</code> and <code>count</code>.</p><h2 id="expectation-builders" tabindex="-1">Expectation builders <a class="header-anchor" href="#expectation-builders" aria-label="Permalink to &quot;Expectation builders&quot;">​</a></h2><p>Import builders from <code>@grok/agent-sdk/evals</code>:</p><table tabindex="0"><thead><tr><th>Builder</th><th>Default severity</th></tr></thead><tbody><tr><td>\`includes(string</td><td>RegExp)\`</td></tr><tr><td><code>equals(value)</code></td><td>Hard gate</td></tr><tr><td><code>matches(schema)</code></td><td>Hard gate</td></tr><tr><td><code>satisfies(predicate, label)</code></td><td>Hard gate</td></tr><tr><td><code>similarity(expected)</code></td><td>Soft score</td></tr></tbody></table><p><code>matches</code> accepts Standard Schema implementations such as Zod. <code>normalizedSimilarity(value, expected)</code> returns the same 0-to-1 value used by <code>similarity</code>.</p><h2 id="severity-and-verdicts" tabindex="-1">Severity and verdicts <a class="header-anchor" href="#severity-and-verdicts" aria-label="Permalink to &quot;Severity and verdicts&quot;">​</a></h2><p>Every assertion returns a severity handle:</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">t.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">succeeded</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">();</span></span>
30
30
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">t.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">calledTool</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;search&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">).</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">soft</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">();</span></span>
31
31
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">t.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">check</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(t.reply, </span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">similarity</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;Expected answer&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)).</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">atLeast</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">0.8</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
32
32
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">t.judge.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">closedQA</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;names the failing step&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">).</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">gate</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">1</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span></code></pre></div><ul><li><code>.gate(threshold?)</code> fails the case when it misses.</li><li><code>.soft(threshold?)</code> records a value without failing.</li><li><code>.atLeast(threshold)</code> records a soft bar; a miss produces a <code>scored</code> verdict.</li></ul><p>Case verdicts are <code>passed</code>, <code>failed</code>, <code>scored</code>, or <code>skipped</code>. The CLI exits 1 for a failed gate. A scored result exits 0 unless <code>--strict</code> is set. Exit 2 means the selection matched no cases.</p><h2 id="judges" tabindex="-1">Judges <a class="header-anchor" href="#judges" aria-label="Permalink to &quot;Judges&quot;">​</a></h2><p>Use a judge for meaning that deterministic checks cannot express:</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">t.judge.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">factuality</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(expected).</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">atLeast</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">0.8</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
33
33
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">t.judge.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">summarizes</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(expected).</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">atLeast</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">0.8</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
34
34
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">t.judge.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">closedQA</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;names the root cause&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">).</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">gate</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">1</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
35
- <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">t.judge.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">sql</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(expected).</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">atLeast</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">0.9</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span></code></pre></div><p>Each grades <code>t.reply</code> by default; pass <code>{ on }</code> to grade another value. Judge configuration can live in the project config, eval, case, or call, with the nearest value winning.</p><p><code>t.judge.model(prompt)</code> returns a raw model reply for custom grading. Treat agent output as untrusted input: wrap it with <code>fenceUntrusted</code> and include <code>EVAL_JUDGE_INJECTION_GUARD</code> in the judge prompt.</p><h2 id="judge-host" tabindex="-1">Judge host <a class="header-anchor" href="#judge-host" aria-label="Permalink to &quot;Judge host&quot;">​</a></h2><p>A judge grades by calling a Cursor model. It needs a Cursor credential (<code>bdk login</code>, <code>CURSOR_API_KEY</code>, or <code>CURSOR_SERVICE_ACCOUNT_KEY</code>) and a judge model. The grading session offers no tools and turns the local SDK sandbox off, including any per-user sandbox config on the machine, so the same case grades on macOS, a Linux cloud agent, and a Linux CI runner.</p><p>Without a credential, or when that credential belongs to a different backend than the SDK will call, the case is skipped and the suite continues. Without a judge model, the case fails and the assertion names where to set one.</p><h2 id="datasets-and-fixtures" tabindex="-1">Datasets and fixtures <a class="header-anchor" href="#datasets-and-fixtures" aria-label="Permalink to &quot;Datasets and fixtures&quot;">​</a></h2><p>Load committed JSON, JSONL, or YAML relative to the project root:</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { defineEval, includes } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@cursor/bdk/evals&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
36
- <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { loadYaml } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@cursor/bdk/evals/loaders&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
35
+ <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">t.judge.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">sql</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(expected).</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">atLeast</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">0.9</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span></code></pre></div><p>Each grades <code>t.reply</code> by default; pass <code>{ on }</code> to grade another value. Judge configuration can live in the project config, eval, case, or call, with the nearest value winning.</p><p><code>t.judge.model(prompt)</code> returns a raw model reply for custom grading. Treat agent output as untrusted input: wrap it with <code>fenceUntrusted</code> and include <code>EVAL_JUDGE_INJECTION_GUARD</code> in the judge prompt.</p><h2 id="judge-host" tabindex="-1">Judge host <a class="header-anchor" href="#judge-host" aria-label="Permalink to &quot;Judge host&quot;">​</a></h2><p>A judge grades by calling a Cursor model. It needs a Cursor credential (<code>agent-sdk login</code>, <code>CURSOR_API_KEY</code>, or <code>CURSOR_SERVICE_ACCOUNT_KEY</code>) and a judge model. The grading session offers no tools and turns the local SDK sandbox off, including any per-user sandbox config on the machine, so the same case grades on macOS, a Linux cloud agent, and a Linux CI runner.</p><p>Without a credential, or when that credential belongs to a different backend than the SDK will call, the case is skipped and the suite continues. Without a judge model, the case fails and the assertion names where to set one.</p><h2 id="datasets-and-fixtures" tabindex="-1">Datasets and fixtures <a class="header-anchor" href="#datasets-and-fixtures" aria-label="Permalink to &quot;Datasets and fixtures&quot;">​</a></h2><p>Load committed JSON, JSONL, or YAML relative to the project root:</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { defineEval, includes } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@grok/agent-sdk/evals&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
36
+ <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { loadYaml } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@grok/agent-sdk/evals/loaders&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
37
37
  <span class="line"></span>
38
38
  <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> rows</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> await</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> loadYaml</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">&lt;</span></span>
39
39
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> Array</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">&lt;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{ </span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">task</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: string; </span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">prompt</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: string; </span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">expected</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: string }</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">&gt;</span></span>
@@ -48,9 +48,9 @@ import{_ as e,c as a,o as i,a3 as t}from"./chunks/framework.BNw1pucY.js";const k
48
48
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> t.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">check</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(t.reply, </span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">includes</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(row.expected));</span></span>
49
49
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
50
50
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> })</span></span>
51
- <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span></code></pre></div><h2 id="reporters-and-results" tabindex="-1">Reporters and results <a class="header-anchor" href="#reporters-and-results" aria-label="Permalink to &quot;Reporters and results&quot;">​</a></h2><p>Built-in reporters include <code>JUnit({ filePath, suiteName? })</code> and <code>Artifacts({ dir })</code>. Custom reporters can expose <code>onRunStart</code>, <code>onEvalComplete</code>, and <code>onRunComplete</code>.</p><p>JSON output contains run totals and one result per case. Results include the case ID, verdict, assertions, session ID, inputs, final text, tools, tool calls, metrics, logs, duration, metadata, tags, and any error or skip reason.</p><h2 id="select-cases" tabindex="-1">Select cases <a class="header-anchor" href="#select-cases" aria-label="Permalink to &quot;Select cases&quot;">​</a></h2><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>bdk eval --dir . --list</span></span>
52
- <span class="line"><span>bdk eval --dir .</span></span>
53
- <span class="line"><span>bdk eval --dir . builds/checkout</span></span>
54
- <span class="line"><span>bdk eval --dir . --tag smoke</span></span></code></pre></div><p>ID filters match an exact ID and its descendants. Repeated IDs use OR; repeated tags use OR. When both are present, a case must match both groups.</p><h2 id="inspect-run-artifacts" tabindex="-1">Inspect run artifacts <a class="header-anchor" href="#inspect-run-artifacts" aria-label="Permalink to &quot;Inspect run artifacts&quot;">​</a></h2><p>Default run artifacts go under <code>evals/&lt;stamp&gt;/</code> in the project state directory and include <code>summary.json</code>, <code>results.jsonl</code>, and <code>evals/&lt;case-id&gt;.json</code>. <code>--artifacts &lt;dir&gt;</code> chooses another destination; <code>--no-artifacts</code> disables them. This location is independent of <code>--state-root</code>.</p><h2 id="run-evals-against-a-server" tabindex="-1">Run evals against a server <a class="header-anchor" href="#run-evals-against-a-server" aria-label="Permalink to &quot;Run evals against a server&quot;">​</a></h2><p>The playground <strong>Evals</strong> view starts batches on its running server, and <code>--url</code> targets a named running server:</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>bdk eval --url http://127.0.0.1:3000/vulnerability-scanner --tag smoke</span></span>
55
- <span class="line"><span>bdk eval status &lt;eval-id&gt; --url http://127.0.0.1:3000/vulnerability-scanner</span></span>
56
- <span class="line"><span>bdk eval cancel &lt;eval-id&gt; --url http://127.0.0.1:3000/vulnerability-scanner</span></span></code></pre></div><p>Server-side batches use the target&#39;s discovered cases and return an eval ID for <code>status</code> or <code>cancel</code>. Local reporter and concurrency flags don&#39;t apply to <code>--url</code> runs.</p><h2 id="related" tabindex="-1">Related <a class="header-anchor" href="#related" aria-label="Permalink to &quot;Related&quot;">​</a></h2><ul><li><a href="./../evals.html">Evals guide</a></li><li><a href="./cli.html#eval">CLI reference</a></li><li><a href="./sessions.html">Sessions</a></li><li><a href="./artifacts.html">Artifacts</a></li></ul>`,63)])])}const E=e(n,[["render",d]]);export{k as __pageData,E as default};
51
+ <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span></code></pre></div><h2 id="reporters-and-results" tabindex="-1">Reporters and results <a class="header-anchor" href="#reporters-and-results" aria-label="Permalink to &quot;Reporters and results&quot;">​</a></h2><p>Built-in reporters include <code>JUnit({ filePath, suiteName? })</code> and <code>Artifacts({ dir })</code>. Custom reporters can expose <code>onRunStart</code>, <code>onEvalComplete</code>, and <code>onRunComplete</code>.</p><p>JSON output contains run totals and one result per case. Results include the case ID, verdict, assertions, session ID, inputs, final text, tools, tool calls, metrics, logs, duration, metadata, tags, and any error or skip reason.</p><h2 id="select-cases" tabindex="-1">Select cases <a class="header-anchor" href="#select-cases" aria-label="Permalink to &quot;Select cases&quot;">​</a></h2><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>agent-sdk eval --dir . --list</span></span>
52
+ <span class="line"><span>agent-sdk eval --dir .</span></span>
53
+ <span class="line"><span>agent-sdk eval --dir . builds/checkout</span></span>
54
+ <span class="line"><span>agent-sdk eval --dir . --tag smoke</span></span></code></pre></div><p>ID filters match an exact ID and its descendants. Repeated IDs use OR; repeated tags use OR. When both are present, a case must match both groups.</p><h2 id="inspect-run-artifacts" tabindex="-1">Inspect run artifacts <a class="header-anchor" href="#inspect-run-artifacts" aria-label="Permalink to &quot;Inspect run artifacts&quot;">​</a></h2><p>Default run artifacts go under <code>evals/&lt;stamp&gt;/</code> in the project state directory and include <code>summary.json</code>, <code>results.jsonl</code>, and <code>evals/&lt;case-id&gt;.json</code>. <code>--artifacts &lt;dir&gt;</code> chooses another destination; <code>--no-artifacts</code> disables them. This location is independent of <code>--state-root</code>.</p><h2 id="run-evals-against-a-server" tabindex="-1">Run evals against a server <a class="header-anchor" href="#run-evals-against-a-server" aria-label="Permalink to &quot;Run evals against a server&quot;">​</a></h2><p>The playground <strong>Evals</strong> view starts batches on its running server, and <code>--url</code> targets a named running server:</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>agent-sdk eval --url http://127.0.0.1:3000/vulnerability-scanner --tag smoke</span></span>
55
+ <span class="line"><span>agent-sdk eval get &lt;eval-id&gt; --url http://127.0.0.1:3000/vulnerability-scanner</span></span>
56
+ <span class="line"><span>agent-sdk eval cancel &lt;eval-id&gt; --url http://127.0.0.1:3000/vulnerability-scanner</span></span></code></pre></div><p>Server-side batches use the target&#39;s discovered cases and return an eval ID for <code>status</code> or <code>cancel</code>. Local reporter and concurrency flags don&#39;t apply to <code>--url</code> runs.</p><h2 id="related" tabindex="-1">Related <a class="header-anchor" href="#related" aria-label="Permalink to &quot;Related&quot;">​</a></h2><ul><li><a href="./../evals.html">Evals guide</a></li><li><a href="./cli.html#eval">CLI reference</a></li><li><a href="./sessions.html">Sessions</a></li><li><a href="./artifacts.html">Artifacts</a></li></ul>`,63)])])}const E=e(n,[["render",d]]);export{k as __pageData,E as default};
@@ -1,16 +1,16 @@
1
- import{_ as i,c as a,o as n,a3 as e}from"./chunks/framework.BNw1pucY.js";const c=JSON.parse('{"title":"Extensions","description":"Mount a namespaced package of tools, skills, connections, and other agent capabilities, then inspect or override what it adds.","frontmatter":{"title":"Extensions","description":"Mount a namespaced package of tools, skills, connections, and other agent capabilities, then inspect or override what it adds."},"headers":[],"relativePath":"reference/extensions.md","filePath":"reference/extensions.md"}'),t={name:"reference/extensions.md"};function l(p,s,o,h,d,r){return n(),a("div",null,[...s[0]||(s[0]=[e(`<h1 id="extensions" tabindex="-1">Extensions <a class="header-anchor" href="#extensions" aria-label="Permalink to &quot;Extensions&quot;">​</a></h1><p>An extension packages capabilities that would otherwise live under <code>bot/</code>: tools, skills, instructions, connections, hooks, channels, schedules, subagents, artifacts, and workspace seeds. One mount file adds them under a namespace without copying their source into your project.</p><p>Extensions and Cursor plugins execute as trusted host code. A namespace prevents name collisions; it does not sandbox the package or limit its side effects. Review the package before mounting it.</p><h2 id="mount-an-extension" tabindex="-1">Mount an extension <a class="header-anchor" href="#mount-an-extension" aria-label="Permalink to &quot;Mount an extension&quot;">​</a></h2><p>Install the package and add one file under <code>bot/extensions/</code>. The filename becomes the namespace, so this mount contributes names such as <code>ci__failed_jobs</code> and <code>ci__triage</code>.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// bot/extensions/ci.ts</span></span>
1
+ import{_ as i,c as a,o as n,a3 as e}from"./chunks/framework.BNw1pucY.js";const c=JSON.parse('{"title":"Extensions","description":"Mount a namespaced package of tools, skills, connections, and other agent capabilities, then inspect or override what it adds.","frontmatter":{"title":"Extensions","description":"Mount a namespaced package of tools, skills, connections, and other agent capabilities, then inspect or override what it adds."},"headers":[],"relativePath":"reference/extensions.md","filePath":"reference/extensions.md"}'),t={name:"reference/extensions.md"};function l(p,s,o,h,d,k){return n(),a("div",null,[...s[0]||(s[0]=[e(`<h1 id="extensions" tabindex="-1">Extensions <a class="header-anchor" href="#extensions" aria-label="Permalink to &quot;Extensions&quot;">​</a></h1><p>An extension packages capabilities that would otherwise live under <code>bot/</code>: tools, skills, instructions, connections, hooks, channels, schedules, subagents, artifacts, and workspace seeds. One mount file adds them under a namespace without copying their source into your project.</p><p>Extensions and Cursor plugins execute as trusted host code. A namespace prevents name collisions; it does not sandbox the package or limit its side effects. Review the package before mounting it.</p><h2 id="mount-an-extension" tabindex="-1">Mount an extension <a class="header-anchor" href="#mount-an-extension" aria-label="Permalink to &quot;Mount an extension&quot;">​</a></h2><p>Install the package and add one file under <code>bot/extensions/</code>. The filename becomes the namespace, so this mount contributes names such as <code>ci__failed_jobs</code> and <code>ci__triage</code>.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// bot/extensions/ci.ts</span></span>
2
2
  <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ci </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@acme/ci-triage&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
3
3
  <span class="line"></span>
4
4
  <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> ci</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
5
5
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> org: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;acme&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
6
6
  <span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> token</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: () </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=&gt;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> process.env.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">BUILDKITE_TOKEN</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> ??</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
7
- <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>Pass <code>token</code> as a function so a tool can call it. The function reads <code>BUILDKITE_TOKEN</code> when the tool calls it.</p><p>The extension validates its configuration while the project loads. Missing or mistyped settings fail <code>bdk validate</code> before a turn can call the contributed code.</p><p>Extension instructions are appended to the root agent&#39;s instructions. The root agent still needs its own <code>bot/instructions.md</code>.</p><h2 id="inspect-a-mount" tabindex="-1">Inspect a mount <a class="header-anchor" href="#inspect-a-mount" aria-label="Permalink to &quot;Inspect a mount&quot;">​</a></h2><p>Run discovery after mounting or upgrading an extension:</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>bdk validate --dir .</span></span>
8
- <span class="line"><span>bdk info --dir . --json</span></span></code></pre></div><p><code>info</code> lists each mount and its namespaced tools, skills, connections, hooks, channels, schedules, subagents, and artifact kinds. The same data appears under <code>extensions</code> in <code>GET /v1/info</code>.</p><p>A mount can also widen what a hosted deployment reaches. <code>info</code> shows the egress hosts and secret names each mount adds, and <code>bdk deploy</code> names every extension that adds egress before it deploys.</p><p>Names inside the extension stay short. A tool authored as <code>tools/failed_jobs.ts</code> appears to the mounting agent as <code>&lt;namespace&gt;__failed_jobs</code>. The <code>__</code> separator is reserved, so root contributions cannot impersonate a mounted one.</p><h2 id="adjust-a-mounted-extension" tabindex="-1">Adjust a mounted extension <a class="header-anchor" href="#adjust-a-mounted-extension" aria-label="Permalink to &quot;Adjust a mounted extension&quot;">​</a></h2><p>Mount as a directory when you need to replace or remove one contribution. Keep the package mount in <code>extension.ts</code>, then overlay the extension&#39;s short name beneath it.</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>bot/extensions/ci/</span></span>
7
+ <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>Pass <code>token</code> as a function so a tool can call it. The function reads <code>BUILDKITE_TOKEN</code> when the tool calls it.</p><p>The extension validates its configuration while the project loads. Missing or mistyped settings fail <code>agent-sdk validate</code> before a turn can call the contributed code.</p><p>Extension instructions are appended to the root agent&#39;s instructions. The root agent still needs its own <code>bot/instructions.md</code>.</p><h2 id="inspect-a-mount" tabindex="-1">Inspect a mount <a class="header-anchor" href="#inspect-a-mount" aria-label="Permalink to &quot;Inspect a mount&quot;">​</a></h2><p>Run discovery after mounting or upgrading an extension:</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>agent-sdk validate --dir .</span></span>
8
+ <span class="line"><span>agent-sdk info --dir . --json</span></span></code></pre></div><p><code>info</code> lists each mount and its namespaced tools, skills, connections, hooks, channels, schedules, subagents, and artifact kinds. The same data appears under <code>extensions</code> in <code>GET /v1/info</code>.</p><p>A mount can also widen what a hosted deployment reaches. <code>info</code> shows the egress hosts and secret names each mount adds, and <code>agent-sdk deploy</code> names every extension that adds egress before it deploys.</p><p>Names inside the extension stay short. A tool authored as <code>tools/failed_jobs.ts</code> appears to the mounting agent as <code>&lt;namespace&gt;__failed_jobs</code>. The <code>__</code> separator is reserved, so root contributions cannot impersonate a mounted one.</p><h2 id="adjust-a-mounted-extension" tabindex="-1">Adjust a mounted extension <a class="header-anchor" href="#adjust-a-mounted-extension" aria-label="Permalink to &quot;Adjust a mounted extension&quot;">​</a></h2><p>Mount as a directory when you need to replace or remove one contribution. Keep the package mount in <code>extension.ts</code>, then overlay the extension&#39;s short name beneath it.</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>bot/extensions/ci/</span></span>
9
9
  <span class="line"><span> extension.ts</span></span>
10
10
  <span class="line"><span> tools/</span></span>
11
11
  <span class="line"><span> job_log.ts</span></span>
12
12
  <span class="line"><span> retry_job.ts</span></span></code></pre></div><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// bot/extensions/ci/tools/job_log.ts</span></span>
13
- <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { defineTool } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@cursor/bdk/tools&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
13
+ <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { defineTool } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@grok/agent-sdk/tools&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
14
14
  <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
15
15
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> jobLogInput,</span></span>
16
16
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> readRedactedLog,</span></span>
@@ -21,17 +21,17 @@ import{_ as i,c as a,o as n,a3 as e}from"./chunks/framework.BNw1pucY.js";const c
21
21
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> inputSchema: jobLogInput,</span></span>
22
22
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> execute: readRedactedLog,</span></span>
23
23
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// bot/extensions/ci/tools/retry_job.ts</span></span>
24
- <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { disableTool } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@cursor/bdk/extensions&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
24
+ <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { disableTool } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@grok/agent-sdk/extensions&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
25
25
  <span class="line"></span>
26
- <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> disableTool</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">();</span></span></code></pre></div><p>The first file replaces <code>ci__job_log</code>; the second removes <code>ci__retry_job</code>. Use the matching <code>disable*</code> helper for another slot, or generic <code>disable()</code> when the file location already identifies it. Validation fails when an overlay names a contribution the package does not provide.</p><h2 id="mount-a-cursor-plugin" tabindex="-1">Mount a Cursor plugin <a class="header-anchor" href="#mount-a-cursor-plugin" aria-label="Permalink to &quot;Mount a Cursor plugin&quot;">​</a></h2><p><code>cursorPlugin()</code> adapts a vendored Cursor or Claude plugin into the same namespace model. Skills, commands, agents, and MCP servers become BDK skills, subagents, and connections.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// bot/extensions/notion.ts</span></span>
27
- <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { cursorPlugin } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@cursor/bdk/extensions&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
26
+ <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> disableTool</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">();</span></span></code></pre></div><p>The first file replaces <code>ci__job_log</code>; the second removes <code>ci__retry_job</code>. Use the matching <code>disable*</code> helper for another slot, or generic <code>disable()</code> when the file location already identifies it. Validation fails when an overlay names a contribution the package does not provide.</p><h2 id="mount-a-cursor-plugin" tabindex="-1">Mount a Cursor plugin <a class="header-anchor" href="#mount-a-cursor-plugin" aria-label="Permalink to &quot;Mount a Cursor plugin&quot;">​</a></h2><p><code>cursorPlugin()</code> adapts a vendored Cursor or Claude plugin into the same namespace model. Skills, commands, agents, and MCP servers become Agent SDK skills, subagents, and connections.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// bot/extensions/notion.ts</span></span>
27
+ <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { cursorPlugin } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@grok/agent-sdk/extensions&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
28
28
  <span class="line"></span>
29
29
  <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> cursorPlugin</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
30
30
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> path: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;plugins/notion-workspace&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
31
31
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> variables: {</span></span>
32
32
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> NOTION_TOKEN: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;\${NOTION_TOKEN}&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
33
33
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
34
- <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p><code>path</code> is relative to the project root. <code>variables</code> fills placeholders declared by the plugin&#39;s MCP configuration. Pass a <code>\${NAME}</code> template. The connection reads <code>NAME</code> when it opens. An unresolved placeholder fails validation instead of mounting a partial server.</p><p>Plugin rules and hooks are not mounted. Overlay a generated <code>mcp-connections/&lt;server&gt;.ts</code> file to replace or disable one plugin server. OAuth-backed plugin servers use <a href="./../guides/mcp-oauth.html">Host MCP OAuth</a>; transport and tool-filter details live in <a href="./connections.html">MCP connections</a>.</p><h2 id="extension-contents" tabindex="-1">Extension contents <a class="header-anchor" href="#extension-contents" aria-label="Permalink to &quot;Extension contents&quot;">​</a></h2><table tabindex="0"><thead><tr><th>Ships under the namespace</th><th>Ignored</th></tr></thead><tbody><tr><td>Instructions, tools, skills, MCP and host connections</td><td><code>agent.ts</code>, storage, OpenTelemetry</td></tr><tr><td>Hooks, channels, schedules, and subagents</td><td>Playground code, custom sandbox backends</td></tr><tr><td>Artifact kinds and workspace seed files</td><td>Nested extensions</td></tr></tbody></table><p><code>bdk validate</code> reports unsupported paths.</p><h2 id="build-an-extension" tabindex="-1">Build an extension <a class="header-anchor" href="#build-an-extension" aria-label="Permalink to &quot;Build an extension&quot;">​</a></h2><p>Lay out the package like the shareable part of <code>bot/</code>. The root <code>extension.ts</code> supplies a description and validates any settings the consumer must provide.</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>@acme/ci-triage/</span></span>
34
+ <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p><code>path</code> is relative to the project root. <code>variables</code> fills placeholders declared by the plugin&#39;s MCP configuration. Pass a <code>\${NAME}</code> template. The connection reads <code>NAME</code> when it opens. An unresolved placeholder fails validation instead of mounting a partial server.</p><p>Plugin rules and hooks are not mounted. Overlay a generated <code>mcp-connections/&lt;server&gt;.ts</code> file to replace or disable one plugin server. OAuth-backed plugin servers use <a href="./../guides/mcp-oauth.html">Host MCP OAuth</a>; transport and tool-filter details live in <a href="./connections.html">MCP connections</a>.</p><h2 id="extension-contents" tabindex="-1">Extension contents <a class="header-anchor" href="#extension-contents" aria-label="Permalink to &quot;Extension contents&quot;">​</a></h2><table tabindex="0"><thead><tr><th>Ships under the namespace</th><th>Ignored</th></tr></thead><tbody><tr><td>Instructions, tools, skills, MCP and host connections</td><td><code>agent.ts</code>, storage, OpenTelemetry</td></tr><tr><td>Hooks, channels, schedules, and subagents</td><td>Playground code, custom sandbox backends</td></tr><tr><td>Artifact kinds and workspace seed files</td><td>Nested extensions</td></tr></tbody></table><p><code>agent-sdk validate</code> reports unsupported paths.</p><h2 id="build-an-extension" tabindex="-1">Build an extension <a class="header-anchor" href="#build-an-extension" aria-label="Permalink to &quot;Build an extension&quot;">​</a></h2><p>Lay out the package like the shareable part of <code>bot/</code>. The root <code>extension.ts</code> supplies a description and validates any settings the consumer must provide.</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>@acme/ci-triage/</span></span>
35
35
  <span class="line"><span> package.json</span></span>
36
36
  <span class="line"><span> extension.ts</span></span>
37
37
  <span class="line"><span> instructions.md</span></span>
@@ -44,7 +44,7 @@ import{_ as i,c as a,o as n,a3 as e}from"./chunks/framework.BNw1pucY.js";const c
44
44
  <span class="line"><span> audit.ts</span></span>
45
45
  <span class="line"><span> lib/</span></span>
46
46
  <span class="line"><span> buildkite.ts</span></span></code></pre></div><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// extension.ts</span></span>
47
- <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { defineExtension } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@cursor/bdk/extensions&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
47
+ <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { defineExtension } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@grok/agent-sdk/extensions&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
48
48
  <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { z } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;zod&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
49
49
  <span class="line"></span>
50
50
  <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> defineExtension</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
@@ -1 +1 @@
1
- import{_ as i,c as a,o as n,a3 as e}from"./chunks/framework.BNw1pucY.js";const c=JSON.parse('{"title":"Extensions","description":"Mount a namespaced package of tools, skills, connections, and other agent capabilities, then inspect or override what it adds.","frontmatter":{"title":"Extensions","description":"Mount a namespaced package of tools, skills, connections, and other agent capabilities, then inspect or override what it adds."},"headers":[],"relativePath":"reference/extensions.md","filePath":"reference/extensions.md"}'),t={name:"reference/extensions.md"};function l(p,s,o,h,d,r){return n(),a("div",null,[...s[0]||(s[0]=[e("",38)])])}const E=i(t,[["render",l]]);export{c as __pageData,E as default};
1
+ import{_ as i,c as a,o as n,a3 as e}from"./chunks/framework.BNw1pucY.js";const c=JSON.parse('{"title":"Extensions","description":"Mount a namespaced package of tools, skills, connections, and other agent capabilities, then inspect or override what it adds.","frontmatter":{"title":"Extensions","description":"Mount a namespaced package of tools, skills, connections, and other agent capabilities, then inspect or override what it adds."},"headers":[],"relativePath":"reference/extensions.md","filePath":"reference/extensions.md"}'),t={name:"reference/extensions.md"};function l(p,s,o,h,d,k){return n(),a("div",null,[...s[0]||(s[0]=[e("",38)])])}const E=i(t,[["render",l]]);export{c as __pageData,E as default};
@@ -1,6 +1,6 @@
1
- import{_ as e,c as t,o as a,a3 as i}from"./chunks/framework.BNw1pucY.js";const c=JSON.parse('{"title":"Hooks","description":"Observe-only subscribers to the session event stream: audit logs, metrics, transcript mirrors, derived state.","frontmatter":{"title":"Hooks","description":"Observe-only subscribers to the session event stream: audit logs, metrics, transcript mirrors, derived state."},"headers":[],"relativePath":"reference/hooks.md","filePath":"reference/hooks.md"}'),n={name:"reference/hooks.md"};function o(d,s,h,l,r,k){return a(),t("div",null,[...s[0]||(s[0]=[i(`<h1 id="hooks" tabindex="-1">Hooks <a class="header-anchor" href="#hooks" aria-label="Permalink to &quot;Hooks&quot;">​</a></h1><p>A hook subscribes to selected session events and can run a side effect after each matching event is recorded: an audit line, a metric, a transcript copy, or derived state. Hooks run in the serving process for every session of the agent. They cannot change the turn, the prompt, or the reply; a handler that throws is logged and skipped.</p><p>Treat the event as read-only. Later subscribers see the same object. That makes hooks safe to add to a production agent, and the wrong surface for anything that must run before the model or must fail a turn; see <a href="#hook-boundaries">Hook boundaries</a>.</p><p><code>defineHook</code> is unrelated to <a href="https://cursor.com/docs/agent/hooks" target="_blank" rel="noreferrer">Cursor Agent hooks</a>, the <code>.cursor/hooks.json</code> scripts that can observe, block, or modify the agent loop. Those still run inside a local session workspace.</p><h2 id="author-a-hook" tabindex="-1">Author a hook <a class="header-anchor" href="#author-a-hook" aria-label="Permalink to &quot;Author a hook&quot;">​</a></h2><p>Author <code>bot/hooks/&lt;name&gt;.ts</code> with <code>defineHook</code> from <code>@cursor/bdk/hooks</code>. This one meters tokens:</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// bot/hooks/usage.ts</span></span>
1
+ import{_ as e,c as t,o as a,a3 as i}from"./chunks/framework.BNw1pucY.js";const c=JSON.parse('{"title":"Hooks","description":"Observe-only subscribers to the session event stream: audit logs, metrics, transcript mirrors, derived state.","frontmatter":{"title":"Hooks","description":"Observe-only subscribers to the session event stream: audit logs, metrics, transcript mirrors, derived state."},"headers":[],"relativePath":"reference/hooks.md","filePath":"reference/hooks.md"}'),n={name:"reference/hooks.md"};function o(d,s,h,l,r,k){return a(),t("div",null,[...s[0]||(s[0]=[i(`<h1 id="hooks" tabindex="-1">Hooks <a class="header-anchor" href="#hooks" aria-label="Permalink to &quot;Hooks&quot;">​</a></h1><p>A hook subscribes to selected session events and can run a side effect after each matching event is recorded: an audit line, a metric, a transcript copy, or derived state. Hooks run in the serving process for every session of the agent. They cannot change the turn, the prompt, or the reply; a handler that throws is logged and skipped.</p><p>Treat the event as read-only. Later subscribers see the same object. That makes hooks safe to add to a production agent, and the wrong surface for anything that must run before the model or must fail a turn; see <a href="#hook-boundaries">Hook boundaries</a>.</p><p><code>defineHook</code> is unrelated to <a href="https://cursor.com/docs/agent/hooks" target="_blank" rel="noreferrer">Cursor Agent hooks</a>, the <code>.cursor/hooks.json</code> scripts that can observe, block, or modify the agent loop. Those still run inside a local session workspace.</p><h2 id="author-a-hook" tabindex="-1">Author a hook <a class="header-anchor" href="#author-a-hook" aria-label="Permalink to &quot;Author a hook&quot;">​</a></h2><p>Author <code>bot/hooks/&lt;name&gt;.ts</code> with <code>defineHook</code> from <code>@grok/agent-sdk/hooks</code>. This one meters tokens:</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// bot/hooks/usage.ts</span></span>
2
2
  <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { metrics } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@opentelemetry/api&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
3
- <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { defineHook } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@cursor/bdk/hooks&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
3
+ <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { defineHook } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@grok/agent-sdk/hooks&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
4
4
  <span class="line"></span>
5
5
  <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> meter</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> metrics.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">getMeter</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;acme&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
6
6
  <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> inputTokens</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> meter.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">createCounter</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;acme.tokens.input&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
@@ -21,8 +21,8 @@ import{_ as e,c as t,o as a,a3 as i}from"./chunks/framework.BNw1pucY.js";const c
21
21
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> turnFailed.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">add</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">1</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, { channel: ctx.channel.id });</span></span>
22
22
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
23
23
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
24
- <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>Any module under <code>bot/hooks/</code>, subfolders included, is a hook named by its path without the extension: <code>bot/hooks/audit/usage.ts</code> is <code>audit/usage</code>. <code>*.test.ts</code> and <code>*.spec.ts</code> files are skipped. The default export must be <code>defineHook(...)</code>, names can&#39;t contain <code>__</code>, and an empty <code>events</code> map skips the hook with a warning; <code>bdk validate</code> reports all three. An extension mounts its hooks as <code>&lt;ns&gt;__&lt;name&gt;</code>, and <code>disableHook()</code> removes one (<a href="./extensions.html#adjust-a-mounted-extension">Adjust a mounted extension</a>).</p><p><code>bdk init</code> scaffolds <code>bot/hooks/memory.ts</code>, which exports <code>memoryHook()</code> from <code>@cursor/bdk/memory</code> and journals every turn for later sessions to read. Delete the file to opt out. See <a href="./memory.html">Memory</a>.</p><h2 id="events-and-payloads" tabindex="-1">Events and payloads <a class="header-anchor" href="#events-and-payloads" aria-label="Permalink to &quot;Events and payloads&quot;">​</a></h2><p>Keys are event types from the <a href="./sessions.html#stream-events">event vocabulary</a>, or <code>&quot;*&quot;</code> for every event. A typed key narrows <code>event.data</code>; a <code>&quot;*&quot;</code> handler receives the union, so switch on <code>event.type</code>. Every event carries the stream envelope <code>{ type, index, sessionId, turnId?, at, data }</code>, with <code>turnId</code> set on turn-scoped events. Skip <code>*.appended</code> deltas when you want the final text; <code>message.completed</code> already has it.</p><table tabindex="0"><thead><tr><th>Event</th><th><code>event.data</code></th></tr></thead><tbody><tr><td><code>message.received</code></td><td><code>{ text }</code></td></tr><tr><td><code>turn.completed</code></td><td><code>{ result?, usage?, cost? }</code>. <code>usage</code> has <code>inputTokens</code>, <code>outputTokens</code>, <code>cacheReadTokens</code>, <code>cacheWriteTokens</code>, and optional <code>reasoningTokens</code>. <code>cost</code> has <code>totalUsd</code> and the <code>model</code> it was priced against</td></tr><tr><td><code>turn.failed</code></td><td><code>{ message, status? }</code>. <code>status</code> is <code>&quot;error&quot;</code> or <code>&quot;cancelled&quot;</code> when present</td></tr><tr><td><code>actions.requested</code></td><td><code>{ calls: [{ callId, toolName, args?, parentCallId? }], parentCallId? }</code>. One envelope per model step once that step has listed its tools. A single tool is a batch of one. <code>parentCallId</code> marks subagent work</td></tr><tr><td><code>actions.completed</code></td><td><code>{ results: [{ callId, toolName, output?, isError, stubbed?, parentCallId? }], parentCallId? }</code>. Pair with <code>actions.requested</code>; emitted when every call in that batch has a result</td></tr><tr><td><code>action.result</code></td><td><code>{ callId, toolName, output?, isError, stubbed?, parentCallId? }</code>. Live per-call envelope for chips and spans. <code>stubbed</code> means a dry-run session answered a write without running it</td></tr><tr><td><code>action.tool_retry</code></td><td><code>{ callId, toolName, attempt, reason, connection? }</code>. A read is running again after a transient failure. <code>attempt</code> is the try about to run. <code>reason</code> is a class such as <code>transport</code> or <code>http_503</code></td></tr></tbody></table><p>The types are <code>SessionEvent</code>, <code>SessionEventType</code>, and <code>HookContext</code>, exported from <code>@cursor/bdk</code>.</p><h2 id="handler-context" tabindex="-1">Handler context <a class="header-anchor" href="#handler-context" aria-label="Permalink to &quot;Handler context&quot;">​</a></h2><table tabindex="0"><thead><tr><th>Member</th><th>What it is</th></tr></thead><tbody><tr><td><code>ctx.session</code></td><td>Read-only session info: <code>id</code>, <code>channelId</code>, <code>mode</code> (<code>chat</code> or <code>task</code>), <code>purpose</code> (<code>live</code> or <code>eval</code>), <code>auth</code>, plus <code>title</code> and <code>sdkAgentId</code> when set</td></tr><tr><td><code>ctx.agent</code></td><td><code>{ name }</code> of the agent the event belongs to</td></tr><tr><td><code>ctx.channel</code></td><td><code>{ id, continuationToken }</code>. The token is <code>null</code> when the session can&#39;t take follow-ups</td></tr><tr><td><code>ctx.host.kv</code></td><td>Durable JSON, shared by every session of the agent. Prefix keys with <code>ctx.session.id</code> for per-session state</td></tr><tr><td><code>ctx.host.files</code></td><td>Durable files, bound to this session. Pass <code>{ scope: &quot;deployment&quot; }</code> for agent-wide files</td></tr><tr><td><code>ctx.host.mcp</code>, <code>ctx.host.github</code>, <code>ctx.host.slack</code></td><td>The same shared clients tools get</td></tr><tr><td><code>ctx.host.reminders</code></td><td>Per-session <a href="./schedules.html#reminders">reminders</a>, the same API tools get</td></tr><tr><td><code>ctx.artifacts</code></td><td>Session-bound <a href="./artifacts.html">artifacts</a> facade: <code>tag</code> fills in <code>sessionId</code> and <code>turnId</code></td></tr><tr><td><code>ctx.stateRoot</code></td><td>Absolute path of the local state root. It resets when a hosted deployment is replaced; keep derived state in <code>kv</code> or <code>files</code></td></tr></tbody></table><h2 id="hook-dispatch" tabindex="-1">Hook dispatch <a class="header-anchor" href="#hook-dispatch" aria-label="Permalink to &quot;Hook dispatch&quot;">​</a></h2><p>A hook runs after the event is recorded. It never delays the model and never sees an event that wasn&#39;t recorded.</p><table tabindex="0"><thead><tr><th>Rule</th><th>What happens</th></tr></thead><tbody><tr><td>Same session</td><td>Events dispatch one at a time</td></tr><tr><td>Eval sessions</td><td>The same stream fires; skip metering or paging when <code>ctx.session.purpose === &quot;eval&quot;</code></td></tr><tr><td>Host restart</td><td>Recorded events are not replayed into hooks, so a mirror needs no dedupe</td></tr><tr><td>Slow handler</td><td>Holds the next event&#39;s handlers on that session, not the model. Keep handlers short and queue anything slow</td></tr></tbody></table><p>Read hosted secrets inside the handler, not at module scope. Give outbound calls a timeout; a stalled request holds later handlers on that session. Skip cancelled turns when paging; they record interrupted work.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// bot/hooks/page-on-failure.ts</span></span>
25
- <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { defineHook } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@cursor/bdk/hooks&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
24
+ <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><p>Any module under <code>bot/hooks/</code>, subfolders included, is a hook named by its path without the extension: <code>bot/hooks/audit/usage.ts</code> is <code>audit/usage</code>. <code>*.test.ts</code> and <code>*.spec.ts</code> files are skipped. The default export must be <code>defineHook(...)</code>, names can&#39;t contain <code>__</code>, and an empty <code>events</code> map skips the hook with a warning; <code>agent-sdk validate</code> reports all three. An extension mounts its hooks as <code>&lt;ns&gt;__&lt;name&gt;</code>, and <code>disableHook()</code> removes one (<a href="./extensions.html#adjust-a-mounted-extension">Adjust a mounted extension</a>).</p><p><code>agent-sdk init</code> scaffolds <code>bot/hooks/memory.ts</code>, which exports <code>memoryHook()</code> from <code>@grok/agent-sdk/memory</code> and journals every turn for later sessions to read. Delete the file to opt out. See <a href="./memory.html">Memory</a>.</p><h2 id="events-and-payloads" tabindex="-1">Events and payloads <a class="header-anchor" href="#events-and-payloads" aria-label="Permalink to &quot;Events and payloads&quot;">​</a></h2><p>Keys are event types from the <a href="./sessions.html#stream-events">event vocabulary</a>, or <code>&quot;*&quot;</code> for every event. A typed key narrows <code>event.data</code>; a <code>&quot;*&quot;</code> handler receives the union, so switch on <code>event.type</code>. Every event carries the stream envelope <code>{ type, index, sessionId, turnId?, at, data }</code>, with <code>turnId</code> set on turn-scoped events. Skip <code>*.appended</code> deltas when you want the final text; <code>message.completed</code> already has it.</p><table tabindex="0"><thead><tr><th>Event</th><th><code>event.data</code></th></tr></thead><tbody><tr><td><code>message.received</code></td><td><code>{ text }</code></td></tr><tr><td><code>turn.completed</code></td><td><code>{ result?, usage?, cost? }</code>. <code>usage</code> has <code>inputTokens</code>, <code>outputTokens</code>, <code>cacheReadTokens</code>, <code>cacheWriteTokens</code>, and optional <code>reasoningTokens</code>. <code>cost</code> has <code>totalUsd</code> and the <code>model</code> it was priced against</td></tr><tr><td><code>turn.failed</code></td><td><code>{ message, status? }</code>. <code>status</code> is <code>&quot;error&quot;</code> or <code>&quot;cancelled&quot;</code> when present</td></tr><tr><td><code>actions.requested</code></td><td><code>{ calls: [{ callId, toolName, args?, parentCallId? }], parentCallId? }</code>. One envelope per model step once that step has listed its tools. A single tool is a batch of one. <code>parentCallId</code> marks subagent work</td></tr><tr><td><code>actions.completed</code></td><td><code>{ results: [{ callId, toolName, output?, isError, stubbed?, parentCallId? }], parentCallId? }</code>. Pair with <code>actions.requested</code>; emitted when every call in that batch has a result</td></tr><tr><td><code>action.result</code></td><td><code>{ callId, toolName, output?, isError, stubbed?, parentCallId? }</code>. Live per-call envelope for chips and spans. <code>stubbed</code> means a dry-run session answered a write without running it</td></tr><tr><td><code>action.tool_retry</code></td><td><code>{ callId, toolName, attempt, reason, connection? }</code>. A read is running again after a transient failure. <code>attempt</code> is the try about to run. <code>reason</code> is a class such as <code>transport</code> or <code>http_503</code></td></tr></tbody></table><p>The types are <code>SessionEvent</code>, <code>SessionEventType</code>, and <code>HookContext</code>, exported from <code>@grok/agent-sdk</code>.</p><h2 id="handler-context" tabindex="-1">Handler context <a class="header-anchor" href="#handler-context" aria-label="Permalink to &quot;Handler context&quot;">​</a></h2><table tabindex="0"><thead><tr><th>Member</th><th>What it is</th></tr></thead><tbody><tr><td><code>ctx.session</code></td><td>Read-only session info: <code>id</code>, <code>channelId</code>, <code>mode</code> (<code>chat</code> or <code>task</code>), <code>purpose</code> (<code>live</code> or <code>eval</code>), <code>auth</code>, plus <code>title</code> and <code>sdkAgentId</code> when set</td></tr><tr><td><code>ctx.agent</code></td><td><code>{ name }</code> of the agent the event belongs to</td></tr><tr><td><code>ctx.channel</code></td><td><code>{ id, continuationToken }</code>. The token is <code>null</code> when the session can&#39;t take follow-ups</td></tr><tr><td><code>ctx.host.kv</code></td><td>Durable JSON, shared by every session of the agent. Prefix keys with <code>ctx.session.id</code> for per-session state</td></tr><tr><td><code>ctx.host.files</code></td><td>Durable files, bound to this session. Pass <code>{ scope: &quot;deployment&quot; }</code> for agent-wide files</td></tr><tr><td><code>ctx.host.mcp</code>, <code>ctx.host.github</code>, <code>ctx.host.slack</code></td><td>The same shared clients tools get</td></tr><tr><td><code>ctx.host.reminders</code></td><td>Per-session <a href="./schedules.html#reminders">reminders</a>, the same API tools get</td></tr><tr><td><code>ctx.artifacts</code></td><td>Session-bound <a href="./artifacts.html">artifacts</a> facade: <code>tag</code> fills in <code>sessionId</code> and <code>turnId</code></td></tr><tr><td><code>ctx.stateRoot</code></td><td>Absolute path of the local state root. It resets when a hosted deployment is replaced; keep derived state in <code>kv</code> or <code>files</code></td></tr></tbody></table><h2 id="hook-dispatch" tabindex="-1">Hook dispatch <a class="header-anchor" href="#hook-dispatch" aria-label="Permalink to &quot;Hook dispatch&quot;">​</a></h2><p>A hook runs after the event is recorded. It never delays the model and never sees an event that wasn&#39;t recorded.</p><table tabindex="0"><thead><tr><th>Rule</th><th>What happens</th></tr></thead><tbody><tr><td>Same session</td><td>Events dispatch one at a time</td></tr><tr><td>Eval sessions</td><td>The same stream fires; skip metering or paging when <code>ctx.session.purpose === &quot;eval&quot;</code></td></tr><tr><td>Host restart</td><td>Recorded events are not replayed into hooks, so a mirror needs no dedupe</td></tr><tr><td>Slow handler</td><td>Holds the next event&#39;s handlers on that session, not the model. Keep handlers short and queue anything slow</td></tr></tbody></table><p>Read hosted secrets inside the handler, not at module scope. Give outbound calls a timeout; a stalled request holds later handlers on that session. Skip cancelled turns when paging; they record interrupted work.</p><div class="language-ts vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">ts</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// bot/hooks/page-on-failure.ts</span></span>
25
+ <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { defineHook } </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &quot;@grok/agent-sdk/hooks&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
26
26
  <span class="line"></span>
27
27
  <span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">export</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> default</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> defineHook</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
28
28
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> events: {</span></span>
@@ -48,4 +48,4 @@ import{_ as e,c as t,o as a,a3 as i}from"./chunks/framework.BNw1pucY.js";const c
48
48
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> });</span></span>
49
49
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
50
50
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> },</span></span>
51
- <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><h2 id="hooks-vs-channels-vs-evals" tabindex="-1">Hooks vs channels vs evals <a class="header-anchor" href="#hooks-vs-channels-vs-evals" aria-label="Permalink to &quot;Hooks vs channels vs evals&quot;">​</a></h2><p>All three consume the same stream, for different jobs:</p><table tabindex="0"><thead><tr><th></th><th>Hooks</th><th>Channel <code>events</code></th><th>Evals</th></tr></thead><tbody><tr><td>Scope</td><td>every session of the agent</td><td>sessions the channel owns</td><td>one test turn</td></tr><tr><td>Job</td><td>observe: audit, metrics, mirrors, derived state</td><td>deliver: replies back to the channel&#39;s surface</td><td>assert: gates over the trajectory</td></tr><tr><td>Context</td><td><code>ctx.host</code>, <code>ctx.artifacts</code>, session info</td><td><code>channel.state</code>, <code>setContinuationToken</code>, <code>ctx.host</code>, session info</td><td>the <code>t</code> assertion helpers</td></tr><tr><td>Can affect the run</td><td>no</td><td>yes, it owns the surface</td><td>n/a</td></tr><tr><td>Authored at</td><td><code>bot/hooks/*.ts</code></td><td>channel config</td><td><code>evals/**/*.eval.ts</code></td></tr></tbody></table><h2 id="hook-boundaries" tabindex="-1">Hook boundaries <a class="header-anchor" href="#hook-boundaries" aria-label="Permalink to &quot;Hook boundaries&quot;">​</a></h2><table tabindex="0"><thead><tr><th>You want to</th><th>Use instead</th></tr></thead><tbody><tr><td>Add context before the model runs</td><td>The channel&#39;s <code>send</code> message and <code>workspaceFiles</code>, <code>instructions.md</code>, skills, or <code>sandbox/workspace/</code> seed files</td></tr><tr><td>Reply on Slack, comment on a PR, or post any other delivery</td><td>The channel&#39;s <code>events</code> map, or the Slack and GitHub packs</td></tr><tr><td>Show PR progress (merge-box check, sticky banner)</td><td><code>githubChannel({ progress: { commitStatus, banner } })</code>; see <a href="./../guides/github.html">GitHub agents</a></td></tr><tr><td>Gate a change on behavior</td><td><a href="./../evals.html">Evals</a></td></tr></tbody></table><p>To act on a turn&#39;s decision, such as a label or a ticket, have the model record it with an authored <a href="./tools.html">tool</a>. A <code>turn.completed</code> hook then reads the recorded decision and acts on it through <code>ctx.host</code>.</p><h2 id="test-a-hook" tabindex="-1">Test a hook <a class="header-anchor" href="#test-a-hook" aria-label="Permalink to &quot;Test a hook&quot;">​</a></h2><p>A hook definition is a plain object, so a unit test calls <code>hook.events[&quot;turn.completed&quot;]</code> directly with an event and a stub <code>HookContext</code>. Discovery skips <code>*.test.ts</code>, so the test can live next to the hook.</p><table tabindex="0"><thead><tr><th>Command</th><th>What it reports</th></tr></thead><tbody><tr><td><code>bdk validate --dir .</code></td><td>Discovery errors and the empty-handlers warning</td></tr><tr><td><code>bdk info --dir . --json</code></td><td>Loaded hooks under <code>agents[].hooks</code></td></tr><tr><td><code>bdk run --dir . --message &quot;…&quot;</code></td><td>Serve log on stderr, including <code>hook &quot;&lt;name&gt;&quot; handler for &lt;event&gt; threw: …</code></td></tr></tbody></table><p>On hosting, read the same log with <a href="./cli.html#logs"><code>bdk logs</code></a>.</p><h2 id="related" tabindex="-1">Related <a class="header-anchor" href="#related" aria-label="Permalink to &quot;Related&quot;">​</a></h2><ul><li><a href="./../guides/hooks.html">Hooks guide</a>: meter usage and page on failure</li><li><a href="./sessions.html">Sessions and streaming</a>: the event vocabulary hooks observe</li><li><a href="./../guides/opentelemetry.html">OpenTelemetry</a>: OTLP traces and metrics from the same event stream</li><li><a href="./../deployment.html#observability">Deployment</a>: runtime logs and export paths</li><li><a href="./channels.html#events">Channels</a>: the delivery-side counterpart</li></ul>`,32)])])}const E=e(n,[["render",o]]);export{c as __pageData,E as default};
51
+ <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><h2 id="hooks-vs-channels-vs-evals" tabindex="-1">Hooks vs channels vs evals <a class="header-anchor" href="#hooks-vs-channels-vs-evals" aria-label="Permalink to &quot;Hooks vs channels vs evals&quot;">​</a></h2><p>All three consume the same stream, for different jobs:</p><table tabindex="0"><thead><tr><th></th><th>Hooks</th><th>Channel <code>events</code></th><th>Evals</th></tr></thead><tbody><tr><td>Scope</td><td>every session of the agent</td><td>sessions the channel owns</td><td>one test turn</td></tr><tr><td>Job</td><td>observe: audit, metrics, mirrors, derived state</td><td>deliver: replies back to the channel&#39;s surface</td><td>assert: gates over the trajectory</td></tr><tr><td>Context</td><td><code>ctx.host</code>, <code>ctx.artifacts</code>, session info</td><td><code>channel.state</code>, <code>setContinuationToken</code>, <code>ctx.host</code>, session info</td><td>the <code>t</code> assertion helpers</td></tr><tr><td>Can affect the run</td><td>no</td><td>yes, it owns the surface</td><td>n/a</td></tr><tr><td>Authored at</td><td><code>bot/hooks/*.ts</code></td><td>channel config</td><td><code>evals/**/*.eval.ts</code></td></tr></tbody></table><h2 id="hook-boundaries" tabindex="-1">Hook boundaries <a class="header-anchor" href="#hook-boundaries" aria-label="Permalink to &quot;Hook boundaries&quot;">​</a></h2><table tabindex="0"><thead><tr><th>You want to</th><th>Use instead</th></tr></thead><tbody><tr><td>Add context before the model runs</td><td>The channel&#39;s <code>send</code> message and <code>workspaceFiles</code>, <code>instructions.md</code>, skills, or <code>sandbox/workspace/</code> seed files</td></tr><tr><td>Reply on Slack, comment on a PR, or post any other delivery</td><td>The channel&#39;s <code>events</code> map, or the Slack and GitHub packs</td></tr><tr><td>Show PR progress (merge-box check, sticky banner)</td><td><code>githubChannel({ progress: { commitStatus, banner } })</code>; see <a href="./../guides/github.html">GitHub agents</a></td></tr><tr><td>Gate a change on behavior</td><td><a href="./../evals.html">Evals</a></td></tr></tbody></table><p>To act on a turn&#39;s decision, such as a label or a ticket, have the model record it with an authored <a href="./tools.html">tool</a>. A <code>turn.completed</code> hook then reads the recorded decision and acts on it through <code>ctx.host</code>.</p><h2 id="test-a-hook" tabindex="-1">Test a hook <a class="header-anchor" href="#test-a-hook" aria-label="Permalink to &quot;Test a hook&quot;">​</a></h2><p>A hook definition is a plain object, so a unit test calls <code>hook.events[&quot;turn.completed&quot;]</code> directly with an event and a stub <code>HookContext</code>. Discovery skips <code>*.test.ts</code>, so the test can live next to the hook.</p><table tabindex="0"><thead><tr><th>Command</th><th>What it reports</th></tr></thead><tbody><tr><td><code>agent-sdk validate --dir .</code></td><td>Discovery errors and the empty-handlers warning</td></tr><tr><td><code>agent-sdk info --dir . --json</code></td><td>Loaded hooks under <code>agents[].hooks</code></td></tr><tr><td><code>agent-sdk run --dir . --message &quot;…&quot;</code></td><td>Serve log on stderr, including <code>hook &quot;&lt;name&gt;&quot; handler for &lt;event&gt; threw: …</code></td></tr></tbody></table><p>On hosting, read the same log with <a href="./cli.html#logs"><code>agent-sdk logs</code></a>.</p><h2 id="related" tabindex="-1">Related <a class="header-anchor" href="#related" aria-label="Permalink to &quot;Related&quot;">​</a></h2><ul><li><a href="./../guides/hooks.html">Hooks guide</a>: meter usage and page on failure</li><li><a href="./sessions.html">Sessions and streaming</a>: the event vocabulary hooks observe</li><li><a href="./../guides/opentelemetry.html">OpenTelemetry</a>: OTLP traces and metrics from the same event stream</li><li><a href="./../deployment.html#observability">Deployment</a>: runtime logs and export paths</li><li><a href="./channels.html#events">Channels</a>: the delivery-side counterpart</li></ul>`,32)])])}const E=e(n,[["render",o]]);export{c as __pageData,E as default};