@grok/agent-sdk 0.7.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.
- package/dist/channels/github/cursor-account.d.ts +1 -0
- package/dist/channels/github/cursor-account.d.ts.map +1 -1
- package/dist/channels/github/cursor-account.js +8 -2
- package/dist/channels/origin/cursor-account.d.ts +6 -0
- package/dist/channels/origin/cursor-account.d.ts.map +1 -1
- package/dist/channels/origin/cursor-account.js +17 -0
- package/dist/docs/404.html +2 -2
- package/dist/docs/assets/{app.Ch-048af.js → app.CpLKJnOA.js} +4 -4
- package/dist/docs/assets/changelog.md.DoOgjnPC.js +1 -0
- package/dist/docs/assets/{changelog.md.SoN0MK7o.lean.js → changelog.md.DoOgjnPC.lean.js} +1 -1
- package/dist/docs/assets/chunks/@localSearchIndexroot.BJ_1eI6D.js +1 -0
- package/dist/docs/assets/chunks/{VPLocalSearchBox.D7BIa9Su.js → VPLocalSearchBox.Cr1HJ_9k.js} +1 -1
- package/dist/docs/assets/chunks/{arc.BIzu7OVF.js → arc.BjpgGAMM.js} +1 -1
- package/dist/docs/assets/chunks/{architectureDiagram-Q4EWVU46.DNznI0Sn.js → architectureDiagram-Q4EWVU46.CKdhNPPk.js} +1 -1
- package/dist/docs/assets/chunks/{baseUniq.B4y6Y5eG.js → baseUniq.iovoEQbg.js} +1 -1
- package/dist/docs/assets/chunks/{blockDiagram-DXYQGD6D.BudnBsgw.js → blockDiagram-DXYQGD6D.BYQIeDre.js} +1 -1
- package/dist/docs/assets/chunks/{c4Diagram-AHTNJAMY._bB00GdB.js → c4Diagram-AHTNJAMY.gbWi2q8N.js} +1 -1
- package/dist/docs/assets/chunks/channel.BP0n324b.js +1 -0
- package/dist/docs/assets/chunks/{chunk-4BX2VUAB.CRftnUwS.js → chunk-4BX2VUAB.1Mem4UG9.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-4TB4RGXK.CSx1x2Ob.js → chunk-4TB4RGXK.Dn3H-X_H.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-55IACEB6.KkLHAAbH.js → chunk-55IACEB6.BkpSDZwX.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-EDXVE4YY.DDeKCCtX.js → chunk-EDXVE4YY.BScqy1zP.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-FMBD7UC4.DrLlsD9m.js → chunk-FMBD7UC4.Cp394LWf.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-OYMX7WX6.DeVYOGcT.js → chunk-OYMX7WX6.BDv9LhoL.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-QZHKN3VN.Cz4_bS6p.js → chunk-QZHKN3VN.CsgCcrKO.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-YZCP3GAM.CwrYtDVo.js → chunk-YZCP3GAM.BKBpIC5O.js} +1 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.BhTtyWMA.js +1 -0
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.BhTtyWMA.js +1 -0
- package/dist/docs/assets/chunks/clone.BVK2rFqj.js +1 -0
- package/dist/docs/assets/chunks/{cose-bilkent-S5V4N54A.3d8hflz6.js → cose-bilkent-S5V4N54A.Bs3ZS9PC.js} +1 -1
- package/dist/docs/assets/chunks/{dagre-KV5264BT.BVEgjiPg.js → dagre-KV5264BT.CgWi0tY2.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-5BDNPKRD.j7dZpUK_.js → diagram-5BDNPKRD.rn6qIo9N.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-G4DWMVQ6.4flIgIon.js → diagram-G4DWMVQ6.ChhW8oww.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-MMDJMWI5.BlJiFh-S.js → diagram-MMDJMWI5.C0wH5KSk.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-TYMM5635.DHAOHEyM.js → diagram-TYMM5635.CNEcrwA0.js} +1 -1
- package/dist/docs/assets/chunks/{erDiagram-SMLLAGMA.DkmyG7xK.js → erDiagram-SMLLAGMA.DCsnKO-7.js} +1 -1
- package/dist/docs/assets/chunks/{flowDiagram-DWJPFMVM.L_WiaAU6.js → flowDiagram-DWJPFMVM.WCMkfvP0.js} +1 -1
- package/dist/docs/assets/chunks/{ganttDiagram-T4ZO3ILL.CT6kOI2a.js → ganttDiagram-T4ZO3ILL.BUb1Sxfr.js} +1 -1
- package/dist/docs/assets/chunks/{gitGraphDiagram-UUTBAWPF.D8CRlLqh.js → gitGraphDiagram-UUTBAWPF._kORbCzm.js} +1 -1
- package/dist/docs/assets/chunks/{graph.CdOyJvsX.js → graph.PrGRm4KW.js} +1 -1
- package/dist/docs/assets/chunks/{infoDiagram-42DDH7IO.DcmXeSos.js → infoDiagram-42DDH7IO.BxhCjiQM.js} +1 -1
- package/dist/docs/assets/chunks/{ishikawaDiagram-UXIWVN3A.BBjY4mxr.js → ishikawaDiagram-UXIWVN3A.5ddTis2y.js} +1 -1
- package/dist/docs/assets/chunks/{journeyDiagram-VCZTEJTY.BrXteAB6.js → journeyDiagram-VCZTEJTY.BUStU27-.js} +1 -1
- package/dist/docs/assets/chunks/{kanban-definition-6JOO6SKY.OlHsUJVV.js → kanban-definition-6JOO6SKY.CJd1psl3.js} +1 -1
- package/dist/docs/assets/chunks/{layout.DDwvoQlY.js → layout.DqvbZSML.js} +1 -1
- package/dist/docs/assets/chunks/{linear.BRXPDWj3.js → linear.DOmz-1UB.js} +1 -1
- package/dist/docs/assets/chunks/{min.3YwC0t3o.js → min.33k2v8dM.js} +1 -1
- package/dist/docs/assets/chunks/{mindmap-definition-QFDTVHPH.mPHnT2lN.js → mindmap-definition-QFDTVHPH.iISCqCXC.js} +1 -1
- package/dist/docs/assets/chunks/{pieDiagram-DEJITSTG.DEK2--em.js → pieDiagram-DEJITSTG.BHvVgzmD.js} +1 -1
- package/dist/docs/assets/chunks/{quadrantDiagram-34T5L4WZ.NCdRAOzK.js → quadrantDiagram-34T5L4WZ.CY3w_-Cn.js} +1 -1
- package/dist/docs/assets/chunks/{requirementDiagram-MS252O5E.DLAocFWZ.js → requirementDiagram-MS252O5E.CHXKQS1v.js} +1 -1
- package/dist/docs/assets/chunks/{sankeyDiagram-XADWPNL6.afIOqpyT.js → sankeyDiagram-XADWPNL6.DTtRoGss.js} +1 -1
- package/dist/docs/assets/chunks/{sequenceDiagram-FGHM5R23.DXBjvkkE.js → sequenceDiagram-FGHM5R23.NnPcQ3eY.js} +1 -1
- package/dist/docs/assets/chunks/{stateDiagram-FHFEXIEX.B_SGgvgs.js → stateDiagram-FHFEXIEX.D8DFciH7.js} +1 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.ESAwmMws.js +1 -0
- package/dist/docs/assets/chunks/{theme.bNyH5NPA.js → theme.CwkiT-Fo.js} +2 -2
- package/dist/docs/assets/chunks/{timeline-definition-GMOUNBTQ.CE6S1iSb.js → timeline-definition-GMOUNBTQ._wIWkMU6.js} +1 -1
- package/dist/docs/assets/chunks/{vennDiagram-DHZGUBPP.Blk7wb8V.js → vennDiagram-DHZGUBPP.NLVv7R6r.js} +1 -1
- package/dist/docs/assets/chunks/{wardley-RL74JXVD.DQqE3WF8.js → wardley-RL74JXVD.DbsCXUZp.js} +1 -1
- package/dist/docs/assets/chunks/{wardleyDiagram-NUSXRM2D.MUEQyRnz.js → wardleyDiagram-NUSXRM2D.Dp5uAVDl.js} +1 -1
- package/dist/docs/assets/chunks/{xychartDiagram-5P7HB3ND.DnJA2aXp.js → xychartDiagram-5P7HB3ND.eOEBq4rX.js} +1 -1
- package/dist/docs/assets/{deployment.md.N9S5KC5R.js → deployment.md.CIRydNl3.js} +2 -2
- package/dist/docs/assets/{deployment.md.N9S5KC5R.lean.js → deployment.md.CIRydNl3.lean.js} +1 -1
- package/dist/docs/assets/guides_workload-identity.md.DBV6YkXX.js +82 -0
- package/dist/docs/assets/guides_workload-identity.md.DBV6YkXX.lean.js +1 -0
- package/dist/docs/assets/{reference_agent-config.md.Bbqf0lgS.js → reference_agent-config.md.CfM1S6Ac.js} +2 -2
- package/dist/docs/assets/{reference_agent-config.md.Bbqf0lgS.lean.js → reference_agent-config.md.CfM1S6Ac.lean.js} +1 -1
- package/dist/docs/building-with-agents.html +35 -35
- package/dist/docs/changelog.html +36 -36
- package/dist/docs/changelog.md +8 -0
- package/dist/docs/deployment.html +38 -38
- package/dist/docs/deployment.md +4 -0
- package/dist/docs/evals.html +35 -35
- package/dist/docs/guides/agent-to-agent.html +35 -35
- package/dist/docs/guides/bitbucket.html +35 -35
- package/dist/docs/guides/cloud-agents.html +35 -35
- package/dist/docs/guides/convert-automation.html +35 -35
- package/dist/docs/guides/github.html +35 -35
- package/dist/docs/guides/gitlab.html +35 -35
- package/dist/docs/guides/improve.html +35 -35
- package/dist/docs/guides/jev.html +35 -35
- package/dist/docs/guides/mcp-oauth.html +35 -35
- package/dist/docs/guides/migrate.html +36 -36
- package/dist/docs/guides/opentelemetry.html +35 -35
- package/dist/docs/guides/pagerduty.html +35 -35
- package/dist/docs/guides/slack.html +35 -35
- package/dist/docs/guides/teams.html +35 -35
- package/dist/docs/guides/webhooks.html +35 -35
- package/dist/docs/guides/workload-identity.html +141 -0
- package/dist/docs/guides/workload-identity.md +227 -0
- package/dist/docs/hashmap.json +1 -1
- package/dist/docs/hillclimbing.html +35 -35
- package/dist/docs/index.html +35 -35
- package/dist/docs/llms-full.txt +245 -1
- package/dist/docs/llms.txt +1 -0
- package/dist/docs/quickstart.html +35 -35
- package/dist/docs/reference/access.html +35 -35
- package/dist/docs/reference/agent-config.html +37 -37
- package/dist/docs/reference/agent-config.md +1 -1
- package/dist/docs/reference/artifacts.html +35 -35
- package/dist/docs/reference/channels.html +35 -35
- package/dist/docs/reference/cli.html +35 -35
- package/dist/docs/reference/connections.html +35 -35
- package/dist/docs/reference/evals.html +35 -35
- package/dist/docs/reference/extensions.html +35 -35
- package/dist/docs/reference/hooks.html +35 -35
- package/dist/docs/reference/http-api.html +35 -35
- package/dist/docs/reference/instructions.html +35 -35
- package/dist/docs/reference/limits.html +35 -35
- package/dist/docs/reference/memory.html +35 -35
- package/dist/docs/reference/playground.html +35 -35
- package/dist/docs/reference/project-layout.html +35 -35
- package/dist/docs/reference/schedules.html +35 -35
- package/dist/docs/reference/sessions.html +35 -35
- package/dist/docs/reference/skills.html +35 -35
- package/dist/docs/reference/subagents.html +35 -35
- package/dist/docs/reference/tools.html +35 -35
- package/dist/docs/templates/agentic-owners.html +35 -35
- package/dist/docs/templates/reviews.html +35 -35
- package/dist/docs/troubleshooting.html +35 -35
- package/dist/internal/cli-ax.d.ts.map +1 -1
- package/dist/internal/cli-ax.js +6 -3
- package/dist/internal/cursor-account-mcp-auth.d.ts +7 -1
- package/dist/internal/cursor-account-mcp-auth.d.ts.map +1 -1
- package/dist/internal/cursor-account-mcp-auth.js +20 -5
- package/dist/internal/discovery/agent.d.ts.map +1 -1
- package/dist/internal/discovery/agent.js +2 -1
- package/dist/internal/discovery/connections.d.ts +5 -0
- package/dist/internal/discovery/connections.d.ts.map +1 -1
- package/dist/internal/discovery/connections.js +18 -1
- package/dist/internal/host-kv-cas.d.ts.map +1 -1
- package/dist/internal/host-kv-cas.js +21 -3
- package/dist/internal/hosted-delivery-protocol.d.ts +1 -0
- package/dist/internal/hosted-delivery-protocol.d.ts.map +1 -1
- package/dist/internal/hosted-delivery-protocol.js +4 -2
- package/dist/internal/hosted-delivery.d.ts +4 -1
- package/dist/internal/hosted-delivery.d.ts.map +1 -1
- package/dist/internal/hosted-delivery.js +3 -1
- package/dist/internal/ids.d.ts +2 -0
- package/dist/internal/ids.d.ts.map +1 -1
- package/dist/internal/ids.js +5 -0
- package/dist/internal/schedule-runner.d.ts +1 -0
- package/dist/internal/schedule-runner.d.ts.map +1 -1
- package/dist/internal/schedule-runner.js +10 -1
- package/dist/internal/server.d.ts.map +1 -1
- package/dist/internal/server.js +8 -4
- package/dist/internal/session-engine.d.ts +4 -1
- package/dist/internal/session-engine.d.ts.map +1 -1
- package/dist/internal/session-engine.js +3 -1
- package/dist/oidc-token.d.ts +4 -0
- package/dist/oidc-token.d.ts.map +1 -1
- package/dist/playground/assets/chunk-YOKDWASO-BPO_8GRX.js +115 -0
- package/dist/playground/assets/highlighted-body-KPVGNVTW-CxEV-T_f.js +1 -0
- package/dist/playground/assets/index-CjFJhCtb.js +62 -0
- package/dist/playground/assets/index-vwUVwmk8.css +1 -0
- package/dist/playground/assets/mermaid-HWGCJPDP-eK-fpbFn.js +1 -0
- package/dist/playground/index.html +2 -2
- package/docs/changelog.md +8 -0
- package/docs/deployment.md +4 -0
- package/docs/guides/workload-identity.md +232 -0
- package/docs/reference/agent-config.md +1 -1
- package/package.json +3 -1
- package/skills/deploy/SKILL.md +1 -1
- package/dist/docs/assets/changelog.md.SoN0MK7o.js +0 -1
- package/dist/docs/assets/chunks/@localSearchIndexroot.BdYoBKxY.js +0 -1
- package/dist/docs/assets/chunks/channel.CgxlmuBS.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.DWroREP-.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.DWroREP-.js +0 -1
- package/dist/docs/assets/chunks/clone.F824-PNx.js +0 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.OKAy5Bz7.js +0 -1
- package/dist/playground/assets/index-BaBSZXki.css +0 -1
- package/dist/playground/assets/index-BkAF8YlO.js +0 -62
package/dist/docs/index.html
CHANGED
|
@@ -9,42 +9,42 @@
|
|
|
9
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.
|
|
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.
|
|
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.
|
|
18
|
-
<link rel="modulepreload" href="/docs/assets/chunks/cose-bilkent-S5V4N54A.
|
|
19
|
-
<link rel="modulepreload" href="/docs/assets/chunks/c4Diagram-AHTNJAMY.
|
|
20
|
-
<link rel="modulepreload" href="/docs/assets/chunks/flowDiagram-DWJPFMVM.
|
|
21
|
-
<link rel="modulepreload" href="/docs/assets/chunks/erDiagram-SMLLAGMA.
|
|
22
|
-
<link rel="modulepreload" href="/docs/assets/chunks/gitGraphDiagram-UUTBAWPF.
|
|
23
|
-
<link rel="modulepreload" href="/docs/assets/chunks/ganttDiagram-T4ZO3ILL.
|
|
24
|
-
<link rel="modulepreload" href="/docs/assets/chunks/infoDiagram-42DDH7IO.
|
|
25
|
-
<link rel="modulepreload" href="/docs/assets/chunks/pieDiagram-DEJITSTG.
|
|
26
|
-
<link rel="modulepreload" href="/docs/assets/chunks/quadrantDiagram-34T5L4WZ.
|
|
27
|
-
<link rel="modulepreload" href="/docs/assets/chunks/xychartDiagram-5P7HB3ND.
|
|
28
|
-
<link rel="modulepreload" href="/docs/assets/chunks/requirementDiagram-MS252O5E.
|
|
29
|
-
<link rel="modulepreload" href="/docs/assets/chunks/sequenceDiagram-FGHM5R23.
|
|
30
|
-
<link rel="modulepreload" href="/docs/assets/chunks/classDiagram-6PBFFD2Q.
|
|
31
|
-
<link rel="modulepreload" href="/docs/assets/chunks/classDiagram-v2-HSJHXN6E.
|
|
32
|
-
<link rel="modulepreload" href="/docs/assets/chunks/stateDiagram-FHFEXIEX.
|
|
33
|
-
<link rel="modulepreload" href="/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.
|
|
34
|
-
<link rel="modulepreload" href="/docs/assets/chunks/journeyDiagram-VCZTEJTY.
|
|
35
|
-
<link rel="modulepreload" href="/docs/assets/chunks/timeline-definition-GMOUNBTQ.
|
|
36
|
-
<link rel="modulepreload" href="/docs/assets/chunks/mindmap-definition-QFDTVHPH.
|
|
37
|
-
<link rel="modulepreload" href="/docs/assets/chunks/kanban-definition-6JOO6SKY.
|
|
38
|
-
<link rel="modulepreload" href="/docs/assets/chunks/sankeyDiagram-XADWPNL6.
|
|
39
|
-
<link rel="modulepreload" href="/docs/assets/chunks/diagram-TYMM5635.
|
|
40
|
-
<link rel="modulepreload" href="/docs/assets/chunks/diagram-MMDJMWI5.
|
|
41
|
-
<link rel="modulepreload" href="/docs/assets/chunks/blockDiagram-DXYQGD6D.
|
|
42
|
-
<link rel="modulepreload" href="/docs/assets/chunks/diagram-5BDNPKRD.
|
|
43
|
-
<link rel="modulepreload" href="/docs/assets/chunks/architectureDiagram-Q4EWVU46.
|
|
44
|
-
<link rel="modulepreload" href="/docs/assets/chunks/ishikawaDiagram-UXIWVN3A.
|
|
45
|
-
<link rel="modulepreload" href="/docs/assets/chunks/vennDiagram-DHZGUBPP.
|
|
46
|
-
<link rel="modulepreload" href="/docs/assets/chunks/diagram-G4DWMVQ6.
|
|
47
|
-
<link rel="modulepreload" href="/docs/assets/chunks/wardleyDiagram-NUSXRM2D.
|
|
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/index.md.DnJPj_B6.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/index.md">
|
|
54
54
|
</head>
|
|
55
55
|
<body>
|
|
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.0 (@grok/agent-sdk package)" data-v-a03aeddf>0.7.0</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 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>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/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" 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_" data-v-1686efb8><div><h1 id="agent-sdk" tabindex="-1">Agent SDK <a class="header-anchor" href="#agent-sdk" aria-label="Permalink to "Agent SDK""></a></h1><p>Agent SDK lets you define, test, evaluate, and deploy agents as code. It uses the Cursor SDK harness that powers Bugbot, Security Review, Approval Bot, and Rollouts.</p><p>An Agent's behavior is defined in a folder of Markdown and TypeScript that combines deterministic code with model judgment. Agent SDK makes it easy to build useful agents, with APIs to interact on Slack, pull requests, issue trackers, Cursor, and the other places where you get work done.</p><p>After you deploy an agent, open <a href="https://cursor.com/dashboard/deployed-agents" target="_blank" rel="noreferrer">Deployed Agents</a> to manage it.</p><h2 id="get-started-with-your-coding-agent" tabindex="-1">Get Started with your Coding Agent <a class="header-anchor" href="#get-started-with-your-coding-agent" aria-label="Permalink to "Get Started with your Coding Agent""></a></h2><p>Paste this prompt into your coding agent. It installs the CLI, asks what your agent is for, scaffolds and checks a first project, and tells you how to test and deploy it.</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>Set up my first Agent SDK project.</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 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>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" 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_" data-v-1686efb8><div><h1 id="agent-sdk" tabindex="-1">Agent SDK <a class="header-anchor" href="#agent-sdk" aria-label="Permalink to "Agent SDK""></a></h1><p>Agent SDK lets you define, test, evaluate, and deploy agents as code. It uses the Cursor SDK harness that powers Bugbot, Security Review, Approval Bot, and Rollouts.</p><p>An Agent's behavior is defined in a folder of Markdown and TypeScript that combines deterministic code with model judgment. Agent SDK makes it easy to build useful agents, with APIs to interact on Slack, pull requests, issue trackers, Cursor, and the other places where you get work done.</p><p>After you deploy an agent, open <a href="https://cursor.com/dashboard/deployed-agents" target="_blank" rel="noreferrer">Deployed Agents</a> to manage it.</p><h2 id="get-started-with-your-coding-agent" tabindex="-1">Get Started with your Coding Agent <a class="header-anchor" href="#get-started-with-your-coding-agent" aria-label="Permalink to "Get Started with your Coding Agent""></a></h2><p>Paste this prompt into your coding agent. It installs the CLI, asks what your agent is for, scaffolds and checks a first project, and tells you how to test and deploy it.</p><div class="language-text vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">text</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span>Set up my first Agent SDK project.</span></span>
|
|
57
57
|
<span class="line"><span></span></span>
|
|
58
58
|
<span class="line"><span>Read https://cursor.com/docs/agent-sdk.md. Add .md to any page under</span></span>
|
|
59
59
|
<span class="line"><span>https://cursor.com/docs/agent-sdk/ to read it as Markdown.</span></span>
|
|
@@ -67,7 +67,7 @@
|
|
|
67
67
|
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">agent-sdk</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> init</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> ./my-bot</span></span>
|
|
68
68
|
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">cd</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> my-bot</span></span>
|
|
69
69
|
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">agent-sdk</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> dev</span></span></code></pre></div><p><a href="./reference/project-layout.html">Project layout</a> explains every folder under <code>bot/</code>.</p><h2 id="next-steps" tabindex="-1">Next steps <a class="header-anchor" href="#next-steps" aria-label="Permalink to "Next steps""></a></h2><ul><li><a href="./quickstart.html">Build your first PR reviewer agent</a> step by step.</li><li>Start from a <a href="./templates/reviews.html">review or triage template</a> or the <a href="./templates/agentic-owners.html">owners-policy approver</a>.</li><li><a href="./guides/convert-automation.html">Convert a Cursor Automation</a> into an Agent SDK project.</li><li><a href="./building-with-agents.html">Build agents with agents</a> using a coding agent.</li><li>Look up commands in the <a href="./reference/cli.html">CLI reference</a> and deployed-agent roles in <a href="./reference/access.html">Access</a>.</li></ul><h2 id="architecture" tabindex="-1">Architecture <a class="header-anchor" href="#architecture" aria-label="Permalink to "Architecture""></a></h2><p><img src="/docs/architecture.svg" alt="Agent SDK architecture"></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><!----></div><div class="pager" data-v-37fd6f02><a class="VPLink link pager-link next" href="/docs/changelog.html" data-v-37fd6f02><!--[--><span class="desc" data-v-37fd6f02>Next page</span><span class="title" data-v-37fd6f02>Changelog</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
|
|
70
|
-
<script>window.__VP_HASH_MAP__=JSON.parse("{\"building-with-agents.md\":\"Bo3ct-rf\",\"changelog.md\":\"
|
|
70
|
+
<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>
|
|
71
71
|
|
|
72
72
|
</body>
|
|
73
73
|
</html>
|
package/dist/docs/llms-full.txt
CHANGED
|
@@ -54,6 +54,14 @@ Source: /docs/changelog.md
|
|
|
54
54
|
|
|
55
55
|
# Changelog
|
|
56
56
|
|
|
57
|
+
## 0.7.1 (2026-11-20)
|
|
58
|
+
|
|
59
|
+
### Fixes
|
|
60
|
+
|
|
61
|
+
- On Cursor hosting, scheduled runs record trace events under the platform session id so they appear in the Trace tab. Before, scheduled runs wrote traces under a local id and the Trace tab stayed empty.
|
|
62
|
+
- GitHub and Origin `cursorAccount` connections ignore GitLab and Bitbucket repository entries in the shared event list instead of failing startup.
|
|
63
|
+
- `cursorAccount` MCP server name matching trims surrounding whitespace on server names and identifiers and rejects blank names.
|
|
64
|
+
|
|
57
65
|
## 0.7.0 (2026-11-19)
|
|
58
66
|
|
|
59
67
|
### Minimum versions
|
|
@@ -241,6 +249,10 @@ handler, tool, or callback that needs it. Give an MCP connection a
|
|
|
241
249
|
[`${NAME}` template](/docs/reference/connections.md#credentials-in-headers-and-env)
|
|
242
250
|
instead.
|
|
243
251
|
|
|
252
|
+
To authenticate with cloud providers or external services without static
|
|
253
|
+
keys, declare `hosting.oidc.audiences` and mint short-lived JWTs with
|
|
254
|
+
`getOidcToken`. See [Workload identity (OIDC)](/docs/guides/workload-identity.md).
|
|
255
|
+
|
|
244
256
|
SCM channels take each credential as a named secret, such as
|
|
245
257
|
`{ secretName: "GITHUB_WEBHOOK_SECRET" }`. The channel reads the environment
|
|
246
258
|
variable with that name locally and the deployment secret on Cursor hosting.
|
|
@@ -3334,6 +3346,238 @@ Keep sample payloads under `fixtures/` and pass them with
|
|
|
3334
3346
|
|
|
3335
3347
|
---
|
|
3336
3348
|
|
|
3349
|
+
Source: /docs/guides/workload-identity.md
|
|
3350
|
+
|
|
3351
|
+
# Authenticate deployed agents with OIDC
|
|
3352
|
+
|
|
3353
|
+
A deployed Agent SDK agent can mint short-lived OIDC JWTs signed by Cursor and exchange them for temporary cloud credentials or service tokens without storing static access keys in deployment secrets.
|
|
3354
|
+
|
|
3355
|
+
Agent SDK tokens share the `https://api.cursor.com` issuer, discovery endpoints, signing keys, 5-minute lifetime, socket path, and per-pod rate limits documented in [Cloud Agents OIDC tokens](https://cursor.com/docs/cloud-agent/identity). They differ in four ways:
|
|
3356
|
+
|
|
3357
|
+
| Aspect | Cloud Agents | Agent SDK deployments |
|
|
3358
|
+
| --- | --- | --- |
|
|
3359
|
+
| Audience allowlist | Any valid `aud` string | Must be declared in `hosting.oidc.audiences`; undeclared audiences return HTTP `400`. |
|
|
3360
|
+
| Subject (`sub`) | `cloud_agent_id:<id>` (or projected `team_id:<id>` via `sub_claim`) | Always `agent_sdk_deployment_id:<deployment-id>`. Sending `sub_claim` returns HTTP `400`. |
|
|
3361
|
+
| Runtime claim (`agent_runtime`) | `"managed"` or `"self_hosted"` | `"agent_sdk"`. |
|
|
3362
|
+
| Additional claims | Includes owner, team, repository, branch, and turn claims | See [Token claims](#token-claims). No owner, team, repository, or session claims. |
|
|
3363
|
+
|
|
3364
|
+
## Declare allowed audiences
|
|
3365
|
+
|
|
3366
|
+
A deployed agent can only mint tokens for audiences declared in `hosting.oidc.audiences` in `bot/agent.ts`. If you omit `hosting.oidc.audiences`, every mint request fails with HTTP `400`.
|
|
3367
|
+
|
|
3368
|
+
```ts
|
|
3369
|
+
// bot/agent.ts
|
|
3370
|
+
import { defineAgent } from "@grok/agent-sdk";
|
|
3371
|
+
|
|
3372
|
+
export default defineAgent({
|
|
3373
|
+
hosting: {
|
|
3374
|
+
egressDomains: ["sts.amazonaws.com"],
|
|
3375
|
+
oidc: {
|
|
3376
|
+
audiences: ["sts.amazonaws.com"],
|
|
3377
|
+
},
|
|
3378
|
+
},
|
|
3379
|
+
});
|
|
3380
|
+
```
|
|
3381
|
+
|
|
3382
|
+
Minting talks to a local Unix socket, so minting itself needs no egress entry. Calling the relying party to exchange the token still requires its hostname in `hosting.egressDomains`, such as `sts.amazonaws.com` (and any AWS service host your agent calls afterward).
|
|
3383
|
+
|
|
3384
|
+
Audience rules:
|
|
3385
|
+
|
|
3386
|
+
- List exact audience strings only. Wildcards (`*`) are rejected.
|
|
3387
|
+
- Declare at most 8 audiences per deployment.
|
|
3388
|
+
- Each audience must be 1 to 512 printable ASCII characters with no spaces or control characters.
|
|
3389
|
+
- Cursor-reserved audiences (such as `cursor.com` hosts) are rejected at deploy time and at mint time.
|
|
3390
|
+
- Cursor saves `hosting.oidc.audiences` when you deploy. Redeploy to add or remove an audience.
|
|
3391
|
+
|
|
3392
|
+
## Mint a token with `getOidcToken`
|
|
3393
|
+
|
|
3394
|
+
Import `getOidcToken` from `@grok/agent-sdk` and call it inside a tool, channel handler, or callback when your agent needs a token.
|
|
3395
|
+
|
|
3396
|
+
```ts
|
|
3397
|
+
// bot/tools/assume_aws_role.ts
|
|
3398
|
+
import { getOidcToken, OidcTokenError } from "@grok/agent-sdk";
|
|
3399
|
+
import { defineTool } from "@grok/agent-sdk/tools";
|
|
3400
|
+
import { z } from "zod";
|
|
3401
|
+
|
|
3402
|
+
export default defineTool({
|
|
3403
|
+
description: "Exchange an OIDC token for temporary AWS credentials.",
|
|
3404
|
+
inputSchema: z.object({}),
|
|
3405
|
+
async execute() {
|
|
3406
|
+
let token: string;
|
|
3407
|
+
try {
|
|
3408
|
+
const result = await getOidcToken("sts.amazonaws.com");
|
|
3409
|
+
token = result.token;
|
|
3410
|
+
} catch (error) {
|
|
3411
|
+
if (error instanceof OidcTokenError) {
|
|
3412
|
+
return {
|
|
3413
|
+
ok: false,
|
|
3414
|
+
code: error.code,
|
|
3415
|
+
status: error.status ?? null,
|
|
3416
|
+
reason: error.reason ?? null,
|
|
3417
|
+
};
|
|
3418
|
+
}
|
|
3419
|
+
throw error;
|
|
3420
|
+
}
|
|
3421
|
+
|
|
3422
|
+
const body = new URLSearchParams({
|
|
3423
|
+
Action: "AssumeRoleWithWebIdentity",
|
|
3424
|
+
Version: "2011-06-15",
|
|
3425
|
+
RoleArn: "arn:aws:iam::123456789012:role/my-agent-role",
|
|
3426
|
+
RoleSessionName: "agent-sdk-session",
|
|
3427
|
+
WebIdentityToken: token,
|
|
3428
|
+
});
|
|
3429
|
+
|
|
3430
|
+
const response = await fetch("https://sts.amazonaws.com/", {
|
|
3431
|
+
method: "POST",
|
|
3432
|
+
headers: {
|
|
3433
|
+
"content-type": "application/x-www-form-urlencoded",
|
|
3434
|
+
accept: "application/json",
|
|
3435
|
+
},
|
|
3436
|
+
body,
|
|
3437
|
+
});
|
|
3438
|
+
|
|
3439
|
+
if (!response.ok) {
|
|
3440
|
+
return { ok: false, stsStatus: response.status };
|
|
3441
|
+
}
|
|
3442
|
+
return { ok: true };
|
|
3443
|
+
},
|
|
3444
|
+
});
|
|
3445
|
+
```
|
|
3446
|
+
|
|
3447
|
+
Call `getOidcToken` inside a tool, handler, or callback, not at module load time.
|
|
3448
|
+
|
|
3449
|
+
### Return value and caching
|
|
3450
|
+
|
|
3451
|
+
`getOidcToken(audience: string)` returns `Promise<OidcToken>`:
|
|
3452
|
+
|
|
3453
|
+
| Field | Type | Meaning |
|
|
3454
|
+
| --- | --- | --- |
|
|
3455
|
+
| `token` | `string` | Compact RS256-signed JWT. Never log it. |
|
|
3456
|
+
| `expiresAt` | `Date` | Token expiration timestamp from the socket's `expires_at` field. |
|
|
3457
|
+
|
|
3458
|
+
`getOidcToken` caches one token per audience in memory and refreshes it 60 seconds before `expiresAt`. Concurrent callers for the same audience share a single in-flight mint request. Each mint request times out after 20 seconds.
|
|
3459
|
+
|
|
3460
|
+
### Error handling
|
|
3461
|
+
|
|
3462
|
+
`getOidcToken` throws `OidcTokenError` (a subclass of `Error` with `name === "OidcTokenError"`) on failure:
|
|
3463
|
+
|
|
3464
|
+
| Field | Type | Meaning |
|
|
3465
|
+
| --- | --- | --- |
|
|
3466
|
+
| `code` | `OidcTokenErrorCode` | Failure category listed below. |
|
|
3467
|
+
| `status` | `number \| undefined` | HTTP status code from the identity socket when an HTTP response was received. |
|
|
3468
|
+
| `reason` | `string \| undefined` | Machine-readable `error` string from the socket's JSON error body, when present. |
|
|
3469
|
+
|
|
3470
|
+
`OidcTokenErrorCode` values:
|
|
3471
|
+
|
|
3472
|
+
| `code` | Typical `status` | Cause | What to do |
|
|
3473
|
+
| --- | --- | --- | --- |
|
|
3474
|
+
| `"not_hosted"` | `undefined` | No identity socket exists (for example, during local `agent-sdk dev` or `agent-sdk serve`). | Use local credentials in development or skip OIDC locally. |
|
|
3475
|
+
| `"refused"` | `403` | The deployment is not running (stopped or deleted) or OIDC minting is disabled for this deployment. | Treat as non-retryable. Check deployment status. |
|
|
3476
|
+
| `"rate_limited"` | `429` | The per-pod mint rate limit was exceeded. | Back off and retry. Prefer `getOidcToken` caching over repeated raw calls. |
|
|
3477
|
+
| `"timeout"` | `undefined` | The mint request did not finish within 20 seconds. | Retry with backoff. |
|
|
3478
|
+
| `"malformed"` | `undefined` | The socket returned HTTP `200` with invalid JSON, missing `token` or `expires_at`, or a body larger than 64 KiB. | Retry or inspect runtime logs. |
|
|
3479
|
+
| `"failed"` | `400`, `5xx`, or `undefined` | Another HTTP error or socket transport failure. | Check `status`. HTTP `400` means fix the request or declare the audience in `hosting.oidc.audiences`; `5xx` errors are retryable. |
|
|
3480
|
+
|
|
3481
|
+
When you request an audience that is not listed in `hosting.oidc.audiences`, the socket returns HTTP `400` and `getOidcToken` throws `OidcTokenError` with `code: "failed"` and `status: 400`. Branch on `code` and `status` rather than matching `reason`, which can change.
|
|
3482
|
+
|
|
3483
|
+
## Call the identity socket directly
|
|
3484
|
+
|
|
3485
|
+
Use the local Unix domain socket directly from shell scripts, non-JavaScript tools, or when you need a `nonce` claim (which `getOidcToken` does not accept).
|
|
3486
|
+
|
|
3487
|
+
The socket path is in `$CURSOR_AGENT_SOCKET`, defaulting to `/run/cursor/api.sock`. Send `POST /v1/tokens/oidc` with `Content-Type: application/json` (maximum body size 4 KB):
|
|
3488
|
+
|
|
3489
|
+
```bash
|
|
3490
|
+
curl --silent --show-error --fail-with-body \
|
|
3491
|
+
--unix-socket "${CURSOR_AGENT_SOCKET:-/run/cursor/api.sock}" \
|
|
3492
|
+
-H 'Content-Type: application/json' \
|
|
3493
|
+
-d '{"aud":"sts.amazonaws.com"}' \
|
|
3494
|
+
http://localhost/v1/tokens/oidc
|
|
3495
|
+
```
|
|
3496
|
+
|
|
3497
|
+
Request fields:
|
|
3498
|
+
|
|
3499
|
+
- `aud` (required string): exact audience declared in `hosting.oidc.audiences`.
|
|
3500
|
+
- `nonce` (optional string): opaque printable ASCII string with no spaces, up to 512 characters, echoed into the JWT `nonce` claim.
|
|
3501
|
+
|
|
3502
|
+
Success response (`200 OK`):
|
|
3503
|
+
|
|
3504
|
+
```json
|
|
3505
|
+
{
|
|
3506
|
+
"token": "eyJhbGciOiJSUzI1NiIsImtpZCI6Ii4uLiIsInR5cCI6IkpXVCJ9...",
|
|
3507
|
+
"expires_at": 1785500000
|
|
3508
|
+
}
|
|
3509
|
+
```
|
|
3510
|
+
|
|
3511
|
+
`expires_at` is the token expiration in Unix seconds and matches the JWT `exp` claim.
|
|
3512
|
+
|
|
3513
|
+
An undeclared audience, a Cursor-reserved audience, an invalid `aud`, or a `sub_claim` field returns HTTP `400` with a JSON error object whose `error` string can change.
|
|
3514
|
+
|
|
3515
|
+
See [Cloud Agents OIDC tokens](https://cursor.com/docs/cloud-agent/identity) for the full socket HTTP status code table and per-pod rate limits.
|
|
3516
|
+
|
|
3517
|
+
## Token claims
|
|
3518
|
+
|
|
3519
|
+
Tokens are signed with `RS256` and include `alg`, `kid`, and `typ: "JWT"` in the header. Every Agent SDK token carries these claims:
|
|
3520
|
+
|
|
3521
|
+
| Claim | Value | Notes |
|
|
3522
|
+
| --- | --- | --- |
|
|
3523
|
+
| `iss` | `https://api.cursor.com` | Same issuer as Cloud Agents. |
|
|
3524
|
+
| `sub` | `agent_sdk_deployment_id:<deployment-id>` | `<deployment-id>` is the deployment public ID (`asd_` followed by 32 lowercase hex characters). |
|
|
3525
|
+
| `aud` | Requested audience string | Always a single string matching an entry in `hosting.oidc.audiences`. |
|
|
3526
|
+
| `iat` | Unix seconds | Issued-at time. |
|
|
3527
|
+
| `nbf` | `iat - 5` | Allows 5 seconds of clock skew. |
|
|
3528
|
+
| `exp` | `iat + 300` | Valid for 5 minutes. |
|
|
3529
|
+
| `jti` | UUID | Unique token ID per mint. |
|
|
3530
|
+
| `agent_runtime` | `"agent_sdk"` | Identifies an Agent SDK deployment token. |
|
|
3531
|
+
| `nonce` | Optional string | Present only when sent on a raw socket request. |
|
|
3532
|
+
|
|
3533
|
+
## Configure an AWS IAM trust policy
|
|
3534
|
+
|
|
3535
|
+
1. In AWS IAM, add `https://api.cursor.com` as an OpenID Connect identity provider with `sts.amazonaws.com` as an audience (if your AWS account does not already have one).
|
|
3536
|
+
2. Declare `"sts.amazonaws.com"` in `hosting.oidc.audiences` and `hosting.egressDomains`, then deploy your agent.
|
|
3537
|
+
3. Find your deployment's exact `sub` claim (`agent_sdk_deployment_id:asd_<32 hex chars>`). You can read `sub` from the JWT payload of a minted token during initial setup. Redeploying the same slug keeps the same deployment public ID; deleting and recreating a deployment generates a new one.
|
|
3538
|
+
4. Attach a trust policy to your IAM role that pins both `api.cursor.com:aud` and `api.cursor.com:sub` with `StringEquals`:
|
|
3539
|
+
|
|
3540
|
+
```json
|
|
3541
|
+
{
|
|
3542
|
+
"Version": "2012-10-17",
|
|
3543
|
+
"Statement": [
|
|
3544
|
+
{
|
|
3545
|
+
"Effect": "Allow",
|
|
3546
|
+
"Principal": {
|
|
3547
|
+
"Federated": "arn:aws:iam::123456789012:oidc-provider/api.cursor.com"
|
|
3548
|
+
},
|
|
3549
|
+
"Action": "sts:AssumeRoleWithWebIdentity",
|
|
3550
|
+
"Condition": {
|
|
3551
|
+
"StringEquals": {
|
|
3552
|
+
"api.cursor.com:aud": "sts.amazonaws.com",
|
|
3553
|
+
"api.cursor.com:sub": "agent_sdk_deployment_id:asd_3f9c0a7b1d2e4f60a9b8c7d6e5f40312"
|
|
3554
|
+
}
|
|
3555
|
+
}
|
|
3556
|
+
}
|
|
3557
|
+
]
|
|
3558
|
+
}
|
|
3559
|
+
```
|
|
3560
|
+
|
|
3561
|
+
Never replace the `sub` value with a wildcard such as `agent_sdk_deployment_id:*`. A wildcard trusts every Agent SDK deployment on Cursor.
|
|
3562
|
+
|
|
3563
|
+
## Verification, rate limits, and trust model
|
|
3564
|
+
|
|
3565
|
+
For OIDC discovery (`https://api.cursor.com/.well-known/openid-configuration`), JWKS (`https://api.cursor.com/keys`), JWT signature verification steps, and per-pod rate limits, see [Cloud Agents OIDC tokens](https://cursor.com/docs/cloud-agent/identity).
|
|
3566
|
+
|
|
3567
|
+
Keep the deployment trust boundary in mind when scoping external roles:
|
|
3568
|
+
|
|
3569
|
+
- Any code or tool running inside the deployment pod that can reach the identity socket can mint tokens for any audience declared in `hosting.oidc.audiences`.
|
|
3570
|
+
- The platform sets `sub` from the deployment identity, so one deployment cannot impersonate another.
|
|
3571
|
+
- Tokens represent the deployment as a whole, not a single session, tool, or end user. Grant the external role only the permissions that the deployment should hold.
|
|
3572
|
+
|
|
3573
|
+
## Related
|
|
3574
|
+
|
|
3575
|
+
- [Deployment](/docs/deployment.md)
|
|
3576
|
+
- [Agent config](/docs/reference/agent-config.md)
|
|
3577
|
+
- [Cloud Agents OIDC tokens](https://cursor.com/docs/cloud-agent/identity)
|
|
3578
|
+
|
|
3579
|
+
---
|
|
3580
|
+
|
|
3337
3581
|
Source: /docs/hillclimbing.md
|
|
3338
3582
|
|
|
3339
3583
|
# Hillclimbing
|
|
@@ -3766,7 +4010,7 @@ export default defineAgent({
|
|
|
3766
4010
|
| `description` | string | What the agent is for. Required on subagents, where the parent model reads it to decide when to delegate. |
|
|
3767
4011
|
| `instructions` | string | Inline instructions for subagents and generated configs. Prefer `instructions.md`. |
|
|
3768
4012
|
| `local` | `{ cwd?, workspaceDir?, sandbox? }` | Defaults for a local run. See [Local options](#local-options). |
|
|
3769
|
-
| `hosting` | `{ egressDomains?, secretNames? }` | The egress allowlist
|
|
4013
|
+
| `hosting` | `{ egressDomains?, secretNames?, oidc? }` | The egress allowlist, expected secret names, and [OIDC token audiences](/docs/guides/workload-identity.md) that `agent-sdk deploy` reads. Mounted [extensions](/docs/reference/extensions.md#build-an-extension) add their own egress hosts and secrets. |
|
|
3770
4014
|
| `concurrency` | `{ maxRunningTurns? }` | Agent-wide limit on concurrent turns. See [Concurrency](#concurrency). |
|
|
3771
4015
|
| `builtinTools` | `{ reminders? }` | Opt-in tools that Agent SDK provides. See [Built-in tools](#built-in-tools). |
|
|
3772
4016
|
| `tools` | `ToolName[]` | Allowlist of built-in tools. Omit it for the full standard toolset. See [Harness tools](#harness-tools). |
|
package/dist/docs/llms.txt
CHANGED
|
@@ -38,6 +38,7 @@
|
|
|
38
38
|
- [Slack](/docs/guides/slack.md): Wake your agent from mentions, DMs, and watched posts, then reply in the thread.
|
|
39
39
|
- [Microsoft Teams](/docs/guides/teams.md): Answer mentions, personal chats, and watched channel posts in Microsoft Teams with your own Azure Bot.
|
|
40
40
|
- [Webhooks & custom channels](/docs/guides/webhooks.md): Receive provider events, keep one conversation per domain object, and deliver agent replies back out.
|
|
41
|
+
- [Workload identity (OIDC)](/docs/guides/workload-identity.md): Mint short-lived OIDC tokens from a deployed Agent SDK agent to authenticate with cloud providers and external services without static keys.
|
|
41
42
|
|
|
42
43
|
## Reference
|
|
43
44
|
|