@grok/agent-sdk 0.6.0 → 0.7.1

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 (550) hide show
  1. package/AGENTS.md +40 -0
  2. package/dist/channels/github/cursor-account.d.ts +1 -0
  3. package/dist/channels/github/cursor-account.d.ts.map +1 -1
  4. package/dist/channels/github/cursor-account.js +8 -2
  5. package/dist/channels/github/forward.d.ts +5 -0
  6. package/dist/channels/github/forward.d.ts.map +1 -1
  7. package/dist/channels/github/forward.js +6 -3
  8. package/dist/channels/origin/cursor-account.d.ts +6 -0
  9. package/dist/channels/origin/cursor-account.d.ts.map +1 -1
  10. package/dist/channels/origin/cursor-account.js +17 -0
  11. package/dist/channels/slack/api.d.ts +18 -0
  12. package/dist/channels/slack/api.d.ts.map +1 -1
  13. package/dist/channels/slack/api.js +31 -0
  14. package/dist/channels/slack/approvals.d.ts +19 -2
  15. package/dist/channels/slack/approvals.d.ts.map +1 -1
  16. package/dist/channels/slack/approvals.js +90 -19
  17. package/dist/channels/slack/attachments.d.ts +7 -2
  18. package/dist/channels/slack/attachments.d.ts.map +1 -1
  19. package/dist/channels/slack/attachments.js +318 -156
  20. package/dist/channels/slack/connect-card.d.ts +16 -0
  21. package/dist/channels/slack/connect-card.d.ts.map +1 -0
  22. package/dist/channels/slack/connect-card.js +31 -0
  23. package/dist/channels/slack/credentials.d.ts +10 -2
  24. package/dist/channels/slack/credentials.d.ts.map +1 -1
  25. package/dist/channels/slack/credentials.js +17 -15
  26. package/dist/channels/slack/defaults.d.ts.map +1 -1
  27. package/dist/channels/slack/defaults.js +18 -9
  28. package/dist/channels/slack/dispatch.d.ts +1 -1
  29. package/dist/channels/slack/dispatch.d.ts.map +1 -1
  30. package/dist/channels/slack/dispatch.js +19 -3
  31. package/dist/channels/slack/inbound.d.ts +8 -2
  32. package/dist/channels/slack/inbound.d.ts.map +1 -1
  33. package/dist/channels/slack/inbound.js +25 -4
  34. package/dist/channels/slack/index.d.ts +3 -2
  35. package/dist/channels/slack/index.d.ts.map +1 -1
  36. package/dist/channels/slack/index.js +3 -2
  37. package/dist/channels/slack/init.d.ts.map +1 -1
  38. package/dist/channels/slack/init.js +2 -1
  39. package/dist/channels/slack/mentions.d.ts +28 -0
  40. package/dist/channels/slack/mentions.d.ts.map +1 -0
  41. package/dist/channels/slack/mentions.js +178 -0
  42. package/dist/channels/slack/setup.js +1 -1
  43. package/dist/channels/slack/slack-channel.d.ts.map +1 -1
  44. package/dist/channels/slack/slack-channel.js +46 -3
  45. package/dist/channels/slack/stop.d.ts.map +1 -1
  46. package/dist/channels/slack/stop.js +7 -1
  47. package/dist/channels/slack/thread-context.d.ts +3 -0
  48. package/dist/channels/slack/thread-context.d.ts.map +1 -1
  49. package/dist/channels/slack/thread-context.js +17 -7
  50. package/dist/channels/slack/tool-approval-events.d.ts.map +1 -1
  51. package/dist/channels/slack/tool-approval-events.js +55 -2
  52. package/dist/channels/slack/types.d.ts +2 -0
  53. package/dist/channels/slack/types.d.ts.map +1 -1
  54. package/dist/channels/teams/activity.d.ts +33 -0
  55. package/dist/channels/teams/activity.d.ts.map +1 -0
  56. package/dist/channels/teams/activity.js +213 -0
  57. package/dist/channels/teams/auth.d.ts +25 -0
  58. package/dist/channels/teams/auth.d.ts.map +1 -0
  59. package/dist/channels/teams/auth.js +55 -0
  60. package/dist/channels/teams/bot-framework-auth.d.ts +33 -0
  61. package/dist/channels/teams/bot-framework-auth.d.ts.map +1 -0
  62. package/dist/channels/teams/bot-framework-auth.js +154 -0
  63. package/dist/channels/teams/cards.d.ts +23 -0
  64. package/dist/channels/teams/cards.d.ts.map +1 -0
  65. package/dist/channels/teams/cards.js +107 -0
  66. package/dist/channels/teams/connector.d.ts +48 -0
  67. package/dist/channels/teams/connector.d.ts.map +1 -0
  68. package/dist/channels/teams/connector.js +159 -0
  69. package/dist/channels/teams/credentials.d.ts +65 -0
  70. package/dist/channels/teams/credentials.d.ts.map +1 -0
  71. package/dist/channels/teams/credentials.js +84 -0
  72. package/dist/channels/teams/delivery.d.ts +14 -0
  73. package/dist/channels/teams/delivery.d.ts.map +1 -0
  74. package/dist/channels/teams/delivery.js +169 -0
  75. package/dist/channels/teams/dispatch.d.ts +45 -0
  76. package/dist/channels/teams/dispatch.d.ts.map +1 -0
  77. package/dist/channels/teams/dispatch.js +402 -0
  78. package/dist/channels/teams/engagement.d.ts +32 -0
  79. package/dist/channels/teams/engagement.d.ts.map +1 -0
  80. package/dist/channels/teams/engagement.js +120 -0
  81. package/dist/channels/teams/index.d.ts +21 -0
  82. package/dist/channels/teams/index.d.ts.map +1 -0
  83. package/dist/channels/teams/index.js +19 -0
  84. package/dist/channels/teams/marks.d.ts +19 -0
  85. package/dist/channels/teams/marks.d.ts.map +1 -0
  86. package/dist/channels/teams/marks.js +96 -0
  87. package/dist/channels/teams/senders.d.ts +27 -0
  88. package/dist/channels/teams/senders.d.ts.map +1 -0
  89. package/dist/channels/teams/senders.js +72 -0
  90. package/dist/channels/teams/teams-channel.d.ts +43 -0
  91. package/dist/channels/teams/teams-channel.d.ts.map +1 -0
  92. package/dist/channels/teams/teams-channel.js +278 -0
  93. package/dist/channels/teams/text.d.ts +7 -0
  94. package/dist/channels/teams/text.d.ts.map +1 -0
  95. package/dist/channels/teams/text.js +63 -0
  96. package/dist/channels/teams/types.d.ts +306 -0
  97. package/dist/channels/teams/types.d.ts.map +1 -0
  98. package/dist/channels/teams/types.js +1 -0
  99. package/dist/channels.d.ts +31 -0
  100. package/dist/channels.d.ts.map +1 -1
  101. package/dist/channels.js +37 -0
  102. package/dist/connections.d.ts +1 -1
  103. package/dist/connections.d.ts.map +1 -1
  104. package/dist/docs/404.html +3 -3
  105. package/dist/docs/assets/{app.lt-BYgI2.js → app.CpLKJnOA.js} +4 -4
  106. package/dist/docs/assets/changelog.md.DoOgjnPC.js +1 -0
  107. package/dist/docs/assets/{changelog.md.DVNB-ApU.lean.js → changelog.md.DoOgjnPC.lean.js} +1 -1
  108. package/dist/docs/assets/chunks/@localSearchIndexroot.BJ_1eI6D.js +1 -0
  109. package/dist/docs/assets/chunks/{VPLocalSearchBox.v_dV4U2Q.js → VPLocalSearchBox.Cr1HJ_9k.js} +2 -2
  110. package/dist/docs/assets/chunks/{arc.5o92kOg5.js → arc.BjpgGAMM.js} +1 -1
  111. package/dist/docs/assets/chunks/{architectureDiagram-Q4EWVU46.C-oTwnNq.js → architectureDiagram-Q4EWVU46.CKdhNPPk.js} +1 -1
  112. package/dist/docs/assets/chunks/{baseUniq.zJ-VNOib.js → baseUniq.iovoEQbg.js} +1 -1
  113. package/dist/docs/assets/chunks/{blockDiagram-DXYQGD6D.B9ZJZuPd.js → blockDiagram-DXYQGD6D.BYQIeDre.js} +1 -1
  114. package/dist/docs/assets/chunks/{c4Diagram-AHTNJAMY.BBMwSIaN.js → c4Diagram-AHTNJAMY.gbWi2q8N.js} +1 -1
  115. package/dist/docs/assets/chunks/channel.BP0n324b.js +1 -0
  116. package/dist/docs/assets/chunks/{chunk-4BX2VUAB.D8qAJpDD.js → chunk-4BX2VUAB.1Mem4UG9.js} +1 -1
  117. package/dist/docs/assets/chunks/{chunk-4TB4RGXK.B8QR5cdE.js → chunk-4TB4RGXK.Dn3H-X_H.js} +1 -1
  118. package/dist/docs/assets/chunks/{chunk-55IACEB6.BsWxVuew.js → chunk-55IACEB6.BkpSDZwX.js} +1 -1
  119. package/dist/docs/assets/chunks/{chunk-EDXVE4YY.BeGygY_i.js → chunk-EDXVE4YY.BScqy1zP.js} +1 -1
  120. package/dist/docs/assets/chunks/{chunk-FMBD7UC4.DdwgH-ZH.js → chunk-FMBD7UC4.Cp394LWf.js} +1 -1
  121. package/dist/docs/assets/chunks/{chunk-OYMX7WX6.B9zC_ALe.js → chunk-OYMX7WX6.BDv9LhoL.js} +1 -1
  122. package/dist/docs/assets/chunks/{chunk-QZHKN3VN.BIxJ0rcL.js → chunk-QZHKN3VN.CsgCcrKO.js} +1 -1
  123. package/dist/docs/assets/chunks/{chunk-YZCP3GAM.qiM_23_f.js → chunk-YZCP3GAM.BKBpIC5O.js} +1 -1
  124. package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.BhTtyWMA.js +1 -0
  125. package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.BhTtyWMA.js +1 -0
  126. package/dist/docs/assets/chunks/clone.BVK2rFqj.js +1 -0
  127. package/dist/docs/assets/chunks/{cose-bilkent-S5V4N54A.BKB971D5.js → cose-bilkent-S5V4N54A.Bs3ZS9PC.js} +1 -1
  128. package/dist/docs/assets/chunks/{dagre-KV5264BT.CcILjJgp.js → dagre-KV5264BT.CgWi0tY2.js} +1 -1
  129. package/dist/docs/assets/chunks/{diagram-5BDNPKRD.DkY9A0nu.js → diagram-5BDNPKRD.rn6qIo9N.js} +1 -1
  130. package/dist/docs/assets/chunks/{diagram-G4DWMVQ6.BbdzmjMt.js → diagram-G4DWMVQ6.ChhW8oww.js} +1 -1
  131. package/dist/docs/assets/chunks/{diagram-MMDJMWI5.Be0zy1cM.js → diagram-MMDJMWI5.C0wH5KSk.js} +1 -1
  132. package/dist/docs/assets/chunks/{diagram-TYMM5635.zOiEycLe.js → diagram-TYMM5635.CNEcrwA0.js} +1 -1
  133. package/dist/docs/assets/chunks/{erDiagram-SMLLAGMA.DUd_9HMF.js → erDiagram-SMLLAGMA.DCsnKO-7.js} +1 -1
  134. package/dist/docs/assets/chunks/{flowDiagram-DWJPFMVM.2KPYoZBO.js → flowDiagram-DWJPFMVM.WCMkfvP0.js} +1 -1
  135. package/dist/docs/assets/chunks/{ganttDiagram-T4ZO3ILL.DqE8_YpP.js → ganttDiagram-T4ZO3ILL.BUb1Sxfr.js} +1 -1
  136. package/dist/docs/assets/chunks/{gitGraphDiagram-UUTBAWPF.CO0Tk47h.js → gitGraphDiagram-UUTBAWPF._kORbCzm.js} +1 -1
  137. package/dist/docs/assets/chunks/{graph.CNe5KbNy.js → graph.PrGRm4KW.js} +1 -1
  138. package/dist/docs/assets/chunks/{infoDiagram-42DDH7IO.BBhJ1X1B.js → infoDiagram-42DDH7IO.BxhCjiQM.js} +1 -1
  139. package/dist/docs/assets/chunks/{ishikawaDiagram-UXIWVN3A.KSIw9w3I.js → ishikawaDiagram-UXIWVN3A.5ddTis2y.js} +1 -1
  140. package/dist/docs/assets/chunks/{journeyDiagram-VCZTEJTY.BN2Y5oUJ.js → journeyDiagram-VCZTEJTY.BUStU27-.js} +1 -1
  141. package/dist/docs/assets/chunks/{kanban-definition-6JOO6SKY.2KFuDYn_.js → kanban-definition-6JOO6SKY.CJd1psl3.js} +1 -1
  142. package/dist/docs/assets/chunks/{layout.Demb_pzL.js → layout.DqvbZSML.js} +1 -1
  143. package/dist/docs/assets/chunks/{linear.kYKxzbbR.js → linear.DOmz-1UB.js} +1 -1
  144. package/dist/docs/assets/chunks/{min.DwmCN5dF.js → min.33k2v8dM.js} +1 -1
  145. package/dist/docs/assets/chunks/{mindmap-definition-QFDTVHPH.CGlz01QG.js → mindmap-definition-QFDTVHPH.iISCqCXC.js} +1 -1
  146. package/dist/docs/assets/chunks/{pieDiagram-DEJITSTG.n3qsq4nA.js → pieDiagram-DEJITSTG.BHvVgzmD.js} +1 -1
  147. package/dist/docs/assets/chunks/{quadrantDiagram-34T5L4WZ.CGNJ1GSb.js → quadrantDiagram-34T5L4WZ.CY3w_-Cn.js} +1 -1
  148. package/dist/docs/assets/chunks/{requirementDiagram-MS252O5E.VhAzHDwQ.js → requirementDiagram-MS252O5E.CHXKQS1v.js} +1 -1
  149. package/dist/docs/assets/chunks/{sankeyDiagram-XADWPNL6.DmHA5pW-.js → sankeyDiagram-XADWPNL6.DTtRoGss.js} +1 -1
  150. package/dist/docs/assets/chunks/{sequenceDiagram-FGHM5R23._TC1aKhg.js → sequenceDiagram-FGHM5R23.NnPcQ3eY.js} +1 -1
  151. package/dist/docs/assets/chunks/{stateDiagram-FHFEXIEX.B-kLjV3O.js → stateDiagram-FHFEXIEX.D8DFciH7.js} +1 -1
  152. package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.ESAwmMws.js +1 -0
  153. package/dist/docs/assets/chunks/{theme.BaVlHHL-.js → theme.CwkiT-Fo.js} +2 -2
  154. package/dist/docs/assets/chunks/{timeline-definition-GMOUNBTQ.CresbphV.js → timeline-definition-GMOUNBTQ._wIWkMU6.js} +1 -1
  155. package/dist/docs/assets/chunks/{vennDiagram-DHZGUBPP.CegHD8Y4.js → vennDiagram-DHZGUBPP.NLVv7R6r.js} +1 -1
  156. package/dist/docs/assets/chunks/{wardley-RL74JXVD.DjCmZrUO.js → wardley-RL74JXVD.DbsCXUZp.js} +1 -1
  157. package/dist/docs/assets/chunks/{wardleyDiagram-NUSXRM2D.BJ7s1zdZ.js → wardleyDiagram-NUSXRM2D.Dp5uAVDl.js} +1 -1
  158. package/dist/docs/assets/chunks/{xychartDiagram-5P7HB3ND.IrEXlemI.js → xychartDiagram-5P7HB3ND.eOEBq4rX.js} +1 -1
  159. package/dist/docs/assets/{deployment.md.DJtuDVLh.js → deployment.md.CIRydNl3.js} +3 -3
  160. package/dist/docs/assets/{deployment.md.DJtuDVLh.lean.js → deployment.md.CIRydNl3.lean.js} +1 -1
  161. package/dist/docs/assets/guides_cloud-agents.md.BdWqmUGb.js +14 -0
  162. package/dist/docs/assets/{guides_cloud-agents.md.CiXAW6on.lean.js → guides_cloud-agents.md.BdWqmUGb.lean.js} +1 -1
  163. package/dist/docs/assets/guides_teams.md.7Lz2sbqB.js +50 -0
  164. package/dist/docs/assets/guides_teams.md.7Lz2sbqB.lean.js +1 -0
  165. package/dist/docs/assets/guides_workload-identity.md.DBV6YkXX.js +82 -0
  166. package/dist/docs/assets/guides_workload-identity.md.DBV6YkXX.lean.js +1 -0
  167. package/dist/docs/assets/{reference_agent-config.md.Bbqf0lgS.js → reference_agent-config.md.CfM1S6Ac.js} +2 -2
  168. package/dist/docs/assets/{reference_agent-config.md.Bbqf0lgS.lean.js → reference_agent-config.md.CfM1S6Ac.lean.js} +1 -1
  169. package/dist/docs/assets/{reference_channels.md.CPWOpdsC.js → reference_channels.md.CRvqgU0n.js} +1 -1
  170. package/dist/docs/assets/{reference_cli.md.DHm6DmYk.js → reference_cli.md.NS6U5a-7.js} +14 -4
  171. package/dist/docs/assets/{reference_cli.md.DHm6DmYk.lean.js → reference_cli.md.NS6U5a-7.lean.js} +1 -1
  172. package/dist/docs/assets/{reference_limits.md.CbdtFr4T.js → reference_limits.md.CW9PTdxr.js} +3 -3
  173. package/dist/docs/assets/{reference_limits.md.CbdtFr4T.lean.js → reference_limits.md.CW9PTdxr.lean.js} +1 -1
  174. package/dist/docs/assets/{reference_schedules.md.RhQ9ZLo1.js → reference_schedules.md.Dd8_d0WG.js} +3 -3
  175. package/dist/docs/assets/{reference_sessions.md.NXVQt9mP.js → reference_sessions.md.CoCyQLEz.js} +2 -2
  176. package/dist/docs/assets/{reference_sessions.md.NXVQt9mP.lean.js → reference_sessions.md.CoCyQLEz.lean.js} +1 -1
  177. package/dist/docs/assets/{reference_skills.md.DzCPNPkG.js → reference_skills.md.SFRZDC41.js} +4 -4
  178. package/dist/docs/assets/{reference_skills.md.DzCPNPkG.lean.js → reference_skills.md.SFRZDC41.lean.js} +1 -1
  179. package/dist/docs/assets/{style.DK0YX1WL.css → style.B7zPxANR.css} +1 -1
  180. package/dist/docs/assets/troubleshooting.md.CsQTleto.js +3 -0
  181. package/dist/docs/assets/{troubleshooting.md.DfKKvW1R.lean.js → troubleshooting.md.CsQTleto.lean.js} +1 -1
  182. package/dist/docs/building-with-agents.html +37 -37
  183. package/dist/docs/changelog.html +37 -37
  184. package/dist/docs/changelog.md +43 -0
  185. package/dist/docs/deployment.html +40 -40
  186. package/dist/docs/deployment.md +14 -0
  187. package/dist/docs/evals.html +37 -37
  188. package/dist/docs/guides/agent-to-agent.html +37 -37
  189. package/dist/docs/guides/bitbucket.html +37 -37
  190. package/dist/docs/guides/cloud-agents.html +43 -38
  191. package/dist/docs/guides/cloud-agents.md +47 -0
  192. package/dist/docs/guides/convert-automation.html +37 -37
  193. package/dist/docs/guides/github.html +37 -37
  194. package/dist/docs/guides/gitlab.html +37 -37
  195. package/dist/docs/guides/improve.html +37 -37
  196. package/dist/docs/guides/jev.html +37 -37
  197. package/dist/docs/guides/mcp-oauth.html +37 -37
  198. package/dist/docs/guides/migrate.html +37 -37
  199. package/dist/docs/guides/opentelemetry.html +37 -37
  200. package/dist/docs/guides/pagerduty.html +37 -37
  201. package/dist/docs/guides/slack.html +37 -37
  202. package/dist/docs/guides/teams.html +109 -0
  203. package/dist/docs/guides/teams.md +384 -0
  204. package/dist/docs/guides/webhooks.html +37 -37
  205. package/dist/docs/guides/workload-identity.html +141 -0
  206. package/dist/docs/guides/workload-identity.md +227 -0
  207. package/dist/docs/hashmap.json +1 -1
  208. package/dist/docs/hillclimbing.html +37 -37
  209. package/dist/docs/index.html +37 -37
  210. package/dist/docs/llms-full.txt +881 -5
  211. package/dist/docs/llms.txt +2 -0
  212. package/dist/docs/quickstart.html +37 -37
  213. package/dist/docs/reference/access.html +36 -36
  214. package/dist/docs/reference/agent-config.html +39 -39
  215. package/dist/docs/reference/agent-config.md +1 -1
  216. package/dist/docs/reference/artifacts.html +37 -37
  217. package/dist/docs/reference/channels.html +38 -38
  218. package/dist/docs/reference/channels.md +1 -0
  219. package/dist/docs/reference/cli.html +50 -40
  220. package/dist/docs/reference/cli.md +116 -0
  221. package/dist/docs/reference/connections.html +37 -37
  222. package/dist/docs/reference/evals.html +37 -37
  223. package/dist/docs/reference/extensions.html +37 -37
  224. package/dist/docs/reference/hooks.html +37 -37
  225. package/dist/docs/reference/http-api.html +37 -37
  226. package/dist/docs/reference/instructions.html +37 -37
  227. package/dist/docs/reference/limits.html +39 -39
  228. package/dist/docs/reference/limits.md +4 -4
  229. package/dist/docs/reference/memory.html +37 -37
  230. package/dist/docs/reference/playground.html +36 -36
  231. package/dist/docs/reference/project-layout.html +37 -37
  232. package/dist/docs/reference/schedules.html +40 -40
  233. package/dist/docs/reference/sessions.html +38 -38
  234. package/dist/docs/reference/sessions.md +13 -0
  235. package/dist/docs/reference/skills.html +40 -40
  236. package/dist/docs/reference/subagents.html +37 -37
  237. package/dist/docs/reference/tools.html +37 -37
  238. package/dist/docs/templates/agentic-owners.html +37 -37
  239. package/dist/docs/templates/reviews.html +37 -37
  240. package/dist/docs/troubleshooting.html +38 -38
  241. package/dist/docs/troubleshooting.md +21 -0
  242. package/dist/evals/run-facts.d.ts.map +1 -1
  243. package/dist/evals/run-facts.js +4 -0
  244. package/dist/extensions/cursor-cloud-agents/channels/cursor-cloud-agents.d.ts +12 -0
  245. package/dist/extensions/cursor-cloud-agents/channels/cursor-cloud-agents.d.ts.map +1 -0
  246. package/dist/extensions/cursor-cloud-agents/channels/cursor-cloud-agents.js +42 -0
  247. package/dist/extensions/cursor-cloud-agents/extension.d.ts +10 -7
  248. package/dist/extensions/cursor-cloud-agents/extension.d.ts.map +1 -1
  249. package/dist/extensions/cursor-cloud-agents/extension.js +3 -2
  250. package/dist/extensions/cursor-cloud-agents/lib/agent-id.d.ts +5 -0
  251. package/dist/extensions/cursor-cloud-agents/lib/agent-id.d.ts.map +1 -0
  252. package/dist/extensions/cursor-cloud-agents/lib/agent-id.js +10 -0
  253. package/dist/extensions/cursor-cloud-agents/lib/backend.d.ts +57 -3
  254. package/dist/extensions/cursor-cloud-agents/lib/backend.d.ts.map +1 -1
  255. package/dist/extensions/cursor-cloud-agents/lib/backend.js +150 -35
  256. package/dist/extensions/cursor-cloud-agents/lib/fleet.d.ts +32 -4
  257. package/dist/extensions/cursor-cloud-agents/lib/fleet.d.ts.map +1 -1
  258. package/dist/extensions/cursor-cloud-agents/lib/fleet.js +93 -7
  259. package/dist/extensions/cursor-cloud-agents/lib/launch-agent.d.ts +24 -7
  260. package/dist/extensions/cursor-cloud-agents/lib/launch-agent.d.ts.map +1 -1
  261. package/dist/extensions/cursor-cloud-agents/lib/launch-agent.js +158 -25
  262. package/dist/extensions/cursor-cloud-agents/lib/stop-signal.d.ts +18 -0
  263. package/dist/extensions/cursor-cloud-agents/lib/stop-signal.d.ts.map +1 -0
  264. package/dist/extensions/cursor-cloud-agents/lib/stop-signal.js +27 -0
  265. package/dist/extensions/cursor-cloud-agents/lib/transcript.d.ts.map +1 -1
  266. package/dist/extensions/cursor-cloud-agents/lib/transcript.js +2 -3
  267. package/dist/extensions/cursor-cloud-agents/lib/watch.d.ts +26 -12
  268. package/dist/extensions/cursor-cloud-agents/lib/watch.d.ts.map +1 -1
  269. package/dist/extensions/cursor-cloud-agents/lib/watch.js +115 -46
  270. package/dist/extensions/cursor-cloud-agents/reminders/cloud-agent-stop-watch.d.ts +16 -5
  271. package/dist/extensions/cursor-cloud-agents/reminders/cloud-agent-stop-watch.d.ts.map +1 -1
  272. package/dist/extensions/cursor-cloud-agents/reminders/cloud-agent-stop-watch.js +76 -20
  273. package/dist/extensions/cursor-cloud-agents/skills/handoff.md +2 -2
  274. package/dist/extensions/cursor-cloud-agents/tools/get.js +2 -2
  275. package/dist/extensions/cursor-cloud-agents/tools/launch.js +1 -1
  276. package/dist/extensions.d.ts.map +1 -1
  277. package/dist/extensions.js +18 -3
  278. package/dist/files-backends/agent-store-presigned-url.js +5 -1
  279. package/dist/index.d.ts +1 -0
  280. package/dist/index.d.ts.map +1 -1
  281. package/dist/index.js +1 -0
  282. package/dist/internal/approval-gate.d.ts +6 -1
  283. package/dist/internal/approval-gate.d.ts.map +1 -1
  284. package/dist/internal/approval-gate.js +13 -2
  285. package/dist/internal/authored-loaders.js +1 -1
  286. package/dist/internal/channel-architecture.d.ts.map +1 -1
  287. package/dist/internal/channel-architecture.js +3 -1
  288. package/dist/internal/cli/commands/channels.d.ts +9 -3
  289. package/dist/internal/cli/commands/channels.d.ts.map +1 -1
  290. package/dist/internal/cli/commands/channels.js +193 -4
  291. package/dist/internal/cli/commands/index.d.ts.map +1 -1
  292. package/dist/internal/cli/commands/index.js +6 -1
  293. package/dist/internal/cli/commands/serve.d.ts.map +1 -1
  294. package/dist/internal/cli/commands/serve.js +25 -5
  295. package/dist/internal/cli/dispatch.d.ts.map +1 -1
  296. package/dist/internal/cli/dispatch.js +22 -8
  297. package/dist/internal/cli/flags.d.ts +14 -0
  298. package/dist/internal/cli/flags.d.ts.map +1 -1
  299. package/dist/internal/cli/flags.js +14 -0
  300. package/dist/internal/cli/help.d.ts.map +1 -1
  301. package/dist/internal/cli/help.js +3 -1
  302. package/dist/internal/cli-ax.d.ts.map +1 -1
  303. package/dist/internal/cli-ax.js +6 -3
  304. package/dist/internal/cli-cursor.js +2 -2
  305. package/dist/internal/cli-deploy.d.ts +1 -0
  306. package/dist/internal/cli-deploy.d.ts.map +1 -1
  307. package/dist/internal/cli-deploy.js +19 -1
  308. package/dist/internal/cli-mcp.d.ts.map +1 -1
  309. package/dist/internal/cli-mcp.js +5 -3
  310. package/dist/internal/cli-teams-doctor.d.ts +39 -0
  311. package/dist/internal/cli-teams-doctor.d.ts.map +1 -0
  312. package/dist/internal/cli-teams-doctor.js +508 -0
  313. package/dist/internal/cli-teams-forward.d.ts +84 -0
  314. package/dist/internal/cli-teams-forward.d.ts.map +1 -0
  315. package/dist/internal/cli-teams-forward.js +386 -0
  316. package/dist/internal/cli-teams-package.d.ts +26 -0
  317. package/dist/internal/cli-teams-package.d.ts.map +1 -0
  318. package/dist/internal/cli-teams-package.js +123 -0
  319. package/dist/internal/cli-teams.d.ts +15 -0
  320. package/dist/internal/cli-teams.d.ts.map +1 -0
  321. package/dist/internal/cli-teams.js +253 -0
  322. package/dist/internal/connect-click.d.ts +12 -0
  323. package/dist/internal/connect-click.d.ts.map +1 -0
  324. package/dist/internal/connect-click.js +22 -0
  325. package/dist/internal/continuation-channel.d.ts +5 -1
  326. package/dist/internal/continuation-channel.d.ts.map +1 -1
  327. package/dist/internal/continuation-channel.js +34 -0
  328. package/dist/internal/continuation-identity.d.ts +7 -4
  329. package/dist/internal/continuation-identity.d.ts.map +1 -1
  330. package/dist/internal/continuation-identity.js +66 -1
  331. package/dist/internal/convert-automation/convert-workflow.js +2 -2
  332. package/dist/internal/credential-env-names.d.ts +36 -0
  333. package/dist/internal/credential-env-names.d.ts.map +1 -0
  334. package/dist/internal/credential-env-names.js +68 -0
  335. package/dist/internal/cursor/account-mcp.d.ts +67 -9
  336. package/dist/internal/cursor/account-mcp.d.ts.map +1 -1
  337. package/dist/internal/cursor/account-mcp.js +206 -25
  338. package/dist/internal/cursor/backend-client.d.ts +10 -1
  339. package/dist/internal/cursor/backend-client.d.ts.map +1 -1
  340. package/dist/internal/cursor/backend-client.js +19 -7
  341. package/dist/internal/cursor/cloud-agent-identity.d.ts +81 -0
  342. package/dist/internal/cursor/cloud-agent-identity.d.ts.map +1 -0
  343. package/dist/internal/cursor/cloud-agent-identity.js +224 -0
  344. package/dist/internal/cursor/credentials.d.ts.map +1 -1
  345. package/dist/internal/cursor/credentials.js +3 -1
  346. package/dist/internal/cursor-account-mcp-auth.d.ts +8 -1
  347. package/dist/internal/cursor-account-mcp-auth.d.ts.map +1 -1
  348. package/dist/internal/cursor-account-mcp-auth.js +22 -6
  349. package/dist/internal/deploy-client.d.ts.map +1 -1
  350. package/dist/internal/deploy-client.js +34 -2
  351. package/dist/internal/deploy-manifest.d.ts +51 -3
  352. package/dist/internal/deploy-manifest.d.ts.map +1 -1
  353. package/dist/internal/deploy-manifest.js +96 -7
  354. package/dist/internal/discovery/agent-config.d.ts.map +1 -1
  355. package/dist/internal/discovery/agent-config.js +6 -1
  356. package/dist/internal/discovery/agent.d.ts.map +1 -1
  357. package/dist/internal/discovery/agent.js +2 -1
  358. package/dist/internal/discovery/connections.d.ts +5 -0
  359. package/dist/internal/discovery/connections.d.ts.map +1 -1
  360. package/dist/internal/discovery/connections.js +71 -1
  361. package/dist/internal/discovery/extensions.d.ts.map +1 -1
  362. package/dist/internal/discovery/extensions.js +2 -0
  363. package/dist/internal/discovery/info.d.ts.map +1 -1
  364. package/dist/internal/discovery/info.js +4 -0
  365. package/dist/internal/env-file.d.ts +1 -0
  366. package/dist/internal/env-file.d.ts.map +1 -1
  367. package/dist/internal/env-file.js +18 -17
  368. package/dist/internal/env-prefix.d.ts +11 -0
  369. package/dist/internal/env-prefix.d.ts.map +1 -0
  370. package/dist/internal/env-prefix.js +23 -0
  371. package/dist/internal/event-id-dedupe.d.ts +12 -0
  372. package/dist/internal/event-id-dedupe.d.ts.map +1 -0
  373. package/dist/{channels/slack → internal}/event-id-dedupe.js +7 -4
  374. package/dist/internal/event-mapper.d.ts +7 -2
  375. package/dist/internal/event-mapper.d.ts.map +1 -1
  376. package/dist/internal/event-mapper.js +7 -0
  377. package/dist/internal/expected-delivery-failure.d.ts.map +1 -1
  378. package/dist/internal/expected-delivery-failure.js +3 -0
  379. package/dist/internal/extension-namespace.d.ts +9 -0
  380. package/dist/internal/extension-namespace.d.ts.map +1 -0
  381. package/dist/internal/extension-namespace.js +14 -0
  382. package/dist/internal/guid.d.ts +2 -0
  383. package/dist/internal/guid.d.ts.map +1 -0
  384. package/dist/internal/guid.js +4 -0
  385. package/dist/internal/host-kv-cas.d.ts +13 -0
  386. package/dist/internal/host-kv-cas.d.ts.map +1 -0
  387. package/dist/internal/host-kv-cas.js +26 -0
  388. package/dist/internal/host-kv.d.ts +4 -1
  389. package/dist/internal/host-kv.d.ts.map +1 -1
  390. package/dist/internal/host-kv.js +15 -2
  391. package/dist/internal/hosted-catch-protocol.d.ts +5 -0
  392. package/dist/internal/hosted-catch-protocol.d.ts.map +1 -1
  393. package/dist/internal/hosted-catch-protocol.js +5 -0
  394. package/dist/internal/hosted-catch.d.ts +2 -0
  395. package/dist/internal/hosted-catch.d.ts.map +1 -1
  396. package/dist/internal/hosted-catch.js +6 -1
  397. package/dist/internal/hosted-delivery-protocol.d.ts +4 -0
  398. package/dist/internal/hosted-delivery-protocol.d.ts.map +1 -1
  399. package/dist/internal/hosted-delivery-protocol.js +73 -3
  400. package/dist/internal/hosted-delivery.d.ts +9 -3
  401. package/dist/internal/hosted-delivery.d.ts.map +1 -1
  402. package/dist/internal/hosted-delivery.js +14 -3
  403. package/dist/internal/hosted-session-fixture.js +1 -1
  404. package/dist/internal/hosting.d.ts +5 -0
  405. package/dist/internal/hosting.d.ts.map +1 -1
  406. package/dist/internal/hosting.js +7 -1
  407. package/dist/internal/ids.d.ts +2 -0
  408. package/dist/internal/ids.d.ts.map +1 -1
  409. package/dist/internal/ids.js +5 -0
  410. package/dist/internal/install-cursor-skills.d.ts +6 -7
  411. package/dist/internal/install-cursor-skills.d.ts.map +1 -1
  412. package/dist/internal/install-cursor-skills.js +15 -9
  413. package/dist/internal/interview/agent-questions.d.ts +1 -1
  414. package/dist/internal/interview/agent-questions.d.ts.map +1 -1
  415. package/dist/internal/interview/agent-questions.js +4 -3
  416. package/dist/internal/local-control-plane.d.ts.map +1 -1
  417. package/dist/internal/local-control-plane.js +24 -0
  418. package/dist/internal/mcp-allowlist-in-use.d.ts +23 -0
  419. package/dist/internal/mcp-allowlist-in-use.d.ts.map +1 -0
  420. package/dist/internal/mcp-allowlist-in-use.js +93 -0
  421. package/dist/internal/mcp-endpoint.d.ts.map +1 -1
  422. package/dist/internal/mcp-endpoint.js +8 -10
  423. package/dist/internal/mcp-host.d.ts +19 -1
  424. package/dist/internal/mcp-host.d.ts.map +1 -1
  425. package/dist/internal/mcp-host.js +67 -3
  426. package/dist/internal/mcp-oauth.d.ts.map +1 -1
  427. package/dist/internal/mcp-oauth.js +5 -7
  428. package/dist/internal/oidcAudiences.d.ts +22 -0
  429. package/dist/internal/oidcAudiences.d.ts.map +1 -0
  430. package/dist/internal/oidcAudiences.js +35 -0
  431. package/dist/internal/otel/collector.d.ts.map +1 -1
  432. package/dist/internal/otel/collector.js +2 -0
  433. package/dist/internal/platform-timers.d.ts +2 -0
  434. package/dist/internal/platform-timers.d.ts.map +1 -1
  435. package/dist/internal/platform-timers.js +14 -0
  436. package/dist/internal/private-file.d.ts +32 -1
  437. package/dist/internal/private-file.d.ts.map +1 -1
  438. package/dist/internal/private-file.js +209 -7
  439. package/dist/internal/redact-values.d.ts +3 -0
  440. package/dist/internal/redact-values.d.ts.map +1 -0
  441. package/dist/internal/redact-values.js +19 -0
  442. package/dist/internal/reminder-control-plane-protocol.d.ts +7 -1
  443. package/dist/internal/reminder-control-plane-protocol.d.ts.map +1 -1
  444. package/dist/internal/reminder-followup-error.d.ts +23 -0
  445. package/dist/internal/reminder-followup-error.d.ts.map +1 -0
  446. package/dist/internal/reminder-followup-error.js +12 -0
  447. package/dist/internal/reminder-runner.d.ts +15 -1
  448. package/dist/internal/reminder-runner.d.ts.map +1 -1
  449. package/dist/internal/reminder-runner.js +95 -21
  450. package/dist/internal/resolved-connections.d.ts.map +1 -1
  451. package/dist/internal/resolved-connections.js +23 -3
  452. package/dist/internal/run-client.js +2 -1
  453. package/dist/internal/run-program.d.ts +31 -0
  454. package/dist/internal/run-program.d.ts.map +1 -0
  455. package/dist/internal/run-program.js +150 -0
  456. package/dist/internal/schedule-runner.d.ts +1 -0
  457. package/dist/internal/schedule-runner.d.ts.map +1 -1
  458. package/dist/internal/schedule-runner.js +10 -1
  459. package/dist/internal/sdk-runner.d.ts +28 -2
  460. package/dist/internal/sdk-runner.d.ts.map +1 -1
  461. package/dist/internal/sdk-runner.js +298 -38
  462. package/dist/internal/server.d.ts.map +1 -1
  463. package/dist/internal/server.js +53 -8
  464. package/dist/internal/session-credential.d.ts +14 -0
  465. package/dist/internal/session-credential.d.ts.map +1 -0
  466. package/dist/internal/session-credential.js +25 -0
  467. package/dist/internal/session-engine.d.ts +140 -6
  468. package/dist/internal/session-engine.d.ts.map +1 -1
  469. package/dist/internal/session-engine.js +583 -93
  470. package/dist/internal/storage-coordinator.d.ts +3 -1
  471. package/dist/internal/storage-coordinator.d.ts.map +1 -1
  472. package/dist/internal/storage-coordinator.js +13 -0
  473. package/dist/internal/storage-roles.d.ts +9 -1
  474. package/dist/internal/storage-roles.d.ts.map +1 -1
  475. package/dist/internal/teams-channel-profile.d.ts +41 -0
  476. package/dist/internal/teams-channel-profile.d.ts.map +1 -0
  477. package/dist/internal/teams-channel-profile.js +91 -0
  478. package/dist/internal/teams-devtunnel.d.ts +55 -0
  479. package/dist/internal/teams-devtunnel.d.ts.map +1 -0
  480. package/dist/internal/teams-devtunnel.js +205 -0
  481. package/dist/internal/teams-tunnel-proxy.d.ts +17 -0
  482. package/dist/internal/teams-tunnel-proxy.d.ts.map +1 -0
  483. package/dist/internal/teams-tunnel-proxy.js +100 -0
  484. package/dist/internal/testing/conversation-identity-vectors.d.ts +7 -1
  485. package/dist/internal/testing/conversation-identity-vectors.d.ts.map +1 -1
  486. package/dist/internal/testing/conversation-identity-vectors.js +67 -0
  487. package/dist/internal/testing/hosted-http.d.ts +15 -0
  488. package/dist/internal/testing/hosted-http.d.ts.map +1 -0
  489. package/dist/internal/testing/hosted-http.js +86 -0
  490. package/dist/internal/testing/teams-activity-fixtures.d.ts +28 -0
  491. package/dist/internal/testing/teams-activity-fixtures.d.ts.map +1 -0
  492. package/dist/internal/testing/teams-activity-fixtures.js +236 -0
  493. package/dist/internal/testing/teams-doctor-fixtures.d.ts +76 -0
  494. package/dist/internal/testing/teams-doctor-fixtures.d.ts.map +1 -0
  495. package/dist/internal/testing/teams-doctor-fixtures.js +216 -0
  496. package/dist/internal/tunnel-process.d.ts +29 -0
  497. package/dist/internal/tunnel-process.d.ts.map +1 -0
  498. package/dist/internal/tunnel-process.js +105 -0
  499. package/dist/internal/turn-context.d.ts +28 -0
  500. package/dist/internal/turn-context.d.ts.map +1 -0
  501. package/dist/internal/turn-context.js +1 -0
  502. package/dist/oidc-token.d.ts +131 -0
  503. package/dist/oidc-token.d.ts.map +1 -0
  504. package/dist/oidc-token.js +221 -0
  505. package/dist/playground/assets/chunk-YOKDWASO-BPO_8GRX.js +115 -0
  506. package/dist/playground/assets/highlighted-body-KPVGNVTW-CxEV-T_f.js +1 -0
  507. package/dist/playground/assets/index-CjFJhCtb.js +62 -0
  508. package/dist/playground/assets/index-vwUVwmk8.css +1 -0
  509. package/dist/playground/assets/mermaid-HWGCJPDP-eK-fpbFn.js +1 -0
  510. package/dist/playground/index.html +2 -2
  511. package/dist/teams-app-package.d.ts +78 -0
  512. package/dist/teams-app-package.d.ts.map +1 -0
  513. package/dist/teams-app-package.js +204 -0
  514. package/dist/tools.d.ts +1 -1
  515. package/dist/tools.d.ts.map +1 -1
  516. package/dist/types.d.ts +271 -2
  517. package/dist/types.d.ts.map +1 -1
  518. package/docs/changelog.md +43 -0
  519. package/docs/deployment.md +14 -0
  520. package/docs/guides/cloud-agents.md +47 -0
  521. package/docs/guides/teams.md +389 -0
  522. package/docs/guides/workload-identity.md +232 -0
  523. package/docs/reference/agent-config.md +1 -1
  524. package/docs/reference/channels.md +1 -0
  525. package/docs/reference/cli.md +116 -0
  526. package/docs/reference/limits.md +4 -4
  527. package/docs/reference/sessions.md +13 -0
  528. package/docs/troubleshooting.md +21 -0
  529. package/package.json +23 -46
  530. package/skills/create-agent/SKILL.md +17 -4
  531. package/skills/debug/SKILL.md +1 -0
  532. package/skills/deploy/SKILL.md +1 -1
  533. package/skills/framework-map/SKILL.md +1 -0
  534. package/skills/setup-teams/SKILL.md +141 -0
  535. package/templates/agentic-owners/bot/lib/owners/parse.ts +1 -0
  536. package/dist/channels/slack/event-id-dedupe.d.ts +0 -10
  537. package/dist/channels/slack/event-id-dedupe.d.ts.map +0 -1
  538. package/dist/docs/assets/changelog.md.DVNB-ApU.js +0 -1
  539. package/dist/docs/assets/chunks/@localSearchIndexroot.DdlR-9Oe.js +0 -1
  540. package/dist/docs/assets/chunks/channel.CdyTxaXV.js +0 -1
  541. package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.CeUcN6TW.js +0 -1
  542. package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.CeUcN6TW.js +0 -1
  543. package/dist/docs/assets/chunks/clone.DpIwUbur.js +0 -1
  544. package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.HtBkUH4J.js +0 -1
  545. package/dist/docs/assets/guides_cloud-agents.md.CiXAW6on.js +0 -9
  546. package/dist/docs/assets/troubleshooting.md.DfKKvW1R.js +0 -3
  547. package/dist/playground/assets/index-CnFd5R1_.js +0 -62
  548. package/dist/playground/assets/index-DNzRv6G8.css +0 -1
  549. /package/dist/docs/assets/{reference_channels.md.CPWOpdsC.lean.js → reference_channels.md.CRvqgU0n.lean.js} +0 -0
  550. /package/dist/docs/assets/{reference_schedules.md.RhQ9ZLo1.lean.js → reference_schedules.md.Dd8_d0WG.lean.js} +0 -0
