@grok/agent-sdk 0.2.28 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (528) hide show
  1. package/AGENTS.md +29 -29
  2. package/dist/bin/agent-serve.d.ts +2 -2
  3. package/dist/bin/agent-serve.js +3 -3
  4. package/dist/channels/pagerduty/api.js +1 -1
  5. package/dist/channels/pagerduty/pagerduty-channel.d.ts +1 -1
  6. package/dist/channels/pagerduty/pagerduty-channel.d.ts.map +1 -1
  7. package/dist/channels/pagerduty/pagerduty-channel.js +1 -1
  8. package/dist/channels/pagerduty/replay.d.ts +1 -1
  9. package/dist/channels/pagerduty/replay.js +4 -4
  10. package/dist/channels/slack/cli-project.js +1 -1
  11. package/dist/docs/404.html +2 -2
  12. package/dist/docs/assets/{app.DF9vlcdn.js → app.BzTUBOAD.js} +4 -4
  13. package/dist/docs/assets/building-with-agents.md.BqJ7AAjG.js +6 -0
  14. package/dist/docs/assets/{building-with-agents.md.Bf1yH2tG.lean.js → building-with-agents.md.BqJ7AAjG.lean.js} +1 -1
  15. package/dist/docs/assets/changelog.md.BWhC6DET.js +1 -0
  16. package/dist/docs/assets/changelog.md.BWhC6DET.lean.js +1 -0
  17. package/dist/docs/assets/chunks/@localSearchIndexroot.CWxwVoCG.js +1 -0
  18. package/dist/docs/assets/chunks/{VPLocalSearchBox.D8OuwKO0.js → VPLocalSearchBox.DsnRlUT5.js} +1 -1
  19. package/dist/docs/assets/chunks/{arc.DCq_TCYV.js → arc.DH8GOhiv.js} +1 -1
  20. package/dist/docs/assets/chunks/{architectureDiagram-Q4EWVU46.PWRNTPbk.js → architectureDiagram-Q4EWVU46.9m9ObyuE.js} +1 -1
  21. package/dist/docs/assets/chunks/{baseUniq.BeRPvRUL.js → baseUniq.BXHpx1lE.js} +1 -1
  22. package/dist/docs/assets/chunks/{blockDiagram-DXYQGD6D.BuRmZVSo.js → blockDiagram-DXYQGD6D.xY3EX59q.js} +1 -1
  23. package/dist/docs/assets/chunks/{c4Diagram-AHTNJAMY.7DKSMwuv.js → c4Diagram-AHTNJAMY.DnqgMVgc.js} +1 -1
  24. package/dist/docs/assets/chunks/channel.Cctv0f7X.js +1 -0
  25. package/dist/docs/assets/chunks/{chunk-4BX2VUAB.7VrO9-9i.js → chunk-4BX2VUAB.BjFxK2A3.js} +1 -1
  26. package/dist/docs/assets/chunks/{chunk-4TB4RGXK.CHystNE2.js → chunk-4TB4RGXK.BujS_Spt.js} +1 -1
  27. package/dist/docs/assets/chunks/{chunk-55IACEB6.Nuh9TbTq.js → chunk-55IACEB6.YbTjhdaM.js} +1 -1
  28. package/dist/docs/assets/chunks/{chunk-EDXVE4YY.CA0EKugm.js → chunk-EDXVE4YY.DnQ8t4GC.js} +1 -1
  29. package/dist/docs/assets/chunks/{chunk-FMBD7UC4.F9_mp7U8.js → chunk-FMBD7UC4.B67AwAmj.js} +1 -1
  30. package/dist/docs/assets/chunks/{chunk-OYMX7WX6.CEU4QfE1.js → chunk-OYMX7WX6.DrZIAFOm.js} +1 -1
  31. package/dist/docs/assets/chunks/{chunk-QZHKN3VN.B8h_x9_i.js → chunk-QZHKN3VN.BLmmydkn.js} +1 -1
  32. package/dist/docs/assets/chunks/{chunk-YZCP3GAM.Btfb-rKg.js → chunk-YZCP3GAM.DaoOfw0O.js} +1 -1
  33. package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.DU5sqchW.js +1 -0
  34. package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.DU5sqchW.js +1 -0
  35. package/dist/docs/assets/chunks/clone.B9rdNt6j.js +1 -0
  36. package/dist/docs/assets/chunks/{cose-bilkent-S5V4N54A.DKvc96Wa.js → cose-bilkent-S5V4N54A.DMQuNhM5.js} +1 -1
  37. package/dist/docs/assets/chunks/{dagre-KV5264BT.CMo0cy1b.js → dagre-KV5264BT.CZoGVuUf.js} +1 -1
  38. package/dist/docs/assets/chunks/{diagram-5BDNPKRD.DDgMOQhB.js → diagram-5BDNPKRD.CLt9uOyL.js} +1 -1
  39. package/dist/docs/assets/chunks/{diagram-G4DWMVQ6.BdJnoIsU.js → diagram-G4DWMVQ6.DpczEm1G.js} +1 -1
  40. package/dist/docs/assets/chunks/{diagram-MMDJMWI5.oSvhAZaL.js → diagram-MMDJMWI5.D4r13DvJ.js} +1 -1
  41. package/dist/docs/assets/chunks/{diagram-TYMM5635.C9zZLIE-.js → diagram-TYMM5635.CYU9eGFu.js} +1 -1
  42. package/dist/docs/assets/chunks/{erDiagram-SMLLAGMA.BNhVyccy.js → erDiagram-SMLLAGMA.QA9naWEw.js} +1 -1
  43. package/dist/docs/assets/chunks/{flowDiagram-DWJPFMVM.BEFLLBiU.js → flowDiagram-DWJPFMVM.BbNoVZYd.js} +1 -1
  44. package/dist/docs/assets/chunks/{ganttDiagram-T4ZO3ILL.BdUzXBgY.js → ganttDiagram-T4ZO3ILL.IHjDoG7r.js} +1 -1
  45. package/dist/docs/assets/chunks/{gitGraphDiagram-UUTBAWPF.Rd3LlOIJ.js → gitGraphDiagram-UUTBAWPF.B21VMdf5.js} +1 -1
  46. package/dist/docs/assets/chunks/{graph.DnJC1GpG.js → graph.DgJ4L-8V.js} +1 -1
  47. package/dist/docs/assets/chunks/{infoDiagram-42DDH7IO.xv0xntDJ.js → infoDiagram-42DDH7IO.CQjrcthc.js} +1 -1
  48. package/dist/docs/assets/chunks/{ishikawaDiagram-UXIWVN3A.BaGIlviU.js → ishikawaDiagram-UXIWVN3A.D4tPGtVo.js} +1 -1
  49. package/dist/docs/assets/chunks/{journeyDiagram-VCZTEJTY.Cof_h0fp.js → journeyDiagram-VCZTEJTY.BD3WaNbQ.js} +1 -1
  50. package/dist/docs/assets/chunks/{kanban-definition-6JOO6SKY.C5GozFuU.js → kanban-definition-6JOO6SKY.Ca0o4Tqz.js} +1 -1
  51. package/dist/docs/assets/chunks/{layout.zc9UShLc.js → layout.DXXqX4MQ.js} +1 -1
  52. package/dist/docs/assets/chunks/{linear.BoqrFVcJ.js → linear.5c61gNw4.js} +1 -1
  53. package/dist/docs/assets/chunks/{min.DwIfr8hG.js → min.B1-NAjHX.js} +1 -1
  54. package/dist/docs/assets/chunks/{mindmap-definition-QFDTVHPH.Dkq2yTtp.js → mindmap-definition-QFDTVHPH.BELznv3-.js} +1 -1
  55. package/dist/docs/assets/chunks/{pieDiagram-DEJITSTG.B4CpTmHK.js → pieDiagram-DEJITSTG.qPzO1mq5.js} +1 -1
  56. package/dist/docs/assets/chunks/{quadrantDiagram-34T5L4WZ.BqXnFC9C.js → quadrantDiagram-34T5L4WZ.CxIvzbjX.js} +1 -1
  57. package/dist/docs/assets/chunks/{requirementDiagram-MS252O5E.DhIN2z-E.js → requirementDiagram-MS252O5E.CqA0iJx8.js} +1 -1
  58. package/dist/docs/assets/chunks/{sankeyDiagram-XADWPNL6.BhxUAmg2.js → sankeyDiagram-XADWPNL6.XRTutBnb.js} +1 -1
  59. package/dist/docs/assets/chunks/{sequenceDiagram-FGHM5R23.BqgU7HU-.js → sequenceDiagram-FGHM5R23.E--7bRLQ.js} +1 -1
  60. package/dist/docs/assets/chunks/{stateDiagram-FHFEXIEX.B1BCO18N.js → stateDiagram-FHFEXIEX.C4vGu8zq.js} +1 -1
  61. package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.ECMu2BdJ.js +1 -0
  62. package/dist/docs/assets/chunks/{theme.oV7rddEz.js → theme.DMj_7q3B.js} +2 -2
  63. package/dist/docs/assets/chunks/{timeline-definition-GMOUNBTQ.oRI8UwMC.js → timeline-definition-GMOUNBTQ.C7LgNVAL.js} +1 -1
  64. package/dist/docs/assets/chunks/{vennDiagram-DHZGUBPP.DmuWrIxN.js → vennDiagram-DHZGUBPP.HUwoZcy_.js} +1 -1
  65. package/dist/docs/assets/chunks/{wardley-RL74JXVD.CEBjM5ov.js → wardley-RL74JXVD.BxFEFYZS.js} +1 -1
  66. package/dist/docs/assets/chunks/{wardleyDiagram-NUSXRM2D.m5zsCOF9.js → wardleyDiagram-NUSXRM2D.B2pSo5rB.js} +1 -1
  67. package/dist/docs/assets/chunks/{xychartDiagram-5P7HB3ND.cPN-587n.js → xychartDiagram-5P7HB3ND.NQhMiOOL.js} +1 -1
  68. package/dist/docs/assets/deployment.md.BtqJrHhp.js +31 -0
  69. package/dist/docs/assets/{deployment.md.DDmjAVbg.lean.js → deployment.md.BtqJrHhp.lean.js} +1 -1
  70. package/dist/docs/assets/evals.md.Dne6VRmZ.js +49 -0
  71. package/dist/docs/assets/evals.md.Dne6VRmZ.lean.js +1 -0
  72. package/dist/docs/assets/{guides_agent-to-agent.md.D1D5f6Jc.js → guides_agent-to-agent.md.BcmSqL2z.js} +8 -8
  73. package/dist/docs/assets/guides_agent-to-agent.md.BcmSqL2z.lean.js +1 -0
  74. package/dist/docs/assets/{guides_bitbucket.md.DkjkBRU8.js → guides_bitbucket.md.BiA6ZMFW.js} +27 -27
  75. package/dist/docs/assets/{guides_bitbucket.md.DkjkBRU8.lean.js → guides_bitbucket.md.BiA6ZMFW.lean.js} +1 -1
  76. package/dist/docs/assets/guides_cloud-agents.md.CiXAW6on.js +9 -0
  77. package/dist/docs/assets/{guides_cloud-agents.md.Ceyjv0ul.lean.js → guides_cloud-agents.md.CiXAW6on.lean.js} +1 -1
  78. package/dist/docs/assets/guides_convert-automation.md.BvTxsJ8J.js +26 -0
  79. package/dist/docs/assets/{guides_convert-automation.md.BjraCvok.lean.js → guides_convert-automation.md.BvTxsJ8J.lean.js} +1 -1
  80. package/dist/docs/assets/{guides_github.md.CgN5sNbW.js → guides_github.md.6jiEH7dg.js} +11 -19
  81. package/dist/docs/assets/{guides_github.md.CgN5sNbW.lean.js → guides_github.md.6jiEH7dg.lean.js} +1 -1
  82. package/dist/docs/assets/{guides_gitlab.md.DCE0p7_w.js → guides_gitlab.md.DcKusOcU.js} +63 -73
  83. package/dist/docs/assets/{guides_gitlab.md.DCE0p7_w.lean.js → guides_gitlab.md.DcKusOcU.lean.js} +1 -1
  84. package/dist/docs/assets/guides_improve.md.o3WOGR7n.js +16 -0
  85. package/dist/docs/assets/{guides_improve.md.BFYtrtLE.lean.js → guides_improve.md.o3WOGR7n.lean.js} +1 -1
  86. package/dist/docs/assets/{guides_jev.md.Ccw4pedT.js → guides_jev.md.DGCzkMUN.js} +20 -60
  87. package/dist/docs/assets/{guides_jev.md.Ccw4pedT.lean.js → guides_jev.md.DGCzkMUN.lean.js} +1 -1
  88. package/dist/docs/assets/{guides_mcp-oauth.md.ekpWOZCC.js → guides_mcp-oauth.md.C-Sx_IPa.js} +3 -5
  89. package/dist/docs/assets/{guides_mcp-oauth.md.ekpWOZCC.lean.js → guides_mcp-oauth.md.C-Sx_IPa.lean.js} +1 -1
  90. package/dist/docs/assets/guides_migrate.md.BbhHYeCr.js +3 -0
  91. package/dist/docs/assets/{guides_migrate.md.RS9Eu-Xh.lean.js → guides_migrate.md.BbhHYeCr.lean.js} +1 -1
  92. package/dist/docs/assets/guides_opentelemetry.md.BRSktBHt.js +26 -0
  93. package/dist/docs/assets/guides_opentelemetry.md.BRSktBHt.lean.js +1 -0
  94. package/dist/docs/assets/guides_pagerduty.md.pMXUkZZc.js +61 -0
  95. package/dist/docs/assets/guides_pagerduty.md.pMXUkZZc.lean.js +1 -0
  96. package/dist/docs/assets/guides_slack.md.BgIGG9ur.js +82 -0
  97. package/dist/docs/assets/{guides_slack.md.BqiGSYGX.lean.js → guides_slack.md.BgIGG9ur.lean.js} +1 -1
  98. package/dist/docs/assets/{guides_webhooks.md.BJk63ZTs.js → guides_webhooks.md.B5DXt2v1.js} +7 -7
  99. package/dist/docs/assets/{guides_webhooks.md.BJk63ZTs.lean.js → guides_webhooks.md.B5DXt2v1.lean.js} +1 -1
  100. package/dist/docs/assets/hillclimbing.md.3TkdF79A.js +5 -0
  101. package/dist/docs/assets/hillclimbing.md.3TkdF79A.lean.js +1 -0
  102. package/dist/docs/assets/index.md.DRfaoRCZ.js +20 -0
  103. package/dist/docs/assets/index.md.DRfaoRCZ.lean.js +1 -0
  104. package/dist/docs/assets/quickstart.md.r-oE8nkX.js +113 -0
  105. package/dist/docs/assets/{quickstart.md.DaLk4ZIF.lean.js → quickstart.md.r-oE8nkX.lean.js} +1 -1
  106. package/dist/docs/assets/reference_access.md.C5lblfUC.js +1 -0
  107. package/dist/docs/assets/{reference_access.md.CExlH_mR.lean.js → reference_access.md.C5lblfUC.lean.js} +1 -1
  108. package/dist/docs/assets/reference_agent-config.md.C0Tp_Fk9.js +27 -0
  109. package/dist/docs/assets/{reference_agent-config.md.11E_xe--.lean.js → reference_agent-config.md.C0Tp_Fk9.lean.js} +1 -1
  110. package/dist/docs/assets/reference_artifacts.md.BJpAI7h9.js +17 -0
  111. package/dist/docs/assets/{reference_artifacts.md.C-hKR2hp.lean.js → reference_artifacts.md.BJpAI7h9.lean.js} +1 -1
  112. package/dist/docs/assets/reference_channels.md.CPWOpdsC.js +21 -0
  113. package/dist/docs/assets/{reference_channels.md.DsJfGSBJ.lean.js → reference_channels.md.CPWOpdsC.lean.js} +1 -1
  114. package/dist/docs/assets/reference_cli.md.B8GdpaRj.js +83 -0
  115. package/dist/docs/assets/reference_cli.md.B8GdpaRj.lean.js +1 -0
  116. package/dist/docs/assets/reference_connections.md.DoY4vrDH.js +54 -0
  117. package/dist/docs/assets/{reference_connections.md.BoAotr7_.lean.js → reference_connections.md.DoY4vrDH.lean.js} +1 -1
  118. package/dist/docs/assets/reference_evals.md.DgfUtfIc.js +69 -0
  119. package/dist/docs/assets/{reference_evals.md.DYKjGFi-.lean.js → reference_evals.md.DgfUtfIc.lean.js} +1 -1
  120. package/dist/docs/assets/{reference_extensions.md.pEVj72Xo.js → reference_extensions.md.DHbW6eOf.js} +6 -8
  121. package/dist/docs/assets/{reference_extensions.md.pEVj72Xo.lean.js → reference_extensions.md.DHbW6eOf.lean.js} +1 -1
  122. package/dist/docs/assets/reference_hooks.md.CSWmOwMM.js +39 -0
  123. package/dist/docs/assets/reference_hooks.md.CSWmOwMM.lean.js +1 -0
  124. package/dist/docs/assets/reference_http-api.md.C7Cb0r2J.js +7 -0
  125. package/dist/docs/assets/{reference_http-api.md._RWELr3d.lean.js → reference_http-api.md.C7Cb0r2J.lean.js} +1 -1
  126. package/dist/docs/assets/reference_instructions.md.CV6Qq0UX.js +14 -0
  127. package/dist/docs/assets/reference_instructions.md.CV6Qq0UX.lean.js +1 -0
  128. package/dist/docs/assets/reference_limits.md.CbdtFr4T.js +8 -0
  129. package/dist/docs/assets/reference_limits.md.CbdtFr4T.lean.js +1 -0
  130. package/dist/docs/assets/reference_memory.md.CdoJISM-.js +3 -0
  131. package/dist/docs/assets/{reference_memory.md.Dd7cyV9V.lean.js → reference_memory.md.CdoJISM-.lean.js} +1 -1
  132. package/dist/docs/assets/reference_playground.md.DIUsRAcy.js +1 -0
  133. package/dist/docs/assets/{reference_playground.md.CQiJk9CM.lean.js → reference_playground.md.DIUsRAcy.lean.js} +1 -1
  134. package/dist/docs/assets/reference_project-layout.md.9DiKoE16.js +26 -0
  135. package/dist/docs/assets/reference_project-layout.md.9DiKoE16.lean.js +1 -0
  136. package/dist/docs/assets/reference_schedules.md.RhQ9ZLo1.js +45 -0
  137. package/dist/docs/assets/{reference_schedules.md.RC47aFm4.lean.js → reference_schedules.md.RhQ9ZLo1.lean.js} +1 -1
  138. package/dist/docs/assets/reference_sessions.md.NXVQt9mP.js +22 -0
  139. package/dist/docs/assets/{reference_sessions.md.C7KFhWXV.lean.js → reference_sessions.md.NXVQt9mP.lean.js} +1 -1
  140. package/dist/docs/assets/{reference_skills.md.Dej2zQxi.js → reference_skills.md.DzCPNPkG.js} +4 -4
  141. package/dist/docs/assets/{reference_skills.md.Dej2zQxi.lean.js → reference_skills.md.DzCPNPkG.lean.js} +1 -1
  142. package/dist/docs/assets/reference_subagents.md.Dvpq2sUu.js +10 -0
  143. package/dist/docs/assets/{reference_subagents.md.CAhvW4yS.lean.js → reference_subagents.md.Dvpq2sUu.lean.js} +1 -1
  144. package/dist/docs/assets/reference_tools.md.B2OaR1Nb.js +62 -0
  145. package/dist/docs/assets/{reference_tools.md.DQr7Fnhu.lean.js → reference_tools.md.B2OaR1Nb.lean.js} +1 -1
  146. package/dist/docs/assets/templates_agentic-owners.md.B6ZmKAzT.js +13 -0
  147. package/dist/docs/assets/{templates_agentic-owners.md.Dh2nDSqg.lean.js → templates_agentic-owners.md.B6ZmKAzT.lean.js} +1 -1
  148. package/dist/docs/assets/templates_reviews.md.dr9Xv_KM.js +10 -0
  149. package/dist/docs/assets/templates_reviews.md.dr9Xv_KM.lean.js +1 -0
  150. package/dist/docs/assets/troubleshooting.md.DfKKvW1R.js +3 -0
  151. package/dist/docs/assets/{troubleshooting.md.AGJ3jDzj.lean.js → troubleshooting.md.DfKKvW1R.lean.js} +1 -1
  152. package/dist/docs/building-with-agents.html +41 -44
  153. package/dist/docs/building-with-agents.md +11 -104
  154. package/dist/docs/changelog.html +37 -37
  155. package/dist/docs/changelog.md +5 -145
  156. package/dist/docs/deployment.html +54 -54
  157. package/dist/docs/deployment.md +86 -265
  158. package/dist/docs/evals.html +52 -71
  159. package/dist/docs/evals.md +33 -127
  160. package/dist/docs/guides/agent-to-agent.html +43 -43
  161. package/dist/docs/guides/agent-to-agent.md +27 -64
  162. package/dist/docs/guides/bitbucket.html +62 -62
  163. package/dist/docs/guides/bitbucket.md +73 -134
  164. package/dist/docs/guides/cloud-agents.html +37 -37
  165. package/dist/docs/guides/cloud-agents.md +23 -53
  166. package/dist/docs/guides/convert-automation.html +39 -56
  167. package/dist/docs/guides/convert-automation.md +31 -115
  168. package/dist/docs/guides/github.html +46 -54
  169. package/dist/docs/guides/github.md +49 -131
  170. package/dist/docs/guides/gitlab.html +98 -108
  171. package/dist/docs/guides/gitlab.md +104 -184
  172. package/dist/docs/guides/improve.html +38 -43
  173. package/dist/docs/guides/improve.md +24 -90
  174. package/dist/docs/guides/jev.html +55 -95
  175. package/dist/docs/guides/jev.md +57 -159
  176. package/dist/docs/guides/mcp-oauth.html +38 -40
  177. package/dist/docs/guides/mcp-oauth.md +34 -69
  178. package/dist/docs/guides/migrate.html +38 -43
  179. package/dist/docs/guides/migrate.md +56 -130
  180. package/dist/docs/guides/opentelemetry.html +41 -43
  181. package/dist/docs/guides/opentelemetry.md +32 -27
  182. package/dist/docs/guides/pagerduty.html +50 -49
  183. package/dist/docs/guides/pagerduty.md +65 -199
  184. package/dist/docs/guides/slack.html +51 -57
  185. package/dist/docs/guides/slack.md +76 -205
  186. package/dist/docs/guides/webhooks.html +42 -42
  187. package/dist/docs/guides/webhooks.md +64 -146
  188. package/dist/docs/hashmap.json +1 -1
  189. package/dist/docs/hillclimbing.html +40 -42
  190. package/dist/docs/hillclimbing.md +40 -102
  191. package/dist/docs/index.html +55 -62
  192. package/dist/docs/index.md +49 -82
  193. package/dist/docs/llms-full.txt +2292 -5830
  194. package/dist/docs/llms.txt +9 -15
  195. package/dist/docs/quickstart.html +96 -153
  196. package/dist/docs/quickstart.md +93 -178
  197. package/dist/docs/reference/access.html +36 -36
  198. package/dist/docs/reference/access.md +7 -12
  199. package/dist/docs/reference/agent-config.html +43 -56
  200. package/dist/docs/reference/agent-config.md +93 -176
  201. package/dist/docs/reference/artifacts.html +38 -39
  202. package/dist/docs/reference/artifacts.md +38 -62
  203. package/dist/docs/reference/channels.html +38 -39
  204. package/dist/docs/reference/channels.md +102 -151
  205. package/dist/docs/reference/cli.html +68 -84
  206. package/dist/docs/reference/cli.md +233 -698
  207. package/dist/docs/reference/connections.html +45 -57
  208. package/dist/docs/reference/connections.md +83 -164
  209. package/dist/docs/reference/evals.html +66 -53
  210. package/dist/docs/reference/evals.md +97 -128
  211. package/dist/docs/reference/extensions.html +41 -43
  212. package/dist/docs/reference/extensions.md +37 -70
  213. package/dist/docs/reference/hooks.html +40 -52
  214. package/dist/docs/reference/hooks.md +62 -133
  215. package/dist/docs/reference/http-api.html +38 -42
  216. package/dist/docs/reference/http-api.md +66 -118
  217. package/dist/docs/reference/instructions.html +39 -39
  218. package/dist/docs/reference/instructions.md +19 -29
  219. package/dist/docs/reference/limits.html +38 -38
  220. package/dist/docs/reference/limits.md +9 -21
  221. package/dist/docs/reference/memory.html +37 -38
  222. package/dist/docs/reference/memory.md +38 -75
  223. package/dist/docs/reference/playground.html +36 -36
  224. package/dist/docs/reference/playground.md +14 -22
  225. package/dist/docs/reference/project-layout.html +49 -48
  226. package/dist/docs/reference/project-layout.md +38 -84
  227. package/dist/docs/reference/schedules.html +46 -48
  228. package/dist/docs/reference/schedules.md +59 -90
  229. package/dist/docs/reference/sessions.html +37 -37
  230. package/dist/docs/reference/sessions.md +66 -113
  231. package/dist/docs/reference/skills.html +39 -39
  232. package/dist/docs/reference/skills.md +11 -31
  233. package/dist/docs/reference/subagents.html +37 -37
  234. package/dist/docs/reference/subagents.md +17 -31
  235. package/dist/docs/reference/tools.html +47 -64
  236. package/dist/docs/reference/tools.md +48 -130
  237. package/dist/docs/templates/agentic-owners.html +38 -38
  238. package/dist/docs/templates/agentic-owners.md +50 -74
  239. package/dist/docs/templates/reviews.html +69 -0
  240. package/dist/docs/templates/reviews.md +71 -0
  241. package/dist/docs/troubleshooting.html +38 -36
  242. package/dist/docs/troubleshooting.md +48 -101
  243. package/dist/evals.d.ts +2 -2
  244. package/dist/extensions/jev/extension.d.ts +12 -2
  245. package/dist/extensions/jev/extension.d.ts.map +1 -1
  246. package/dist/extensions/jev/extension.js +4 -0
  247. package/dist/extensions/jev/lib/evaluate.d.ts +31 -4
  248. package/dist/extensions/jev/lib/evaluate.d.ts.map +1 -1
  249. package/dist/extensions/jev/lib/evaluate.js +18 -4
  250. package/dist/internal/cli/command.d.ts +1 -1
  251. package/dist/internal/cli/command.js +1 -1
  252. package/dist/internal/cli/commands/channels.js +6 -6
  253. package/dist/internal/cli/commands/develop.d.ts.map +1 -1
  254. package/dist/internal/cli/commands/develop.js +23 -14
  255. package/dist/internal/cli/commands/hosted.js +4 -4
  256. package/dist/internal/cli/commands/index.d.ts +1 -1
  257. package/dist/internal/cli/commands/index.d.ts.map +1 -1
  258. package/dist/internal/cli/commands/index.js +1 -1
  259. package/dist/internal/cli/commands/mcp.js +1 -1
  260. package/dist/internal/cli/commands/project.js +4 -4
  261. package/dist/internal/cli/commands/scaffold.d.ts.map +1 -1
  262. package/dist/internal/cli/commands/scaffold.js +9 -6
  263. package/dist/internal/cli/commands/serve.d.ts +1 -1
  264. package/dist/internal/cli/commands/serve.js +5 -5
  265. package/dist/internal/cli/commands/session.d.ts.map +1 -1
  266. package/dist/internal/cli/commands/session.js +12 -7
  267. package/dist/internal/cli/dispatch.d.ts +3 -3
  268. package/dist/internal/cli/dispatch.js +3 -3
  269. package/dist/internal/cli/errors.d.ts +1 -1
  270. package/dist/internal/cli/errors.d.ts.map +1 -1
  271. package/dist/internal/cli/errors.js +1 -1
  272. package/dist/internal/cli/flags.d.ts +2 -2
  273. package/dist/internal/cli/flags.d.ts.map +1 -1
  274. package/dist/internal/cli/flags.js +2 -2
  275. package/dist/internal/cli/help-command.d.ts +1 -1
  276. package/dist/internal/cli/help-command.js +2 -2
  277. package/dist/internal/cli/help.d.ts +7 -7
  278. package/dist/internal/cli/help.d.ts.map +1 -1
  279. package/dist/internal/cli/help.js +8 -8
  280. package/dist/internal/cli-ax.d.ts.map +1 -1
  281. package/dist/internal/cli-ax.js +3 -0
  282. package/dist/internal/cli-convert-automation.d.ts +1 -1
  283. package/dist/internal/cli-convert-automation.js +1 -1
  284. package/dist/internal/cli-deploy.js +1 -1
  285. package/dist/internal/cli-docs.js +1 -1
  286. package/dist/internal/cli-images.js +1 -1
  287. package/dist/internal/cli-migrate.d.ts +1 -1
  288. package/dist/internal/cli-migrate.js +1 -1
  289. package/dist/internal/cli-pagerduty.d.ts +1 -1
  290. package/dist/internal/cli-pagerduty.js +1 -1
  291. package/dist/internal/cli-skills.js +1 -1
  292. package/dist/internal/convert-automation/types.d.ts +1 -1
  293. package/dist/internal/convert-automation/types.js +1 -1
  294. package/dist/internal/cursor/credentials.js +1 -1
  295. package/dist/internal/deploy-client.d.ts +2 -2
  296. package/dist/internal/deploy-client.d.ts.map +1 -1
  297. package/dist/internal/deploy-manifest.d.ts +1 -0
  298. package/dist/internal/deploy-manifest.d.ts.map +1 -1
  299. package/dist/internal/deploy-manifest.js +0 -1
  300. package/dist/internal/discovery/agent-config.d.ts +2 -6
  301. package/dist/internal/discovery/agent-config.d.ts.map +1 -1
  302. package/dist/internal/discovery/agent-config.js +8 -25
  303. package/dist/internal/discovery/agent.d.ts.map +1 -1
  304. package/dist/internal/discovery/agent.js +2 -3
  305. package/dist/internal/discovery/project.d.ts.map +1 -1
  306. package/dist/internal/discovery/project.js +15 -0
  307. package/dist/internal/init-project.d.ts +7 -3
  308. package/dist/internal/init-project.d.ts.map +1 -1
  309. package/dist/internal/init-project.js +60 -12
  310. package/dist/internal/init-scaffold.d.ts +2 -1
  311. package/dist/internal/init-scaffold.d.ts.map +1 -1
  312. package/dist/internal/init-scaffold.js +20 -7
  313. package/dist/internal/peer-connections.js +1 -1
  314. package/dist/internal/reminder-runner.js +1 -1
  315. package/dist/internal/server.d.ts +1 -1
  316. package/dist/internal/session-cost.d.ts +4 -4
  317. package/dist/internal/session-cost.d.ts.map +1 -1
  318. package/dist/internal/session-cost.js +4 -4
  319. package/dist/internal/session-engine.d.ts +1 -1
  320. package/dist/internal/session-engine.js +2 -2
  321. package/dist/internal/shallow-clone.js +1 -1
  322. package/dist/playground/assets/index-D6mVn9og.js +62 -0
  323. package/dist/playground/assets/index-DlALM6gr.css +1 -0
  324. package/dist/playground/index.html +2 -2
  325. package/dist/types.d.ts +9 -22
  326. package/dist/types.d.ts.map +1 -1
  327. package/docs/README.md +49 -82
  328. package/docs/building-with-agents.md +11 -104
  329. package/docs/changelog.md +6 -146
  330. package/docs/deployment.md +86 -265
  331. package/docs/evals.md +34 -128
  332. package/docs/guides/agent-to-agent.md +27 -64
  333. package/docs/guides/bitbucket.md +73 -134
  334. package/docs/guides/cloud-agents.md +23 -53
  335. package/docs/guides/convert-automation.md +31 -115
  336. package/docs/guides/github.md +49 -131
  337. package/docs/guides/gitlab.md +104 -184
  338. package/docs/guides/improve.md +24 -90
  339. package/docs/guides/jev.md +57 -159
  340. package/docs/guides/mcp-oauth.md +34 -69
  341. package/docs/guides/migrate.md +56 -130
  342. package/docs/guides/opentelemetry.md +37 -27
  343. package/docs/guides/pagerduty.md +68 -200
  344. package/docs/guides/slack.md +76 -205
  345. package/docs/guides/webhooks.md +64 -146
  346. package/docs/hillclimbing.md +41 -103
  347. package/docs/quickstart.md +93 -178
  348. package/docs/reference/access.md +7 -12
  349. package/docs/reference/agent-config.md +93 -176
  350. package/docs/reference/artifacts.md +38 -62
  351. package/docs/reference/channels.md +102 -151
  352. package/docs/reference/cli.md +233 -698
  353. package/docs/reference/connections.md +83 -164
  354. package/docs/reference/evals.md +97 -128
  355. package/docs/reference/extensions.md +37 -70
  356. package/docs/reference/hooks.md +61 -132
  357. package/docs/reference/http-api.md +66 -118
  358. package/docs/reference/instructions.md +20 -30
  359. package/docs/reference/limits.md +10 -22
  360. package/docs/reference/memory.md +38 -75
  361. package/docs/reference/playground.md +14 -22
  362. package/docs/reference/project-layout.md +38 -84
  363. package/docs/reference/schedules.md +59 -90
  364. package/docs/reference/sessions.md +66 -113
  365. package/docs/reference/skills.md +12 -32
  366. package/docs/reference/subagents.md +17 -31
  367. package/docs/reference/tools.md +48 -130
  368. package/docs/templates/agentic-owners.md +50 -74
  369. package/docs/templates/reviews.md +76 -0
  370. package/docs/troubleshooting.md +48 -101
  371. package/package.json +3 -9
  372. package/skills/cli/SKILL.md +15 -15
  373. package/skills/create-agent/SKILL.md +20 -19
  374. package/skills/debug/SKILL.md +4 -4
  375. package/skills/deploy/SKILL.md +2 -2
  376. package/skills/evals/SKILL.md +8 -8
  377. package/skills/framework-map/SKILL.md +3 -3
  378. package/skills/github/SKILL.md +7 -7
  379. package/skills/hillclimb/SKILL.md +4 -4
  380. package/skills/mcp-auth/SKILL.md +3 -3
  381. package/skills/migrate-v2/SKILL.md +40 -41
  382. package/skills/otel/SKILL.md +2 -2
  383. package/skills/setup-slack/SKILL.md +8 -8
  384. package/templates/agentic-owners/README.md +5 -5
  385. package/templates/agentic-owners/bot/tools/record_review.ts +1 -1
  386. package/templates/agentic-owners/package.json +1 -1
  387. package/templates/agents-md/README.md +4 -4
  388. package/templates/agents-md/package.json +1 -1
  389. package/templates/code-wiki/README.md +3 -3
  390. package/templates/code-wiki/package.json +1 -1
  391. package/templates/demo/README.md +3 -3
  392. package/templates/demo/package.json +1 -1
  393. package/templates/pr-autofixer/package.json +1 -1
  394. package/templates/security-help/README.md +5 -5
  395. package/templates/security-help/package.json +1 -1
  396. package/templates/security-reviewer/README.md +3 -3
  397. package/templates/security-reviewer/package.json +1 -1
  398. package/templates/thermo-quality-review/README.md +4 -4
  399. package/templates/thermo-quality-review/package.json +1 -1
  400. package/templates/thermo-review/README.md +4 -4
  401. package/templates/thermo-review/package.json +1 -1
  402. package/templates/triage/README.md +3 -3
  403. package/templates/triage/overlays/jira/README.md +3 -3
  404. package/templates/triage/overlays/linear/README.md +3 -3
  405. package/templates/triage/package.json +1 -1
  406. package/dist/docs/assets/building-with-agents.md.Bf1yH2tG.js +0 -9
  407. package/dist/docs/assets/changelog.md.fZ-NNFeJ.js +0 -1
  408. package/dist/docs/assets/changelog.md.fZ-NNFeJ.lean.js +0 -1
  409. package/dist/docs/assets/chunks/@localSearchIndexroot.mfzjiOsL.js +0 -1
  410. package/dist/docs/assets/chunks/channel.goFR5lbe.js +0 -1
  411. package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.B2yLtFja.js +0 -1
  412. package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.B2yLtFja.js +0 -1
  413. package/dist/docs/assets/chunks/clone.CztV97Wu.js +0 -1
  414. package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.CZlVHdDZ.js +0 -1
  415. package/dist/docs/assets/deployment.md.DDmjAVbg.js +0 -31
  416. package/dist/docs/assets/evals.md.OjKb7tNA.js +0 -68
  417. package/dist/docs/assets/evals.md.OjKb7tNA.lean.js +0 -1
  418. package/dist/docs/assets/guides_agent-to-agent.md.D1D5f6Jc.lean.js +0 -1
  419. package/dist/docs/assets/guides_cloud-agents.md.Ceyjv0ul.js +0 -9
  420. package/dist/docs/assets/guides_convert-automation.md.BjraCvok.js +0 -43
  421. package/dist/docs/assets/guides_grokbot-agents.md.D0PpM_Gf.js +0 -15
  422. package/dist/docs/assets/guides_grokbot-agents.md.D0PpM_Gf.lean.js +0 -1
  423. package/dist/docs/assets/guides_hooks.md.BjeEiM7s.js +0 -54
  424. package/dist/docs/assets/guides_hooks.md.BjeEiM7s.lean.js +0 -1
  425. package/dist/docs/assets/guides_improve.md.BFYtrtLE.js +0 -21
  426. package/dist/docs/assets/guides_migrate.md.RS9Eu-Xh.js +0 -8
  427. package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.js +0 -28
  428. package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.lean.js +0 -1
  429. package/dist/docs/assets/guides_pagerduty.md.mnKXe9U0.js +0 -60
  430. package/dist/docs/assets/guides_pagerduty.md.mnKXe9U0.lean.js +0 -1
  431. package/dist/docs/assets/guides_slack.md.BqiGSYGX.js +0 -88
  432. package/dist/docs/assets/hillclimbing.md.By61f3uq.js +0 -7
  433. package/dist/docs/assets/hillclimbing.md.By61f3uq.lean.js +0 -1
  434. package/dist/docs/assets/index.md.CVRjO09Y.js +0 -27
  435. package/dist/docs/assets/index.md.CVRjO09Y.lean.js +0 -1
  436. package/dist/docs/assets/quickstart.md.DaLk4ZIF.js +0 -170
  437. package/dist/docs/assets/reference_access.md.CExlH_mR.js +0 -1
  438. package/dist/docs/assets/reference_agent-config.md.11E_xe--.js +0 -40
  439. package/dist/docs/assets/reference_artifacts.md.C-hKR2hp.js +0 -18
  440. package/dist/docs/assets/reference_channels.md.DsJfGSBJ.js +0 -22
  441. package/dist/docs/assets/reference_cli.md.DQ3dCgmk.js +0 -99
  442. package/dist/docs/assets/reference_cli.md.DQ3dCgmk.lean.js +0 -1
  443. package/dist/docs/assets/reference_connections.md.BoAotr7_.js +0 -66
  444. package/dist/docs/assets/reference_evals.md.DYKjGFi-.js +0 -56
  445. package/dist/docs/assets/reference_hooks.md.B-bwJuiG.js +0 -51
  446. package/dist/docs/assets/reference_hooks.md.B-bwJuiG.lean.js +0 -1
  447. package/dist/docs/assets/reference_http-api.md._RWELr3d.js +0 -11
  448. package/dist/docs/assets/reference_instructions.md.yL2hXLnl.js +0 -14
  449. package/dist/docs/assets/reference_instructions.md.yL2hXLnl.lean.js +0 -1
  450. package/dist/docs/assets/reference_limits.md.Da1HegjB.js +0 -8
  451. package/dist/docs/assets/reference_limits.md.Da1HegjB.lean.js +0 -1
  452. package/dist/docs/assets/reference_memory.md.Dd7cyV9V.js +0 -4
  453. package/dist/docs/assets/reference_playground.md.CQiJk9CM.js +0 -1
  454. package/dist/docs/assets/reference_project-layout.md.BamcPDUn.js +0 -25
  455. package/dist/docs/assets/reference_project-layout.md.BamcPDUn.lean.js +0 -1
  456. package/dist/docs/assets/reference_prompt.md.BMjm1Jp3.js +0 -9
  457. package/dist/docs/assets/reference_prompt.md.BMjm1Jp3.lean.js +0 -1
  458. package/dist/docs/assets/reference_schedules.md.RC47aFm4.js +0 -47
  459. package/dist/docs/assets/reference_sessions.md.C7KFhWXV.js +0 -22
  460. package/dist/docs/assets/reference_subagents.md.CAhvW4yS.js +0 -10
  461. package/dist/docs/assets/reference_tools.md.DQr7Fnhu.js +0 -79
  462. package/dist/docs/assets/templates_agentic-owners.md.Dh2nDSqg.js +0 -13
  463. package/dist/docs/assets/templates_security-reviewer.md.DnwXdnB5.js +0 -3
  464. package/dist/docs/assets/templates_security-reviewer.md.DnwXdnB5.lean.js +0 -1
  465. package/dist/docs/assets/templates_thermo-quality-review.md.MJIdHkzE.js +0 -3
  466. package/dist/docs/assets/templates_thermo-quality-review.md.MJIdHkzE.lean.js +0 -1
  467. package/dist/docs/assets/templates_thermo-review.md.DfN1OFOl.js +0 -3
  468. package/dist/docs/assets/templates_thermo-review.md.DfN1OFOl.lean.js +0 -1
  469. package/dist/docs/assets/templates_triage.md.BYWMloV4.js +0 -9
  470. package/dist/docs/assets/templates_triage.md.BYWMloV4.lean.js +0 -1
  471. package/dist/docs/assets/troubleshooting.md.AGJ3jDzj.js +0 -1
  472. package/dist/docs/guides/grokbot-agents.html +0 -74
  473. package/dist/docs/guides/grokbot-agents.md +0 -129
  474. package/dist/docs/guides/hooks.html +0 -113
  475. package/dist/docs/guides/hooks.md +0 -116
  476. package/dist/docs/reference/prompt.html +0 -68
  477. package/dist/docs/reference/prompt.md +0 -47
  478. package/dist/docs/templates/security-reviewer.html +0 -62
  479. package/dist/docs/templates/security-reviewer.md +0 -81
  480. package/dist/docs/templates/thermo-quality-review.html +0 -62
  481. package/dist/docs/templates/thermo-quality-review.md +0 -75
  482. package/dist/docs/templates/thermo-review.html +0 -62
  483. package/dist/docs/templates/thermo-review.md +0 -75
  484. package/dist/docs/templates/triage.html +0 -68
  485. package/dist/docs/templates/triage.md +0 -101
  486. package/dist/extensions/cursor-grokbot-agents/extension.d.ts +0 -71
  487. package/dist/extensions/cursor-grokbot-agents/extension.d.ts.map +0 -1
  488. package/dist/extensions/cursor-grokbot-agents/extension.js +0 -64
  489. package/dist/extensions/cursor-grokbot-agents/lib/agents.d.ts +0 -11
  490. package/dist/extensions/cursor-grokbot-agents/lib/agents.d.ts.map +0 -1
  491. package/dist/extensions/cursor-grokbot-agents/lib/agents.js +0 -31
  492. package/dist/extensions/cursor-grokbot-agents/lib/backend.d.ts +0 -56
  493. package/dist/extensions/cursor-grokbot-agents/lib/backend.d.ts.map +0 -1
  494. package/dist/extensions/cursor-grokbot-agents/lib/backend.js +0 -139
  495. package/dist/extensions/cursor-grokbot-agents/lib/contacts.d.ts +0 -28
  496. package/dist/extensions/cursor-grokbot-agents/lib/contacts.d.ts.map +0 -1
  497. package/dist/extensions/cursor-grokbot-agents/lib/contacts.js +0 -46
  498. package/dist/extensions/cursor-grokbot-agents/lib/conversation.d.ts +0 -53
  499. package/dist/extensions/cursor-grokbot-agents/lib/conversation.d.ts.map +0 -1
  500. package/dist/extensions/cursor-grokbot-agents/lib/conversation.js +0 -186
  501. package/dist/extensions/cursor-grokbot-agents/lib/inputs.d.ts +0 -4
  502. package/dist/extensions/cursor-grokbot-agents/lib/inputs.d.ts.map +0 -1
  503. package/dist/extensions/cursor-grokbot-agents/lib/inputs.js +0 -15
  504. package/dist/extensions/cursor-grokbot-agents/lib/lock.d.ts +0 -12
  505. package/dist/extensions/cursor-grokbot-agents/lib/lock.d.ts.map +0 -1
  506. package/dist/extensions/cursor-grokbot-agents/lib/lock.js +0 -24
  507. package/dist/extensions/cursor-grokbot-agents/skills/consult.md +0 -40
  508. package/dist/extensions/cursor-grokbot-agents/tools/ask.d.ts +0 -4
  509. package/dist/extensions/cursor-grokbot-agents/tools/ask.d.ts.map +0 -1
  510. package/dist/extensions/cursor-grokbot-agents/tools/ask.js +0 -26
  511. package/dist/extensions/cursor-grokbot-agents/tools/check.d.ts +0 -4
  512. package/dist/extensions/cursor-grokbot-agents/tools/check.d.ts.map +0 -1
  513. package/dist/extensions/cursor-grokbot-agents/tools/check.js +0 -21
  514. package/dist/extensions/cursor-grokbot-agents/tools/interrupt.d.ts +0 -4
  515. package/dist/extensions/cursor-grokbot-agents/tools/interrupt.d.ts.map +0 -1
  516. package/dist/extensions/cursor-grokbot-agents/tools/interrupt.js +0 -13
  517. package/dist/extensions/cursor-grokbot-agents/tools/list.d.ts +0 -4
  518. package/dist/extensions/cursor-grokbot-agents/tools/list.d.ts.map +0 -1
  519. package/dist/extensions/cursor-grokbot-agents/tools/list.js +0 -22
  520. package/dist/playground/assets/index-BMpVzZzC.css +0 -1
  521. package/dist/playground/assets/index-_3zz3yh8.js +0 -62
  522. package/docs/guides/grokbot-agents.md +0 -134
  523. package/docs/guides/hooks.md +0 -121
  524. package/docs/reference/prompt.md +0 -52
  525. package/docs/templates/security-reviewer.md +0 -86
  526. package/docs/templates/thermo-quality-review.md +0 -80
  527. package/docs/templates/thermo-review.md +0 -80
  528. package/docs/templates/triage.md +0 -106
@@ -1,134 +0,0 @@
1
- ---
2
- title: "Cursor Grok Bot agents"
3
- description: "Mount an extension that lets your agent consult named Grok Bot agents, wait for long replies, and interrupt work."
4
- ---
5
-
6
- # Grok Bot agents
7
-
8
- The `cursor-grokbot-agents` extension lets an Agent SDK agent consult
9
- the Grok Bot agents on its serve host's Cursor account. The bot keeps
10
- its existing conversation, memory, and tools, while your agent carries
11
- the delivered reply back into the current conversation.
12
-
13
- Use this extension on the local runtime. It consults another Grok Bot
14
- agent and brings that reply back into this conversation.
15
-
16
- ## Mount it
17
-
18
- List the bots your agent may contact. Descriptions teach the model when
19
- to choose one bot over another.
20
-
21
- ```ts
22
- // bot/extensions/grokbot.ts
23
- import cursorGrokBotAgents from "@grok/agent-sdk/extensions/cursor-grokbot-agents";
24
-
25
- export default cursorGrokBotAgents({
26
- agents: [
27
- {
28
- name: "Plan Keeper",
29
- description: "Decides whether outdoor plans should move.",
30
- },
31
- {
32
- name: "Chief of Staff",
33
- description: "Routes work and tracks priorities.",
34
- },
35
- ],
36
- });
37
- ```
38
-
39
- Mounted as `grokbot`, the extension contributes `grokbot__ask`,
40
- `grokbot__check`, `grokbot__interrupt`, and `grokbot__list`, plus
41
- guidance for consulting them.
42
-
43
- ## Ask a named bot
44
-
45
- When someone says, "Ask Plan Keeper whether we should move the picnic,"
46
- your agent prepares one self-contained message, sends it, and waits for
47
- the bot's delivered reply. That reply appears in the current
48
- conversation as the consultation result.
49
-
50
- The message must include who is asking, the relevant facts, and the
51
- shape of the answer. The Grok Bot does not see the current Agent SDK
52
- conversation.
53
-
54
- > Avery is deciding whether to move Saturday's picnic. The forecast is
55
- > 70% rain from 1-4pm. Recommend keep or move, give one reason, and name
56
- > the best alternate time.
57
-
58
- When exactly one bot is configured, the model may omit its name.
59
-
60
- ## Keep waiting for a long reply
61
-
62
- If the bot is still working when `ask` reaches its wait limit, the tool
63
- returns `status: "running"` and any reply received so far. Your agent
64
- calls `check` for the same bot and reports the final answer when it
65
- arrives.
66
-
67
- `check` advances this caller's read position, so it returns only replies
68
- not already consumed. Check when the answer is needed instead of
69
- polling in a tight loop.
70
-
71
- Earlier unread replies can arrive alongside the current result. Keep
72
- their order and pass them on when they still matter.
73
-
74
- ## Interrupt a bot turn
75
-
76
- Use `interrupt` when the bot is pursuing the wrong task or the person
77
- changes direction. The active turn stops, but the host account's
78
- conversation with that bot remains, so a later `ask` continues with its
79
- existing memory.
80
-
81
- > Stop Plan Keeper's current turn. Then ask it to compare indoor venues
82
- > instead of changing the time.
83
-
84
- `check` and `interrupt` act on the bot conversation directly, so expose
85
- this extension only to callers who may read or stop those
86
- conversations.
87
-
88
- ## Configure it
89
-
90
- `agents` is a name allowlist, not an existence check. A name outside the
91
- list is refused, but a misspelled configured name may create a new empty
92
- bot on first use. If a result says `created: true`, tell the person and
93
- check the name before sending more work.
94
-
95
- With no `agents` list, any name is allowed. Prefer an explicit list for
96
- a shared agent. `list` returns configured
97
- bots and bots this caller already contacted; it does not enumerate the
98
- whole account.
99
-
100
- Calls use the serve host credential: `CURSOR_API_KEY`,
101
- `CURSOR_API_KEY_FILE`, `CURSOR_SERVICE_ACCOUNT_KEY`, or
102
- `agent-sdk login`. Use `apiKey` only when the extension should run under
103
- a different account.
104
-
105
- `pollIntervalMs` changes how often a waiting tool reads for new bot
106
- output. Keep the default unless the service needs a different balance
107
- between response latency and request volume.
108
-
109
- ## Account and caller boundaries
110
-
111
- Every tool reaches the serve host account's existing Grok Bot
112
- conversation. Authenticated Agent SDK callers have separate contact
113
- lists and read positions, but they do not get separate Grok Bot accounts
114
- or isolated bot memory.
115
-
116
- A shared bearer token or anonymous host also collapses callers into one
117
- Agent SDK principal. Use per-caller auth when contact history and read
118
- positions must remain separate.
119
-
120
- If `ask` finds the bot busy with an earlier message, it sends nothing.
121
- For a bot this caller already contacted, use `check` or `interrupt`.
122
- On first contact, wait for the existing turn in the Grok Bot app to
123
- finish, then ask again.
124
-
125
- ## Adjust it
126
-
127
- To remove a capability such as `interrupt`, mount the extension as a
128
- directory and disable that tool. See
129
- [Adjust a mounted extension](../reference/extensions.md#adjust-a-mounted-extension).
130
-
131
- ## What's next
132
-
133
- - [Extensions](../reference/extensions.md): namespaces, trust, and
134
- overlays
@@ -1,121 +0,0 @@
1
- ---
2
- title: "Hooks"
3
- description: "Observe session events for metrics, alerts, and other side effects without changing the turn."
4
- ---
5
-
6
- # Hooks
7
-
8
- Hooks observe session events after they are recorded and run side effects such
9
- as updating metrics or sending alerts. They never change the turn, prompt, or
10
- reply. Author them under `bot/hooks/` with `defineHook` from
11
- `@grok/agent-sdk/hooks`.
12
-
13
- ## Meter token usage
14
-
15
- With [OpenTelemetry](./opentelemetry.md) configured, this hook adds a live
16
- turn's reported input and output tokens to your counters. Eval runs stay quiet,
17
- so the dashboard reflects live traffic instead of the test suite.
18
-
19
- ```ts
20
- // bot/hooks/usage.ts
21
- import { metrics } from "@opentelemetry/api";
22
- import { defineHook } from "@grok/agent-sdk/hooks";
23
-
24
- const meter = metrics.getMeter("acme");
25
- const inputTokens = meter.createCounter("acme.tokens.input");
26
- const outputTokens = meter.createCounter("acme.tokens.output");
27
-
28
- export default defineHook({
29
- events: {
30
- async "turn.completed"(event, ctx) {
31
- if (ctx.session.purpose === "eval") {
32
- return;
33
- }
34
- if (event.data.usage === undefined) {
35
- return;
36
- }
37
-
38
- inputTokens.add(event.data.usage.inputTokens);
39
- outputTokens.add(event.data.usage.outputTokens);
40
- },
41
- },
42
- });
43
- ```
44
-
45
- ## Alert on failure
46
-
47
- Set `PAGER_WEBHOOK_URL` to your pager's webhook. When a live turn fails, this
48
- hook posts the agent, session, and failure message there. Eval runs and
49
- interrupted turns stay quiet, so tests and preemptions do not page anyone.
50
-
51
- ```ts
52
- // bot/hooks/page-on-failure.ts
53
- import { defineHook } from "@grok/agent-sdk/hooks";
54
-
55
- export default defineHook({
56
- events: {
57
- async "turn.failed"(event, ctx) {
58
- if (ctx.session.purpose === "eval") {
59
- return;
60
- }
61
- if (event.data.message === "turn interrupted") {
62
- return;
63
- }
64
-
65
- const pagerUrl = process.env.PAGER_WEBHOOK_URL;
66
- if (pagerUrl === undefined) {
67
- return;
68
- }
69
-
70
- await fetch(pagerUrl, {
71
- method: "POST",
72
- headers: { "content-type": "application/json" },
73
- body: JSON.stringify({
74
- agent: ctx.agent.name,
75
- session: ctx.session.id,
76
- channel: ctx.channel.id,
77
- message: event.data.message,
78
- }),
79
- signal: AbortSignal.timeout(5_000),
80
- });
81
- },
82
- },
83
- });
84
- ```
85
-
86
- ## Events / when hooks run
87
-
88
- Use event names from the
89
- [session event vocabulary](../reference/sessions.md#stream-events). A hook
90
- receives each matching event after it is recorded, and the model does not wait
91
- for the handler.
92
-
93
- Within one session, handlers run one at a time. A slow handler delays later
94
- handlers for that session, but it does not delay the model or handlers for
95
- other sessions. Hooks also fire for evals, so check
96
- `ctx.session.purpose === "eval"` before metering or paging. A restart does not
97
- replay recorded events into hooks.
98
-
99
- ## When not to use a hook
100
-
101
- | Want | Use instead |
102
- | --- | --- |
103
- | Add context before the model | `instructions.md`, skills, or `workspaceFiles` |
104
- | Deliver to Slack or a PR | Channel [`events`](../reference/channels.md#events) or packs |
105
- | Gate behavior | [Evals](../evals.md) |
106
-
107
- To act on a turn's decision, have the model record it with an authored
108
- [tool](../reference/tools.md), then act on it from a `turn.completed` hook.
109
-
110
- [Cursor Agent hooks](https://cursor.com/docs/agent/hooks) in
111
- `.cursor/hooks.json` are a different product. They can observe, block, or
112
- modify the local agent loop.
113
-
114
- ## Related
115
-
116
- - [Hooks reference](../reference/hooks.md): payloads, context, and discovery
117
- - [Sessions: stream events](../reference/sessions.md#stream-events): event
118
- vocabulary and payload sequence
119
- - [OpenTelemetry](./opentelemetry.md): export traces and custom metrics
120
- - [Channels: events](../reference/channels.md#events): deliver replies back to
121
- Slack, source control, or another surface
@@ -1,52 +0,0 @@
1
- ---
2
- title: "Prompt strings"
3
- description: "Write indented multi-line strings without carrying source indentation into their values."
4
- ---
5
-
6
- # Prompt strings
7
-
8
- The `prompt` template tag keeps multi-line strings aligned with the
9
- surrounding TypeScript while returning dedented text. Use it for tool
10
- descriptions, reminder prompts, channel context, and errors. Import it
11
- from the package root or the dedicated entrypoint:
12
-
13
- ```ts
14
- import { prompt } from "@grok/agent-sdk";
15
- // or: import { prompt } from "@grok/agent-sdk/prompt";
16
- ```
17
-
18
- ## Dedented strings
19
-
20
- `prompt` returns one string. It removes the common leading whitespace
21
- and one newline immediately after the opening backtick.
22
-
23
- ```ts
24
- throw new Error(prompt`
25
- It is outside business hours (Mon-Fri 9am-5pm ET).
26
- Use request_author_approval, or pass approval=human_request.
27
- `);
28
- ```
29
-
30
- Blank lines inside the body are preserved. Relative indentation after the
31
- common prefix is preserved, so nested lists keep their shape.
32
-
33
- When interpolating multi-line values (for example a list of services), give
34
- those lines the same indent as the `prompt` body so dedent stays consistent.
35
-
36
- ## Line arrays
37
-
38
- `prompt.lines` applies the same rules and returns `string[]`, with one
39
- entry per line. Use it when an API accepts separate context lines:
40
-
41
- ```ts
42
- context: prompt.lines`
43
- Merged PR detected: ${pr.url} by ${author}.
44
-
45
- Call plan_deploy, then follow its nextStep.
46
- `
47
- ```
48
-
49
- ## Related
50
-
51
- - [Tools](./tools.md)
52
- - [Channels](./channels.md)
@@ -1,86 +0,0 @@
1
- ---
2
- title: "Review pull requests for exploitable bugs"
3
- description: "Scaffold the agent, pick repos, replay a PR, and deploy."
4
- ---
5
-
6
- # Review pull requests for exploitable bugs
7
-
8
- This agent reads a pull request diff and posts one review comment. It
9
- reports exploitable bugs: injection, authz bypass, secret leaks, SSRF,
10
- RCE. Style nits stay out.
11
-
12
- This template is one model turn: read the diff, then post one comment.
13
-
14
- ## Scaffold
15
-
16
- ```text
17
- agent-sdk init ./security-reviewer --template security-reviewer \
18
- --var repos=acme/api
19
- ```
20
-
21
- `--var repos` must name a repository already connected in Cursor for
22
- your account. Separate multiple repositories with commas; they must
23
- share one owner. `init` writes the list to `bot/lib/repos.ts`.
24
-
25
- ## Connect GitHub through Cursor
26
-
27
- Connect GitHub in Cursor for those repositories (Settings or
28
- [cursor.com/dashboard](https://cursor.com/dashboard)). Sign the host in:
29
-
30
- ```text
31
- cd security-reviewer
32
- agent-sdk login
33
- ```
34
-
35
- `cursorAccount` pulls SCM events from Cursor and mints a short-lived,
36
- repo-scoped credential. `ctx.host.github` and child `gh` commands share
37
- it. See the [GitHub guide](../guides/github.md).
38
-
39
- ## First review
40
-
41
- ```text
42
- agent-sdk dev
43
- ```
44
-
45
- `dev` starts the Cursor event relay for the watched repos. To drive a
46
- known PR without waiting on a live push:
47
-
48
- ```text
49
- agent-sdk github replay https://github.com/acme/api/pull/12 --dir .
50
- ```
51
-
52
- `replay` needs pull access. Draft PRs and repos outside
53
- `bot/lib/repos.ts` are ignored. The channel writes `pr/diff.patch`
54
- after the wake is acknowledged, then starts a model turn. The model
55
- calls `post_findings` once.
56
-
57
- Chat replies stay in the playground. `post_findings` writes the GitHub
58
- comment.
59
-
60
- ## What to edit
61
-
62
- - `bot/lib/repos.ts`: watched repos
63
- - `bot/instructions.md`: what counts as a finding and the comment
64
- shape
65
- - `evals/review.eval.ts`: smoke cases
66
-
67
- ## Evals
68
-
69
- Use the two smoke cases, one XSS fixture and one docs-only change, as a
70
- local exercise:
71
-
72
- ```text
73
- agent-sdk eval
74
- ```
75
-
76
- Eval sessions skip the GitHub write.
77
-
78
- ## Deploy
79
-
80
- ```text
81
- agent-sdk deploy
82
- ```
83
-
84
- Run it from the agent's git checkout. The command infers repository,
85
- ref, path, and slug. The deployment uses the team's Cursor GitHub
86
- connection for the same watched repos.
@@ -1,80 +0,0 @@
1
- ---
2
- title: "Review pull requests for structural code quality"
3
- description: "Scaffold the agent, deploy it, and open a PR."
4
- ---
5
-
6
- # Review pull requests for structural code quality
7
-
8
- This agent reads a pull request diff and posts one review comment. It
9
- reports missing abstractions, deeply nested control flow, feature logic
10
- leaking into shared paths, and files pushed past 1,000 lines. Style nits
11
- and behavior disputes stay out.
12
-
13
- This template is one model turn: read the diff, then post one comment.
14
-
15
- ## Scaffold
16
-
17
- ```text
18
- agent-sdk init ./thermo-quality-review --template thermo-quality-review
19
- cd thermo-quality-review
20
- ```
21
-
22
- ## Deploy
23
-
24
- Sign in once, then deploy from a pushed checkout:
25
-
26
- ```text
27
- agent-sdk login
28
- agent-sdk deploy --cursor-events-repo acme/api
29
- ```
30
-
31
- Repeat `--cursor-events-repo` for each repo. Every repo must share one
32
- owner. The deployment watches those repos through your team's Cursor
33
- GitHub connection and reviews each opened PR. No webhook or local
34
- server.
35
-
36
- Change repos later without redeploying:
37
-
38
- ```text
39
- agent-sdk deployment update thermo-quality-review --event-repo acme/api --event-repo acme/web
40
- ```
41
-
42
- ## Try it locally
43
-
44
- Skip the deploy while you iterate. Start the relay for one repo:
45
-
46
- ```text
47
- agent-sdk dev --cursor-events --repo acme/api
48
- ```
49
-
50
- Open a PR, or replay a known one without pushing:
51
-
52
- ```text
53
- agent-sdk github replay https://github.com/acme/api/pull/12 --dir .
54
- ```
55
-
56
- `replay` needs pull access. Draft PRs are ignored. The channel writes
57
- `pr/diff.patch`, then starts a model turn. The model calls
58
- `post_findings` once. Chat replies stay in the playground.
59
- `post_findings` writes the GitHub comment.
60
-
61
- Connect GitHub in Cursor first (Settings or
62
- [cursor.com/dashboard](https://cursor.com/dashboard)) so the relay and
63
- API calls use your account. See the [GitHub guide](../guides/github.md).
64
-
65
- ## Evals
66
-
67
- Use the two smoke cases, one spaghetti-branch fixture and one clean fix,
68
- as a local exercise. They need no GitHub access.
69
-
70
- ```text
71
- agent-sdk eval
72
- ```
73
-
74
- Eval sessions skip the GitHub write.
75
-
76
- ## What to edit
77
-
78
- - `bot/instructions.md`: what counts as a finding and the comment
79
- shape
80
- - `evals/review.eval.ts`: smoke cases
@@ -1,80 +0,0 @@
1
- ---
2
- title: "Review pull requests for bugs and breakage"
3
- description: "Scaffold the agent, deploy it, and open a PR."
4
- ---
5
-
6
- # Review pull requests for bugs and breakage
7
-
8
- This agent reads a pull request diff and posts one review comment. It
9
- reports bugs, breaking side effects, developer workflow failures, and
10
- unintended feature exposure in added or modified code. Style nits stay
11
- out.
12
-
13
- This template is one model turn: read the diff, then post one comment.
14
-
15
- ## Scaffold
16
-
17
- ```text
18
- agent-sdk init ./thermo-review --template thermo-review
19
- cd thermo-review
20
- ```
21
-
22
- ## Deploy
23
-
24
- Sign in once, then deploy from a pushed checkout:
25
-
26
- ```text
27
- agent-sdk login
28
- agent-sdk deploy --cursor-events-repo acme/api
29
- ```
30
-
31
- Repeat `--cursor-events-repo` for each repo. Every repo must share one
32
- owner. The deployment watches those repos through your team's Cursor
33
- GitHub connection and reviews each opened PR. No webhook or local
34
- server.
35
-
36
- Change repos later without redeploying:
37
-
38
- ```text
39
- agent-sdk deployment update thermo-review --event-repo acme/api --event-repo acme/web
40
- ```
41
-
42
- ## Try it locally
43
-
44
- Skip the deploy while you iterate. Start the relay for one repo:
45
-
46
- ```text
47
- agent-sdk dev --cursor-events --repo acme/api
48
- ```
49
-
50
- Open a PR, or replay a known one without pushing:
51
-
52
- ```text
53
- agent-sdk github replay https://github.com/acme/api/pull/12 --dir .
54
- ```
55
-
56
- `replay` needs pull access. Draft PRs are ignored. The channel writes
57
- `pr/diff.patch`, then starts a model turn. The model calls
58
- `post_findings` once. Chat replies stay in the playground.
59
- `post_findings` writes the GitHub comment.
60
-
61
- Connect GitHub in Cursor first (Settings or
62
- [cursor.com/dashboard](https://cursor.com/dashboard)) so the relay and
63
- API calls use your account. See the [GitHub guide](../guides/github.md).
64
-
65
- ## Evals
66
-
67
- Use the two smoke cases, one auth-bypass fixture and one docs-only
68
- change, as a local exercise. They need no GitHub access.
69
-
70
- ```text
71
- agent-sdk eval
72
- ```
73
-
74
- Eval sessions skip the GitHub write.
75
-
76
- ## What to edit
77
-
78
- - `bot/instructions.md`: what counts as a finding and the comment
79
- shape
80
- - `evals/review.eval.ts`: smoke cases
@@ -1,106 +0,0 @@
1
- ---
2
- title: "Triage Linear or Jira issues in place"
3
- description: "Scaffold the agent, point it at an existing ticket, tune the rubric, run evals, and deploy."
4
- ---
5
-
6
- # Triage Linear or Jira issues in place
7
-
8
- This agent comments on tickets you already filed. It classifies the
9
- issue, writes a `Triage:` comment, sets bug priority, and links a
10
- duplicate when titles match.
11
-
12
- File the ticket however you already do. This template starts after the
13
- ticket exists.
14
-
15
- ## Scaffold
16
-
17
- ```text
18
- agent-sdk init ./triage-agent --template triage-linear
19
- agent-sdk init ./triage-agent --template triage-jira
20
- ```
21
-
22
- `agent-sdk init --template triage` selects `triage-linear`.
23
-
24
- Pick the tracker you use. The agent is the same. The overlay is the
25
- connection.
26
-
27
- `init` writes the project, installs dependencies, and puts `agent-sdk`
28
- on PATH.
29
-
30
- ## Log in
31
-
32
- Model turns and Cursor MCP use your Cursor account.
33
-
34
- ```text
35
- cd triage-agent
36
- agent-sdk login
37
- ```
38
-
39
- The command opens a browser if you have no stored credential.
40
-
41
- ## Connect the tracker
42
-
43
- In the Cursor dashboard, open MCP and connect Linear or Jira.
44
-
45
- The connection stays on the host. The model calls `record_triage`.
46
- Linear and Jira tools stay off the model's tool list.
47
-
48
- Linear or Jira MCP must be connected for comments, priority changes,
49
- and duplicate links; queueing an issue can still classify it through
50
- `record_triage` without that connection.
51
-
52
- ## First verdict
53
-
54
- ```text
55
- agent-sdk dev
56
- ```
57
-
58
- Open the playground. Run `/queue/issue` and paste an existing issue.
59
-
60
- You can also POST:
61
-
62
- ```bash
63
- curl -X POST http://127.0.0.1:3000/triage-agent/v1/channels/queue/issue \
64
- -H 'content-type: application/json' \
65
- -d '{
66
- "identifier": "ENG-142",
67
- "title": "CSV export returns 500",
68
- "description": "Export has returned 500 since this morning."
69
- }'
70
- ```
71
-
72
- For create webhooks, set `LINEAR_WEBHOOK_SECRET` or
73
- `JIRA_WEBHOOK_SECRET`. Point the provider at the deployed alias under
74
- `/v1/channels/webhook`. Signed events start or resume triage for that issue.
75
-
76
- `record_triage` comments on the issue that started the session, not
77
- whatever identifier the model copies out of the ticket body.
78
-
79
- ## Rubric
80
-
81
- Edit `bot/skills/triage-rubric.md` for kinds, tie-breakers, and what
82
- `urgent` means on your team. The next turn reads the file.
83
-
84
- `bot/instructions.md` is the procedure around the rubric: missing
85
- details, when to call `record_triage`, how to reply.
86
-
87
- ## Evals
88
-
89
- Use the three smoke cases, one per kind, as a local exercise after you
90
- change the rubric.
91
-
92
- ```text
93
- agent-sdk eval
94
- ```
95
-
96
- Eval sessions skip tracker writes.
97
-
98
- ## Deploy
99
-
100
- ```text
101
- agent-sdk deploy
102
- ```
103
-
104
- Run it from the agent's git checkout. It infers repository, ref, path,
105
- and slug, builds on Cursor-managed hosting, and prints the URL.
106
- `agent-sdk deployment list` shows status.