@@ -6,45 +6,45 @@
6
6
  <title>Tools | Agent SDK</title>
7
7
  <meta name="description" content="Define typed actions the model can call, control their dry-run effects, and call any server tool without a model turn.">
8
8
  <meta name="generator" content="VitePress v1.6.4">
9
- <link rel="preload stylesheet" href="/docs/assets/style.DK0YX1WL.css" as="style">
9
+ <link rel="preload stylesheet" href="/docs/assets/style.B7zPxANR.css" as="style">
10
10
  <link rel="preload stylesheet" href="/docs/vp-icons.css" as="style">
11
11
 
12
- <script type="module" src="/docs/assets/app.lt-BYgI2.js"></script>
12
+ <script type="module" src="/docs/assets/app.CpLKJnOA.js"></script>
13
13
  <link rel="preload" href="/docs/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
14
14
  <link rel="modulepreload" href="/docs/assets/chunks/framework.BNw1pucY.js">
15
- <link rel="modulepreload" href="/docs/assets/chunks/theme.BaVlHHL-.js">
15
+ <link rel="modulepreload" href="/docs/assets/chunks/theme.CwkiT-Fo.js">
16
16
  <link rel="modulepreload" href="/docs/assets/chunks/katex.DkKDou_j.js">
17
- <link rel="modulepreload" href="/docs/assets/chunks/dagre-KV5264BT.CcILjJgp.js">
18
- <link rel="modulepreload" href="/docs/assets/chunks/cose-bilkent-S5V4N54A.BKB971D5.js">
19
- <link rel="modulepreload" href="/docs/assets/chunks/c4Diagram-AHTNJAMY.BBMwSIaN.js">
20
- <link rel="modulepreload" href="/docs/assets/chunks/flowDiagram-DWJPFMVM.2KPYoZBO.js">
21
- <link rel="modulepreload" href="/docs/assets/chunks/erDiagram-SMLLAGMA.DUd_9HMF.js">
22
- <link rel="modulepreload" href="/docs/assets/chunks/gitGraphDiagram-UUTBAWPF.CO0Tk47h.js">
23
- <link rel="modulepreload" href="/docs/assets/chunks/ganttDiagram-T4ZO3ILL.DqE8_YpP.js">
24
- <link rel="modulepreload" href="/docs/assets/chunks/infoDiagram-42DDH7IO.BBhJ1X1B.js">
25
- <link rel="modulepreload" href="/docs/assets/chunks/pieDiagram-DEJITSTG.n3qsq4nA.js">
26
- <link rel="modulepreload" href="/docs/assets/chunks/quadrantDiagram-34T5L4WZ.CGNJ1GSb.js">
27
- <link rel="modulepreload" href="/docs/assets/chunks/xychartDiagram-5P7HB3ND.IrEXlemI.js">
28
- <link rel="modulepreload" href="/docs/assets/chunks/requirementDiagram-MS252O5E.VhAzHDwQ.js">
29
- <link rel="modulepreload" href="/docs/assets/chunks/sequenceDiagram-FGHM5R23._TC1aKhg.js">
30
- <link rel="modulepreload" href="/docs/assets/chunks/classDiagram-6PBFFD2Q.CeUcN6TW.js">
31
- <link rel="modulepreload" href="/docs/assets/chunks/classDiagram-v2-HSJHXN6E.CeUcN6TW.js">
32
- <link rel="modulepreload" href="/docs/assets/chunks/stateDiagram-FHFEXIEX.B-kLjV3O.js">
33
- <link rel="modulepreload" href="/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.HtBkUH4J.js">
34
- <link rel="modulepreload" href="/docs/assets/chunks/journeyDiagram-VCZTEJTY.BN2Y5oUJ.js">
35
- <link rel="modulepreload" href="/docs/assets/chunks/timeline-definition-GMOUNBTQ.CresbphV.js">
36
- <link rel="modulepreload" href="/docs/assets/chunks/mindmap-definition-QFDTVHPH.CGlz01QG.js">
37
- <link rel="modulepreload" href="/docs/assets/chunks/kanban-definition-6JOO6SKY.2KFuDYn_.js">
38
- <link rel="modulepreload" href="/docs/assets/chunks/sankeyDiagram-XADWPNL6.DmHA5pW-.js">
39
- <link rel="modulepreload" href="/docs/assets/chunks/diagram-TYMM5635.zOiEycLe.js">
40
- <link rel="modulepreload" href="/docs/assets/chunks/diagram-MMDJMWI5.Be0zy1cM.js">
41
- <link rel="modulepreload" href="/docs/assets/chunks/blockDiagram-DXYQGD6D.B9ZJZuPd.js">
42
- <link rel="modulepreload" href="/docs/assets/chunks/diagram-5BDNPKRD.DkY9A0nu.js">
43
- <link rel="modulepreload" href="/docs/assets/chunks/architectureDiagram-Q4EWVU46.C-oTwnNq.js">
44
- <link rel="modulepreload" href="/docs/assets/chunks/ishikawaDiagram-UXIWVN3A.KSIw9w3I.js">
45
- <link rel="modulepreload" href="/docs/assets/chunks/vennDiagram-DHZGUBPP.CegHD8Y4.js">
46
- <link rel="modulepreload" href="/docs/assets/chunks/diagram-G4DWMVQ6.BbdzmjMt.js">
47
- <link rel="modulepreload" href="/docs/assets/chunks/wardleyDiagram-NUSXRM2D.BJ7s1zdZ.js">
17
+ <link rel="modulepreload" href="/docs/assets/chunks/dagre-KV5264BT.CgWi0tY2.js">
18
+ <link rel="modulepreload" href="/docs/assets/chunks/cose-bilkent-S5V4N54A.Bs3ZS9PC.js">
19
+ <link rel="modulepreload" href="/docs/assets/chunks/c4Diagram-AHTNJAMY.gbWi2q8N.js">
20
+ <link rel="modulepreload" href="/docs/assets/chunks/flowDiagram-DWJPFMVM.WCMkfvP0.js">
21
+ <link rel="modulepreload" href="/docs/assets/chunks/erDiagram-SMLLAGMA.DCsnKO-7.js">
22
+ <link rel="modulepreload" href="/docs/assets/chunks/gitGraphDiagram-UUTBAWPF._kORbCzm.js">
23
+ <link rel="modulepreload" href="/docs/assets/chunks/ganttDiagram-T4ZO3ILL.BUb1Sxfr.js">
24
+ <link rel="modulepreload" href="/docs/assets/chunks/infoDiagram-42DDH7IO.BxhCjiQM.js">
25
+ <link rel="modulepreload" href="/docs/assets/chunks/pieDiagram-DEJITSTG.BHvVgzmD.js">
26
+ <link rel="modulepreload" href="/docs/assets/chunks/quadrantDiagram-34T5L4WZ.CY3w_-Cn.js">
27
+ <link rel="modulepreload" href="/docs/assets/chunks/xychartDiagram-5P7HB3ND.eOEBq4rX.js">
28
+ <link rel="modulepreload" href="/docs/assets/chunks/requirementDiagram-MS252O5E.CHXKQS1v.js">
29
+ <link rel="modulepreload" href="/docs/assets/chunks/sequenceDiagram-FGHM5R23.NnPcQ3eY.js">
30
+ <link rel="modulepreload" href="/docs/assets/chunks/classDiagram-6PBFFD2Q.BhTtyWMA.js">
31
+ <link rel="modulepreload" href="/docs/assets/chunks/classDiagram-v2-HSJHXN6E.BhTtyWMA.js">
32
+ <link rel="modulepreload" href="/docs/assets/chunks/stateDiagram-FHFEXIEX.D8DFciH7.js">
33
+ <link rel="modulepreload" href="/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.ESAwmMws.js">
34
+ <link rel="modulepreload" href="/docs/assets/chunks/journeyDiagram-VCZTEJTY.BUStU27-.js">
35
+ <link rel="modulepreload" href="/docs/assets/chunks/timeline-definition-GMOUNBTQ._wIWkMU6.js">
36
+ <link rel="modulepreload" href="/docs/assets/chunks/mindmap-definition-QFDTVHPH.iISCqCXC.js">
37
+ <link rel="modulepreload" href="/docs/assets/chunks/kanban-definition-6JOO6SKY.CJd1psl3.js">
38
+ <link rel="modulepreload" href="/docs/assets/chunks/sankeyDiagram-XADWPNL6.DTtRoGss.js">
39
+ <link rel="modulepreload" href="/docs/assets/chunks/diagram-TYMM5635.CNEcrwA0.js">
40
+ <link rel="modulepreload" href="/docs/assets/chunks/diagram-MMDJMWI5.C0wH5KSk.js">
41
+ <link rel="modulepreload" href="/docs/assets/chunks/blockDiagram-DXYQGD6D.BYQIeDre.js">
42
+ <link rel="modulepreload" href="/docs/assets/chunks/diagram-5BDNPKRD.rn6qIo9N.js">
43
+ <link rel="modulepreload" href="/docs/assets/chunks/architectureDiagram-Q4EWVU46.CKdhNPPk.js">
44
+ <link rel="modulepreload" href="/docs/assets/chunks/ishikawaDiagram-UXIWVN3A.5ddTis2y.js">
45
+ <link rel="modulepreload" href="/docs/assets/chunks/vennDiagram-DHZGUBPP.NLVv7R6r.js">
46
+ <link rel="modulepreload" href="/docs/assets/chunks/diagram-G4DWMVQ6.ChhW8oww.js">
47
+ <link rel="modulepreload" href="/docs/assets/chunks/wardleyDiagram-NUSXRM2D.Dp5uAVDl.js">
48
48
  <link rel="modulepreload" href="/docs/assets/chunks/virtual_mermaid-config.DDnGl6nM.js">
49
49
  <link rel="modulepreload" href="/docs/assets/reference_tools.md.BhqW6neF.lean.js">
50
50
  <script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
@@ -53,7 +53,7 @@
53
53
  <link rel="alternate" type="text/markdown" href="/docs/reference/tools.md">
54
54
  </head>
55
55
  <body>
56
- <div id="app"><div class="Layout" data-v-738a160a><!--[--><!--]--><!--[--><span tabindex="-1" data-v-a98c2453></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-a98c2453>Skip to content</a><!--]--><!----><header class="VPNav" data-v-738a160a data-v-76ad4059><div class="VPNavBar" data-v-76ad4059 data-v-6fc2afcb><div class="wrapper" data-v-6fc2afcb><div class="container" data-v-6fc2afcb><div class="title" data-v-6fc2afcb><div class="VPNavBarTitle has-sidebar" data-v-6fc2afcb data-v-9e6caa3f><a class="title" href="/docs/" data-v-9e6caa3f><!--[--><!--]--><!----><span data-v-9e6caa3f>Agent SDK</span><!--[--><!--[--><!--[--><!--[--><span class="bdk-version" title="Agent SDK 0.6.0 (@grok/agent-sdk package)" data-v-a03aeddf>0.6.0</span><!--]--><!--]--><!--]--><!--]--></a></div></div><div class="content" data-v-6fc2afcb><div class="content-body" data-v-6fc2afcb><!--[--><!--]--><div class="VPNavBarSearch search" data-v-6fc2afcb><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-6fc2afcb data-v-78f72f99><span id="main-nav-aria-label" class="visually-hidden" data-v-78f72f99> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/quickstart.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Quickstart</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/guides/mcp-oauth.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Guides</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/guides/github.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Integrations</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/templates/reviews.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Templates</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/reference/project-layout.html" tabindex="0" data-v-78f72f99 data-v-a7790978><!--[--><span data-v-a7790978>Reference</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-6fc2afcb data-v-bf7c3d0f><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-bf7c3d0f data-v-e9e166e4 data-v-74f7b0ff><span class="check" data-v-74f7b0ff><span class="icon" data-v-74f7b0ff><!--[--><span class="vpi-sun sun" data-v-e9e166e4></span><span class="vpi-moon moon" data-v-e9e166e4></span><!--]--></span></span></button></div><!----><div class="VPFlyout VPNavBarExtra extra" data-v-6fc2afcb data-v-799c9281 data-v-070c9767><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-070c9767><span class="vpi-more-horizontal icon" data-v-070c9767></span></button><div class="menu" data-v-070c9767><div class="VPMenu" data-v-070c9767 data-v-c05d27ee><!----><!--[--><!--[--><!----><div class="group" data-v-799c9281><div class="item appearance" data-v-799c9281><p class="label" data-v-799c9281>Appearance</p><div class="appearance-action" data-v-799c9281><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-799c9281 data-v-e9e166e4 data-v-74f7b0ff><span class="check" data-v-74f7b0ff><span class="icon" data-v-74f7b0ff><!--[--><span class="vpi-sun sun" data-v-e9e166e4></span><span class="vpi-moon moon" data-v-e9e166e4></span><!--]--></span></span></button></div></div></div><!----><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-6fc2afcb data-v-2caaf84e><span class="container" data-v-2caaf84e><span class="top" data-v-2caaf84e></span><span class="middle" data-v-2caaf84e></span><span class="bottom" data-v-2caaf84e></span></span></button></div></div></div></div><div class="divider" data-v-6fc2afcb><div class="divider-line" data-v-6fc2afcb></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-738a160a data-v-e0cbfd80><div class="container" data-v-e0cbfd80><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-e0cbfd80><span class="vpi-align-left menu-icon" data-v-e0cbfd80></span><span class="menu-text" data-v-e0cbfd80>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-e0cbfd80 data-v-36e0b8e9><button data-v-36e0b8e9>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-738a160a data-v-2859715e><div class="curtain" data-v-2859715e></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-2859715e><span class="visually-hidden" id="sidebar-aria-label" data-v-2859715e> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Getting started</h2><!----></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/changelog.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Changelog</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/quickstart.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Build a PR reviewer</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Integrations</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/github.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>GitHub</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/slack.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Slack</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/webhooks.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Webhooks</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/convert-automation.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Cursor Automations</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/opentelemetry.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>OpenTelemetry</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/gitlab.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>GitLab</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/bitbucket.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Bitbucket</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/pagerduty.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>PagerDuty</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Extensions</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/extensions.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/cloud-agents.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Cloud agents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/improve.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Self-improvement</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/jev.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Jev</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Guides</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/mcp-oauth.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>MCP</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/agent-to-agent.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Peer agents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/deployment.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Deployment</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/guides/migrate.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Early-alpha migration</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/evals.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Evals</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/hillclimbing.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Hillclimbing</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/building-with-agents.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Build with a coding agent</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/troubleshooting.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Troubleshooting</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Templates</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/templates/reviews.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Review and triage</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/templates/agentic-owners.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Agentic Approver</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-8ed949fd><section class="VPSidebarItem level-0 collapsible has-active" data-v-8ed949fd data-v-84325fb7><div class="item" role="button" tabindex="0" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><h2 class="text" data-v-84325fb7>Reference</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-84325fb7><span class="vpi-chevron-right caret-icon" data-v-84325fb7></span></div></div><div class="items" data-v-84325fb7><!--[--><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/project-layout.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Project layout</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/agent-config.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Agent config</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/instructions.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Instructions</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/tools.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Tools</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/skills.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Skills</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/connections.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>MCP Connections</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/subagents.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Subagents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/channels.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Channels</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/schedules.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Schedules & reminders</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/hooks.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Hooks</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/memory.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Memory</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/evals.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Evals</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/artifacts.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Artifacts</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/sessions.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Sessions & streaming</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/playground.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Playground</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/cli.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>CLI</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/http-api.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>HTTP API</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/access.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Access</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-84325fb7><div class="item" data-v-84325fb7><div class="indicator" data-v-84325fb7></div><a class="VPLink link link" href="/docs/reference/limits.html" data-v-84325fb7><!--[--><p class="text" data-v-84325fb7>Limits</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-738a160a data-v-9f462cdf><div class="VPDoc has-sidebar has-aside" data-v-9f462cdf data-v-995f90b4><!--[--><!--]--><div class="container" data-v-995f90b4><div class="aside" data-v-995f90b4><div class="aside-curtain" data-v-995f90b4></div><div class="aside-container" data-v-995f90b4><div class="aside-content" data-v-995f90b4><div class="VPDocAside" data-v-995f90b4 data-v-10889960><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-10889960 data-v-afb61a88><div class="content" data-v-afb61a88><div class="outline-marker" data-v-afb61a88></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-afb61a88>On this page</div><ul class="VPDocOutlineItem root" data-v-afb61a88 data-v-0587367d><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-10889960></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-995f90b4><div class="content-container" data-v-995f90b4><!--[--><!--]--><main class="main" data-v-995f90b4><div style="position:relative;" class="vp-doc _docs_reference_tools" data-v-995f90b4><div><h1 id="tools" tabindex="-1">Tools <a class="header-anchor" href="#tools" aria-label="Permalink to &quot;Tools&quot;">​</a></h1><p>A tool is a typed action the model can call, such as hitting an API, running a query, or writing a file. Each file in <code>bot/tools/</code> defines one tool, and the filename is the name the model sees. Server tools run on the serving host, and agent tools run as scripts next to the agent.</p><h2 id="define-a-server-tool" tabindex="-1">Define a server tool <a class="header-anchor" href="#define-a-server-tool" aria-label="Permalink to &quot;Define a server tool&quot;">​</a></h2><p>By default, <code>execute</code> runs in-process on the serving host with full access to <code>process.env</code> and your <code>bot/lib/</code> code. <code>execution: &quot;server&quot;</code> is the default.</p><p>A tool needs a filename slug (the model-facing name), a <code>description</code> written for the model, an optional <code>inputSchema</code>, and the code that runs it. With a Zod schema, Agent SDK validates the input and infers its type. With plain JSON Schema, <code>execute</code> gets raw JSON.</p><p><code>prompt</code> from <code>@grok/agent-sdk</code> or <code>@grok/agent-sdk/prompt</code> dedents a template literal so a multi-line description, reminder, or error can sit indented in TypeScript. Blank lines and relative indentation stay. <code>prompt.lines</code> returns the same text as <code>string[]</code>, one entry per line.</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:#6F42C1;--shiki-dark:#B392F0;">context</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: prompt.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">lines</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">`</span></span>
56
+ <div id="app"><div class="Layout" data-v-2236bdfe><!--[--><!--]--><!--[--><span tabindex="-1" data-v-6821dd19></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-6821dd19>Skip to content</a><!--]--><!----><header class="VPNav" data-v-2236bdfe data-v-4e61ebec><div class="VPNavBar" data-v-4e61ebec data-v-9cc98aae><div class="wrapper" data-v-9cc98aae><div class="container" data-v-9cc98aae><div class="title" data-v-9cc98aae><div class="VPNavBarTitle has-sidebar" data-v-9cc98aae data-v-0af80de3><a class="title" href="/docs/" data-v-0af80de3><!--[--><!--]--><!----><span data-v-0af80de3>Agent SDK</span><!--[--><!--[--><!--[--><!--[--><span class="bdk-version" title="Agent SDK 0.7.1 (@grok/agent-sdk package)" data-v-a03aeddf>0.7.1</span><!--]--><!--]--><!--]--><!--]--></a></div></div><div class="content" data-v-9cc98aae><div class="content-body" data-v-9cc98aae><!--[--><!--]--><div class="VPNavBarSearch search" data-v-9cc98aae><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-9cc98aae data-v-292c275e><span id="main-nav-aria-label" class="visually-hidden" data-v-292c275e> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/quickstart.html" tabindex="0" data-v-292c275e data-v-4c65317e><!--[--><span data-v-4c65317e>Quickstart</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/guides/mcp-oauth.html" tabindex="0" data-v-292c275e data-v-4c65317e><!--[--><span data-v-4c65317e>Guides</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/guides/github.html" tabindex="0" data-v-292c275e data-v-4c65317e><!--[--><span data-v-4c65317e>Integrations</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/templates/reviews.html" tabindex="0" data-v-292c275e data-v-4c65317e><!--[--><span data-v-4c65317e>Templates</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/docs/reference/project-layout.html" tabindex="0" data-v-292c275e data-v-4c65317e><!--[--><span data-v-4c65317e>Reference</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-9cc98aae data-v-8870d03f><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-8870d03f data-v-437903c6 data-v-cb074f81><span class="check" data-v-cb074f81><span class="icon" data-v-cb074f81><!--[--><span class="vpi-sun sun" data-v-437903c6></span><span class="vpi-moon moon" data-v-437903c6></span><!--]--></span></span></button></div><!----><div class="VPFlyout VPNavBarExtra extra" data-v-9cc98aae data-v-8ec5d5fb data-v-b3186b2b><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-b3186b2b><span class="vpi-more-horizontal icon" data-v-b3186b2b></span></button><div class="menu" data-v-b3186b2b><div class="VPMenu" data-v-b3186b2b data-v-0615a312><!----><!--[--><!--[--><!----><div class="group" data-v-8ec5d5fb><div class="item appearance" data-v-8ec5d5fb><p class="label" data-v-8ec5d5fb>Appearance</p><div class="appearance-action" data-v-8ec5d5fb><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-8ec5d5fb data-v-437903c6 data-v-cb074f81><span class="check" data-v-cb074f81><span class="icon" data-v-cb074f81><!--[--><span class="vpi-sun sun" data-v-437903c6></span><span class="vpi-moon moon" data-v-437903c6></span><!--]--></span></span></button></div></div></div><!----><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-9cc98aae data-v-2752d785><span class="container" data-v-2752d785><span class="top" data-v-2752d785></span><span class="middle" data-v-2752d785></span><span class="bottom" data-v-2752d785></span></span></button></div></div></div></div><div class="divider" data-v-9cc98aae><div class="divider-line" data-v-9cc98aae></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-2236bdfe data-v-60cb0e48><div class="container" data-v-60cb0e48><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-60cb0e48><span class="vpi-align-left menu-icon" data-v-60cb0e48></span><span class="menu-text" data-v-60cb0e48>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-60cb0e48 data-v-179080fa><button data-v-179080fa>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-2236bdfe data-v-62bf049e><div class="curtain" data-v-62bf049e></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-62bf049e><span class="visually-hidden" id="sidebar-aria-label" data-v-62bf049e> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Getting started</h2><!----></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/changelog.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Changelog</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/quickstart.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Build a PR reviewer</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0 collapsible" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Integrations</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-9b168be9><span class="vpi-chevron-right caret-icon" data-v-9b168be9></span></div></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/github.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>GitHub</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/slack.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Slack</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/teams.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Microsoft Teams</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/webhooks.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Webhooks</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/convert-automation.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Cursor Automations</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/opentelemetry.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>OpenTelemetry</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/gitlab.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>GitLab</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/bitbucket.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Bitbucket</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/pagerduty.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>PagerDuty</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0 collapsible" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Extensions</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-9b168be9><span class="vpi-chevron-right caret-icon" data-v-9b168be9></span></div></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/extensions.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/cloud-agents.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Cloud agents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/improve.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Self-improvement</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/jev.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Jev</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0 collapsible" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Guides</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-9b168be9><span class="vpi-chevron-right caret-icon" data-v-9b168be9></span></div></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/mcp-oauth.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>MCP</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/agent-to-agent.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Peer agents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/deployment.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Deployment</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/workload-identity.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Workload identity (OIDC)</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/guides/migrate.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Early-alpha migration</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/evals.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Evals</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/hillclimbing.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Hillclimbing</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/building-with-agents.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Build with a coding agent</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/troubleshooting.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Troubleshooting</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0 collapsible" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Templates</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-9b168be9><span class="vpi-chevron-right caret-icon" data-v-9b168be9></span></div></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/templates/reviews.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Review and triage</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/templates/agentic-owners.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Agentic Approver</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-607aa6d2><section class="VPSidebarItem level-0 collapsible has-active" data-v-607aa6d2 data-v-9b168be9><div class="item" role="button" tabindex="0" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><h2 class="text" data-v-9b168be9>Reference</h2><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-9b168be9><span class="vpi-chevron-right caret-icon" data-v-9b168be9></span></div></div><div class="items" data-v-9b168be9><!--[--><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/project-layout.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Project layout</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/agent-config.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Agent config</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/instructions.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Instructions</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/tools.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Tools</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/skills.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Skills</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/connections.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>MCP Connections</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/subagents.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Subagents</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/channels.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Channels</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/schedules.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Schedules & reminders</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/hooks.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Hooks</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/memory.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Memory</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/evals.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Evals</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/artifacts.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Artifacts</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/sessions.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Sessions & streaming</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/playground.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Playground</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/cli.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>CLI</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/http-api.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>HTTP API</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/access.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Access</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-9b168be9><div class="item" data-v-9b168be9><div class="indicator" data-v-9b168be9></div><a class="VPLink link link" href="/docs/reference/limits.html" data-v-9b168be9><!--[--><p class="text" data-v-9b168be9>Limits</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-2236bdfe data-v-d04ebd1c><div class="VPDoc has-sidebar has-aside" data-v-d04ebd1c data-v-1686efb8><!--[--><!--]--><div class="container" data-v-1686efb8><div class="aside" data-v-1686efb8><div class="aside-curtain" data-v-1686efb8></div><div class="aside-container" data-v-1686efb8><div class="aside-content" data-v-1686efb8><div class="VPDocAside" data-v-1686efb8 data-v-95dd70cb><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-95dd70cb data-v-73c4e114><div class="content" data-v-73c4e114><div class="outline-marker" data-v-73c4e114></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-73c4e114>On this page</div><ul class="VPDocOutlineItem root" data-v-73c4e114 data-v-754cbe32><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-95dd70cb></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-1686efb8><div class="content-container" data-v-1686efb8><!--[--><!--]--><main class="main" data-v-1686efb8><div style="position:relative;" class="vp-doc _docs_reference_tools" data-v-1686efb8><div><h1 id="tools" tabindex="-1">Tools <a class="header-anchor" href="#tools" aria-label="Permalink to &quot;Tools&quot;">​</a></h1><p>A tool is a typed action the model can call, such as hitting an API, running a query, or writing a file. Each file in <code>bot/tools/</code> defines one tool, and the filename is the name the model sees. Server tools run on the serving host, and agent tools run as scripts next to the agent.</p><h2 id="define-a-server-tool" tabindex="-1">Define a server tool <a class="header-anchor" href="#define-a-server-tool" aria-label="Permalink to &quot;Define a server tool&quot;">​</a></h2><p>By default, <code>execute</code> runs in-process on the serving host with full access to <code>process.env</code> and your <code>bot/lib/</code> code. <code>execution: &quot;server&quot;</code> is the default.</p><p>A tool needs a filename slug (the model-facing name), a <code>description</code> written for the model, an optional <code>inputSchema</code>, and the code that runs it. With a Zod schema, Agent SDK validates the input and infers its type. With plain JSON Schema, <code>execute</code> gets raw JSON.</p><p><code>prompt</code> from <code>@grok/agent-sdk</code> or <code>@grok/agent-sdk/prompt</code> dedents a template literal so a multi-line description, reminder, or error can sit indented in TypeScript. Blank lines and relative indentation stay. <code>prompt.lines</code> returns the same text as <code>string[]</code>, one entry per line.</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:#6F42C1;--shiki-dark:#B392F0;">context</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: prompt.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">lines</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">`</span></span>
57
57
  <span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> Merged PR detected: ${</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">pr</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">.</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">url</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">} by ${</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">author</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">}.</span></span>
58
58
  <span class="line"></span>
59
59
  <span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> Call plan_deploy, then follow its nextStep.</span></span>
@@ -116,8 +116,8 @@
116
116
  <span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -d</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &#39;{&quot;input&quot;:{&quot;path&quot;:&quot;README.md&quot;},&quot;sessionId&quot;:&quot;&lt;session&gt;&quot;}&#39;</span></span></code></pre></div><p>Programmatically, <code>callTool(toolName, input, options?)</code> is available on the serve handle, on channel route handlers and <code>onStart</code> args, and on schedule <code>run</code> handlers, so a channel can mix deterministic calls with model turns:</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;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> outcome</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;"> handle.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">callTool</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;inspect_pr&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, {</span></span>
117
117
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> prUrl: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;https://github.com/acme/checkout/pull/42&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
118
118
  <span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span>
119
- <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// { toolName, callId, isError, result, durationMs }</span></span></code></pre></div><p>Omit both identifiers to run against an ephemeral workspace that is removed when the call returns. Pass <code>sessionId</code> (HTTP body, <code>--session</code>, or <code>options.sessionId</code>) or <code>continuationToken</code> (<code>&lt;channelId&gt;:&lt;key&gt;</code> as <code>/v1/sessions</code> lists it) to bind the call. The two are mutually exclusive.</p><table tabindex="0"><thead><tr><th>Rule</th><th>What happens</th></tr></thead><tbody><tr><td>Existing <code>sessionId</code>, or a token that maps to an existing session</td><td>Session workspace, owner check, and event recording</td></tr><tr><td>Token with no matching session</td><td>Scratch workspace; the token&#39;s channel id and key are the call identity</td></tr><tr><td>Busy session, <code>effect: &quot;read&quot;</code> (or an advertised MCP tool marked read-only)</td><td>Runs alongside the turn, reading the workspace as the turn left it; recorded under its own <code>turnId</code></td></tr><tr><td>Busy session, write, idempotent, or undeclared</td><td><code>409 session_busy</code> until the turn finishes</td></tr><tr><td>Session workspace cannot be created, read</td><td>Scratch workspace; the outcome has <code>scratchWorkspace: true</code></td></tr><tr><td>Session workspace cannot be created, write</td><td><code>500 workspace_unavailable</code></td></tr></tbody></table><table tabindex="0"><thead><tr><th>Error</th><th>When</th></tr></thead><tbody><tr><td><code>404 unknown_tool</code></td><td>Name is not a callable server tool; the response lists available names</td></tr><tr><td><code>400 tool_not_callable</code></td><td>Agent-execution tools cannot run on the host</td></tr><tr><td><code>400 invalid_tool_input</code></td><td>Zod rejected the input before <code>execute</code>. Plain JSON Schema is forwarded unvalidated</td></tr><tr><td><code>400 invalid_continuation_token</code></td><td>Malformed token, or passed together with <code>sessionId</code></td></tr><tr><td><code>404 session_not_found</code></td><td><code>sessionId</code> does not exist</td></tr><tr><td><code>409 session_busy</code></td><td>Write-effect call while a model turn is running</td></tr><tr><td><code>500 workspace_unavailable</code></td><td>Write-effect call when the session workspace cannot be created</td></tr><tr><td><code>isError: true</code></td><td>The tool body threw; same envelope the model would see</td></tr></tbody></table><p>See also <a href="./connections.html">MCP connections</a>, <a href="./extensions.html">Extensions</a>, and <a href="./../evals.html">Evals</a>.</p></div></div></main><footer class="VPDocFooter" data-v-995f90b4 data-v-8edf72db><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-8edf72db><span class="visually-hidden" id="doc-footer-aria-label" data-v-8edf72db>Pager</span><div class="pager" data-v-8edf72db><a class="VPLink link pager-link prev" href="/docs/reference/instructions.html" data-v-8edf72db><!--[--><span class="desc" data-v-8edf72db>Previous page</span><span class="title" data-v-8edf72db>Instructions</span><!--]--></a></div><div class="pager" data-v-8edf72db><a class="VPLink link pager-link next" href="/docs/reference/skills.html" data-v-8edf72db><!--[--><span class="desc" data-v-8edf72db>Next page</span><span class="title" data-v-8edf72db>Skills</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
120
- <script>window.__VP_HASH_MAP__=JSON.parse("{\"building-with-agents.md\":\"Bo3ct-rf\",\"changelog.md\":\"DVNB-ApU\",\"deployment.md\":\"DJtuDVLh\",\"evals.md\":\"Dne6VRmZ\",\"guides_agent-to-agent.md\":\"DcB3nhOz\",\"guides_bitbucket.md\":\"BiA6ZMFW\",\"guides_cloud-agents.md\":\"CiXAW6on\",\"guides_convert-automation.md\":\"BvTxsJ8J\",\"guides_github.md\":\"CcuZ7keS\",\"guides_gitlab.md\":\"DcKusOcU\",\"guides_improve.md\":\"o3WOGR7n\",\"guides_jev.md\":\"DGCzkMUN\",\"guides_mcp-oauth.md\":\"GVPMKcYl\",\"guides_migrate.md\":\"B8CZxnnX\",\"guides_opentelemetry.md\":\"BRSktBHt\",\"guides_pagerduty.md\":\"pMXUkZZc\",\"guides_slack.md\":\"D7Rwyva4\",\"guides_webhooks.md\":\"B5DXt2v1\",\"hillclimbing.md\":\"M51bF-oT\",\"index.md\":\"DnJPj_B6\",\"quickstart.md\":\"r-oE8nkX\",\"reference_access.md\":\"C5lblfUC\",\"reference_agent-config.md\":\"Bbqf0lgS\",\"reference_artifacts.md\":\"BJpAI7h9\",\"reference_channels.md\":\"CPWOpdsC\",\"reference_cli.md\":\"DHm6DmYk\",\"reference_connections.md\":\"DoY4vrDH\",\"reference_evals.md\":\"DgfUtfIc\",\"reference_extensions.md\":\"DHbW6eOf\",\"reference_hooks.md\":\"vbIM394-\",\"reference_http-api.md\":\"C7Cb0r2J\",\"reference_instructions.md\":\"CV6Qq0UX\",\"reference_limits.md\":\"CbdtFr4T\",\"reference_memory.md\":\"CdoJISM-\",\"reference_playground.md\":\"DIUsRAcy\",\"reference_project-layout.md\":\"9DiKoE16\",\"reference_schedules.md\":\"RhQ9ZLo1\",\"reference_sessions.md\":\"NXVQt9mP\",\"reference_skills.md\":\"DzCPNPkG\",\"reference_subagents.md\":\"Dvpq2sUu\",\"reference_tools.md\":\"BhqW6neF\",\"templates_agentic-owners.md\":\"B6ZmKAzT\",\"templates_reviews.md\":\"dr9Xv_KM\",\"troubleshooting.md\":\"DfKKvW1R\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Agent SDK\",\"description\":\"Build and serve bots and agents from versioned Markdown and TypeScript.\",\"base\":\"/docs/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"sdkVersion\":\"0.6.0\",\"nav\":[{\"text\":\"Quickstart\",\"link\":\"/quickstart\"},{\"text\":\"Guides\",\"link\":\"/guides/mcp-oauth\"},{\"text\":\"Integrations\",\"link\":\"/guides/github\"},{\"text\":\"Templates\",\"link\":\"/templates/reviews\"},{\"text\":\"Reference\",\"link\":\"/reference/project-layout\"}],\"search\":{\"provider\":\"local\"},\"outline\":{\"level\":[2,3]},\"sidebar\":[{\"text\":\"Getting started\",\"items\":[{\"text\":\"Overview\",\"link\":\"/\"},{\"text\":\"Changelog\",\"link\":\"/changelog\"},{\"text\":\"Build a PR reviewer\",\"link\":\"/quickstart\"}]},{\"text\":\"Integrations\",\"collapsed\":false,\"items\":[{\"text\":\"GitHub\",\"link\":\"/guides/github\"},{\"text\":\"Slack\",\"link\":\"/guides/slack\"},{\"text\":\"Webhooks\",\"link\":\"/guides/webhooks\"},{\"text\":\"Cursor Automations\",\"link\":\"/guides/convert-automation\"},{\"text\":\"OpenTelemetry\",\"link\":\"/guides/opentelemetry\"},{\"text\":\"GitLab\",\"link\":\"/guides/gitlab\"},{\"text\":\"Bitbucket\",\"link\":\"/guides/bitbucket\"},{\"text\":\"PagerDuty\",\"link\":\"/guides/pagerduty\"}]},{\"text\":\"Extensions\",\"collapsed\":false,\"items\":[{\"text\":\"Overview\",\"link\":\"/reference/extensions\"},{\"text\":\"Cloud agents\",\"link\":\"/guides/cloud-agents\"},{\"text\":\"Self-improvement\",\"link\":\"/guides/improve\"},{\"text\":\"Jev\",\"link\":\"/guides/jev\"}]},{\"text\":\"Guides\",\"collapsed\":false,\"items\":[{\"text\":\"MCP\",\"link\":\"/guides/mcp-oauth\"},{\"text\":\"Peer agents\",\"link\":\"/guides/agent-to-agent\"},{\"text\":\"Deployment\",\"link\":\"/deployment\"},{\"text\":\"Early-alpha migration\",\"link\":\"/guides/migrate\"},{\"text\":\"Evals\",\"link\":\"/evals\"},{\"text\":\"Hillclimbing\",\"link\":\"/hillclimbing\"},{\"text\":\"Build with a coding agent\",\"link\":\"/building-with-agents\"},{\"text\":\"Troubleshooting\",\"link\":\"/troubleshooting\"}]},{\"text\":\"Templates\",\"collapsed\":false,\"items\":[{\"text\":\"Review and triage\",\"link\":\"/templates/reviews\"},{\"text\":\"Agentic Approver\",\"link\":\"/templates/agentic-owners\"}]},{\"text\":\"Reference\",\"collapsed\":false,\"items\":[{\"text\":\"Project layout\",\"link\":\"/reference/project-layout\"},{\"text\":\"Agent config\",\"link\":\"/reference/agent-config\"},{\"text\":\"Instructions\",\"link\":\"/reference/instructions\"},{\"text\":\"Tools\",\"link\":\"/reference/tools\"},{\"text\":\"Skills\",\"link\":\"/reference/skills\"},{\"text\":\"MCP Connections\",\"link\":\"/reference/connections\"},{\"text\":\"Subagents\",\"link\":\"/reference/subagents\"},{\"text\":\"Channels\",\"link\":\"/reference/channels\"},{\"text\":\"Schedules & reminders\",\"link\":\"/reference/schedules\"},{\"text\":\"Hooks\",\"link\":\"/reference/hooks\"},{\"text\":\"Memory\",\"link\":\"/reference/memory\"},{\"text\":\"Evals\",\"link\":\"/reference/evals\"},{\"text\":\"Artifacts\",\"link\":\"/reference/artifacts\"},{\"text\":\"Sessions & streaming\",\"link\":\"/reference/sessions\"},{\"text\":\"Playground\",\"link\":\"/reference/playground\"},{\"text\":\"CLI\",\"link\":\"/reference/cli\"},{\"text\":\"HTTP API\",\"link\":\"/reference/http-api\"},{\"text\":\"Access\",\"link\":\"/reference/access\"},{\"text\":\"Limits\",\"link\":\"/reference/limits\"}]}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
119
+ <span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// { toolName, callId, isError, result, durationMs }</span></span></code></pre></div><p>Omit both identifiers to run against an ephemeral workspace that is removed when the call returns. Pass <code>sessionId</code> (HTTP body, <code>--session</code>, or <code>options.sessionId</code>) or <code>continuationToken</code> (<code>&lt;channelId&gt;:&lt;key&gt;</code> as <code>/v1/sessions</code> lists it) to bind the call. The two are mutually exclusive.</p><table tabindex="0"><thead><tr><th>Rule</th><th>What happens</th></tr></thead><tbody><tr><td>Existing <code>sessionId</code>, or a token that maps to an existing session</td><td>Session workspace, owner check, and event recording</td></tr><tr><td>Token with no matching session</td><td>Scratch workspace; the token&#39;s channel id and key are the call identity</td></tr><tr><td>Busy session, <code>effect: &quot;read&quot;</code> (or an advertised MCP tool marked read-only)</td><td>Runs alongside the turn, reading the workspace as the turn left it; recorded under its own <code>turnId</code></td></tr><tr><td>Busy session, write, idempotent, or undeclared</td><td><code>409 session_busy</code> until the turn finishes</td></tr><tr><td>Session workspace cannot be created, read</td><td>Scratch workspace; the outcome has <code>scratchWorkspace: true</code></td></tr><tr><td>Session workspace cannot be created, write</td><td><code>500 workspace_unavailable</code></td></tr></tbody></table><table tabindex="0"><thead><tr><th>Error</th><th>When</th></tr></thead><tbody><tr><td><code>404 unknown_tool</code></td><td>Name is not a callable server tool; the response lists available names</td></tr><tr><td><code>400 tool_not_callable</code></td><td>Agent-execution tools cannot run on the host</td></tr><tr><td><code>400 invalid_tool_input</code></td><td>Zod rejected the input before <code>execute</code>. Plain JSON Schema is forwarded unvalidated</td></tr><tr><td><code>400 invalid_continuation_token</code></td><td>Malformed token, or passed together with <code>sessionId</code></td></tr><tr><td><code>404 session_not_found</code></td><td><code>sessionId</code> does not exist</td></tr><tr><td><code>409 session_busy</code></td><td>Write-effect call while a model turn is running</td></tr><tr><td><code>500 workspace_unavailable</code></td><td>Write-effect call when the session workspace cannot be created</td></tr><tr><td><code>isError: true</code></td><td>The tool body threw; same envelope the model would see</td></tr></tbody></table><p>See also <a href="./connections.html">MCP connections</a>, <a href="./extensions.html">Extensions</a>, and <a href="./../evals.html">Evals</a>.</p></div></div></main><footer class="VPDocFooter" data-v-1686efb8 data-v-37fd6f02><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-37fd6f02><span class="visually-hidden" id="doc-footer-aria-label" data-v-37fd6f02>Pager</span><div class="pager" data-v-37fd6f02><a class="VPLink link pager-link prev" href="/docs/reference/instructions.html" data-v-37fd6f02><!--[--><span class="desc" data-v-37fd6f02>Previous page</span><span class="title" data-v-37fd6f02>Instructions</span><!--]--></a></div><div class="pager" data-v-37fd6f02><a class="VPLink link pager-link next" href="/docs/reference/skills.html" data-v-37fd6f02><!--[--><span class="desc" data-v-37fd6f02>Next page</span><span class="title" data-v-37fd6f02>Skills</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
120
+ <script>window.__VP_HASH_MAP__=JSON.parse("{\"building-with-agents.md\":\"Bo3ct-rf\",\"changelog.md\":\"DoOgjnPC\",\"deployment.md\":\"CIRydNl3\",\"evals.md\":\"Dne6VRmZ\",\"guides_agent-to-agent.md\":\"DcB3nhOz\",\"guides_bitbucket.md\":\"BiA6ZMFW\",\"guides_cloud-agents.md\":\"BdWqmUGb\",\"guides_convert-automation.md\":\"BvTxsJ8J\",\"guides_github.md\":\"CcuZ7keS\",\"guides_gitlab.md\":\"DcKusOcU\",\"guides_improve.md\":\"o3WOGR7n\",\"guides_jev.md\":\"DGCzkMUN\",\"guides_mcp-oauth.md\":\"GVPMKcYl\",\"guides_migrate.md\":\"B8CZxnnX\",\"guides_opentelemetry.md\":\"BRSktBHt\",\"guides_pagerduty.md\":\"pMXUkZZc\",\"guides_slack.md\":\"D7Rwyva4\",\"guides_teams.md\":\"7Lz2sbqB\",\"guides_webhooks.md\":\"B5DXt2v1\",\"guides_workload-identity.md\":\"DBV6YkXX\",\"hillclimbing.md\":\"M51bF-oT\",\"index.md\":\"DnJPj_B6\",\"quickstart.md\":\"r-oE8nkX\",\"reference_access.md\":\"C5lblfUC\",\"reference_agent-config.md\":\"CfM1S6Ac\",\"reference_artifacts.md\":\"BJpAI7h9\",\"reference_channels.md\":\"CRvqgU0n\",\"reference_cli.md\":\"NS6U5a-7\",\"reference_connections.md\":\"DoY4vrDH\",\"reference_evals.md\":\"DgfUtfIc\",\"reference_extensions.md\":\"DHbW6eOf\",\"reference_hooks.md\":\"vbIM394-\",\"reference_http-api.md\":\"C7Cb0r2J\",\"reference_instructions.md\":\"CV6Qq0UX\",\"reference_limits.md\":\"CW9PTdxr\",\"reference_memory.md\":\"CdoJISM-\",\"reference_playground.md\":\"DIUsRAcy\",\"reference_project-layout.md\":\"9DiKoE16\",\"reference_schedules.md\":\"Dd8_d0WG\",\"reference_sessions.md\":\"CoCyQLEz\",\"reference_skills.md\":\"SFRZDC41\",\"reference_subagents.md\":\"Dvpq2sUu\",\"reference_tools.md\":\"BhqW6neF\",\"templates_agentic-owners.md\":\"B6ZmKAzT\",\"templates_reviews.md\":\"dr9Xv_KM\",\"troubleshooting.md\":\"CsQTleto\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Agent SDK\",\"description\":\"Build and serve bots and agents from versioned Markdown and TypeScript.\",\"base\":\"/docs/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"sdkVersion\":\"0.7.1\",\"nav\":[{\"text\":\"Quickstart\",\"link\":\"/quickstart\"},{\"text\":\"Guides\",\"link\":\"/guides/mcp-oauth\"},{\"text\":\"Integrations\",\"link\":\"/guides/github\"},{\"text\":\"Templates\",\"link\":\"/templates/reviews\"},{\"text\":\"Reference\",\"link\":\"/reference/project-layout\"}],\"search\":{\"provider\":\"local\"},\"outline\":{\"level\":[2,3]},\"sidebar\":[{\"text\":\"Getting started\",\"items\":[{\"text\":\"Overview\",\"link\":\"/\"},{\"text\":\"Changelog\",\"link\":\"/changelog\"},{\"text\":\"Build a PR reviewer\",\"link\":\"/quickstart\"}]},{\"text\":\"Integrations\",\"collapsed\":false,\"items\":[{\"text\":\"GitHub\",\"link\":\"/guides/github\"},{\"text\":\"Slack\",\"link\":\"/guides/slack\"},{\"text\":\"Microsoft Teams\",\"link\":\"/guides/teams\"},{\"text\":\"Webhooks\",\"link\":\"/guides/webhooks\"},{\"text\":\"Cursor Automations\",\"link\":\"/guides/convert-automation\"},{\"text\":\"OpenTelemetry\",\"link\":\"/guides/opentelemetry\"},{\"text\":\"GitLab\",\"link\":\"/guides/gitlab\"},{\"text\":\"Bitbucket\",\"link\":\"/guides/bitbucket\"},{\"text\":\"PagerDuty\",\"link\":\"/guides/pagerduty\"}]},{\"text\":\"Extensions\",\"collapsed\":false,\"items\":[{\"text\":\"Overview\",\"link\":\"/reference/extensions\"},{\"text\":\"Cloud agents\",\"link\":\"/guides/cloud-agents\"},{\"text\":\"Self-improvement\",\"link\":\"/guides/improve\"},{\"text\":\"Jev\",\"link\":\"/guides/jev\"}]},{\"text\":\"Guides\",\"collapsed\":false,\"items\":[{\"text\":\"MCP\",\"link\":\"/guides/mcp-oauth\"},{\"text\":\"Peer agents\",\"link\":\"/guides/agent-to-agent\"},{\"text\":\"Deployment\",\"link\":\"/deployment\"},{\"text\":\"Workload identity (OIDC)\",\"link\":\"/guides/workload-identity\"},{\"text\":\"Early-alpha migration\",\"link\":\"/guides/migrate\"},{\"text\":\"Evals\",\"link\":\"/evals\"},{\"text\":\"Hillclimbing\",\"link\":\"/hillclimbing\"},{\"text\":\"Build with a coding agent\",\"link\":\"/building-with-agents\"},{\"text\":\"Troubleshooting\",\"link\":\"/troubleshooting\"}]},{\"text\":\"Templates\",\"collapsed\":false,\"items\":[{\"text\":\"Review and triage\",\"link\":\"/templates/reviews\"},{\"text\":\"Agentic Approver\",\"link\":\"/templates/agentic-owners\"}]},{\"text\":\"Reference\",\"collapsed\":false,\"items\":[{\"text\":\"Project layout\",\"link\":\"/reference/project-layout\"},{\"text\":\"Agent config\",\"link\":\"/reference/agent-config\"},{\"text\":\"Instructions\",\"link\":\"/reference/instructions\"},{\"text\":\"Tools\",\"link\":\"/reference/tools\"},{\"text\":\"Skills\",\"link\":\"/reference/skills\"},{\"text\":\"MCP Connections\",\"link\":\"/reference/connections\"},{\"text\":\"Subagents\",\"link\":\"/reference/subagents\"},{\"text\":\"Channels\",\"link\":\"/reference/channels\"},{\"text\":\"Schedules & reminders\",\"link\":\"/reference/schedules\"},{\"text\":\"Hooks\",\"link\":\"/reference/hooks\"},{\"text\":\"Memory\",\"link\":\"/reference/memory\"},{\"text\":\"Evals\",\"link\":\"/reference/evals\"},{\"text\":\"Artifacts\",\"link\":\"/reference/artifacts\"},{\"text\":\"Sessions & streaming\",\"link\":\"/reference/sessions\"},{\"text\":\"Playground\",\"link\":\"/reference/playground\"},{\"text\":\"CLI\",\"link\":\"/reference/cli\"},{\"text\":\"HTTP API\",\"link\":\"/reference/http-api\"},{\"text\":\"Access\",\"link\":\"/reference/access\"},{\"text\":\"Limits\",\"link\":\"/reference/limits\"}]}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
121
121
 
122
122
  </body>
123
123
  </html>