@grok/agent-sdk 0.2.28 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +29 -29
- package/dist/bin/agent-serve.d.ts +2 -2
- package/dist/bin/agent-serve.js +3 -3
- package/dist/channels/pagerduty/api.js +1 -1
- package/dist/channels/pagerduty/pagerduty-channel.d.ts +1 -1
- package/dist/channels/pagerduty/pagerduty-channel.d.ts.map +1 -1
- package/dist/channels/pagerduty/pagerduty-channel.js +1 -1
- package/dist/channels/pagerduty/replay.d.ts +1 -1
- package/dist/channels/pagerduty/replay.js +4 -4
- package/dist/channels/slack/cli-project.js +1 -1
- package/dist/docs/404.html +2 -2
- package/dist/docs/assets/{app.DF9vlcdn.js → app.BzTUBOAD.js} +4 -4
- package/dist/docs/assets/building-with-agents.md.BqJ7AAjG.js +6 -0
- package/dist/docs/assets/{building-with-agents.md.Bf1yH2tG.lean.js → building-with-agents.md.BqJ7AAjG.lean.js} +1 -1
- package/dist/docs/assets/changelog.md.BWhC6DET.js +1 -0
- package/dist/docs/assets/changelog.md.BWhC6DET.lean.js +1 -0
- package/dist/docs/assets/chunks/@localSearchIndexroot.CWxwVoCG.js +1 -0
- package/dist/docs/assets/chunks/{VPLocalSearchBox.D8OuwKO0.js → VPLocalSearchBox.DsnRlUT5.js} +1 -1
- package/dist/docs/assets/chunks/{arc.DCq_TCYV.js → arc.DH8GOhiv.js} +1 -1
- package/dist/docs/assets/chunks/{architectureDiagram-Q4EWVU46.PWRNTPbk.js → architectureDiagram-Q4EWVU46.9m9ObyuE.js} +1 -1
- package/dist/docs/assets/chunks/{baseUniq.BeRPvRUL.js → baseUniq.BXHpx1lE.js} +1 -1
- package/dist/docs/assets/chunks/{blockDiagram-DXYQGD6D.BuRmZVSo.js → blockDiagram-DXYQGD6D.xY3EX59q.js} +1 -1
- package/dist/docs/assets/chunks/{c4Diagram-AHTNJAMY.7DKSMwuv.js → c4Diagram-AHTNJAMY.DnqgMVgc.js} +1 -1
- package/dist/docs/assets/chunks/channel.Cctv0f7X.js +1 -0
- package/dist/docs/assets/chunks/{chunk-4BX2VUAB.7VrO9-9i.js → chunk-4BX2VUAB.BjFxK2A3.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-4TB4RGXK.CHystNE2.js → chunk-4TB4RGXK.BujS_Spt.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-55IACEB6.Nuh9TbTq.js → chunk-55IACEB6.YbTjhdaM.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-EDXVE4YY.CA0EKugm.js → chunk-EDXVE4YY.DnQ8t4GC.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-FMBD7UC4.F9_mp7U8.js → chunk-FMBD7UC4.B67AwAmj.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-OYMX7WX6.CEU4QfE1.js → chunk-OYMX7WX6.DrZIAFOm.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-QZHKN3VN.B8h_x9_i.js → chunk-QZHKN3VN.BLmmydkn.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-YZCP3GAM.Btfb-rKg.js → chunk-YZCP3GAM.DaoOfw0O.js} +1 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.DU5sqchW.js +1 -0
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.DU5sqchW.js +1 -0
- package/dist/docs/assets/chunks/clone.B9rdNt6j.js +1 -0
- package/dist/docs/assets/chunks/{cose-bilkent-S5V4N54A.DKvc96Wa.js → cose-bilkent-S5V4N54A.DMQuNhM5.js} +1 -1
- package/dist/docs/assets/chunks/{dagre-KV5264BT.CMo0cy1b.js → dagre-KV5264BT.CZoGVuUf.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-5BDNPKRD.DDgMOQhB.js → diagram-5BDNPKRD.CLt9uOyL.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-G4DWMVQ6.BdJnoIsU.js → diagram-G4DWMVQ6.DpczEm1G.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-MMDJMWI5.oSvhAZaL.js → diagram-MMDJMWI5.D4r13DvJ.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-TYMM5635.C9zZLIE-.js → diagram-TYMM5635.CYU9eGFu.js} +1 -1
- package/dist/docs/assets/chunks/{erDiagram-SMLLAGMA.BNhVyccy.js → erDiagram-SMLLAGMA.QA9naWEw.js} +1 -1
- package/dist/docs/assets/chunks/{flowDiagram-DWJPFMVM.BEFLLBiU.js → flowDiagram-DWJPFMVM.BbNoVZYd.js} +1 -1
- package/dist/docs/assets/chunks/{ganttDiagram-T4ZO3ILL.BdUzXBgY.js → ganttDiagram-T4ZO3ILL.IHjDoG7r.js} +1 -1
- package/dist/docs/assets/chunks/{gitGraphDiagram-UUTBAWPF.Rd3LlOIJ.js → gitGraphDiagram-UUTBAWPF.B21VMdf5.js} +1 -1
- package/dist/docs/assets/chunks/{graph.DnJC1GpG.js → graph.DgJ4L-8V.js} +1 -1
- package/dist/docs/assets/chunks/{infoDiagram-42DDH7IO.xv0xntDJ.js → infoDiagram-42DDH7IO.CQjrcthc.js} +1 -1
- package/dist/docs/assets/chunks/{ishikawaDiagram-UXIWVN3A.BaGIlviU.js → ishikawaDiagram-UXIWVN3A.D4tPGtVo.js} +1 -1
- package/dist/docs/assets/chunks/{journeyDiagram-VCZTEJTY.Cof_h0fp.js → journeyDiagram-VCZTEJTY.BD3WaNbQ.js} +1 -1
- package/dist/docs/assets/chunks/{kanban-definition-6JOO6SKY.C5GozFuU.js → kanban-definition-6JOO6SKY.Ca0o4Tqz.js} +1 -1
- package/dist/docs/assets/chunks/{layout.zc9UShLc.js → layout.DXXqX4MQ.js} +1 -1
- package/dist/docs/assets/chunks/{linear.BoqrFVcJ.js → linear.5c61gNw4.js} +1 -1
- package/dist/docs/assets/chunks/{min.DwIfr8hG.js → min.B1-NAjHX.js} +1 -1
- package/dist/docs/assets/chunks/{mindmap-definition-QFDTVHPH.Dkq2yTtp.js → mindmap-definition-QFDTVHPH.BELznv3-.js} +1 -1
- package/dist/docs/assets/chunks/{pieDiagram-DEJITSTG.B4CpTmHK.js → pieDiagram-DEJITSTG.qPzO1mq5.js} +1 -1
- package/dist/docs/assets/chunks/{quadrantDiagram-34T5L4WZ.BqXnFC9C.js → quadrantDiagram-34T5L4WZ.CxIvzbjX.js} +1 -1
- package/dist/docs/assets/chunks/{requirementDiagram-MS252O5E.DhIN2z-E.js → requirementDiagram-MS252O5E.CqA0iJx8.js} +1 -1
- package/dist/docs/assets/chunks/{sankeyDiagram-XADWPNL6.BhxUAmg2.js → sankeyDiagram-XADWPNL6.XRTutBnb.js} +1 -1
- package/dist/docs/assets/chunks/{sequenceDiagram-FGHM5R23.BqgU7HU-.js → sequenceDiagram-FGHM5R23.E--7bRLQ.js} +1 -1
- package/dist/docs/assets/chunks/{stateDiagram-FHFEXIEX.B1BCO18N.js → stateDiagram-FHFEXIEX.C4vGu8zq.js} +1 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.ECMu2BdJ.js +1 -0
- package/dist/docs/assets/chunks/{theme.oV7rddEz.js → theme.DMj_7q3B.js} +2 -2
- package/dist/docs/assets/chunks/{timeline-definition-GMOUNBTQ.oRI8UwMC.js → timeline-definition-GMOUNBTQ.C7LgNVAL.js} +1 -1
- package/dist/docs/assets/chunks/{vennDiagram-DHZGUBPP.DmuWrIxN.js → vennDiagram-DHZGUBPP.HUwoZcy_.js} +1 -1
- package/dist/docs/assets/chunks/{wardley-RL74JXVD.CEBjM5ov.js → wardley-RL74JXVD.BxFEFYZS.js} +1 -1
- package/dist/docs/assets/chunks/{wardleyDiagram-NUSXRM2D.m5zsCOF9.js → wardleyDiagram-NUSXRM2D.B2pSo5rB.js} +1 -1
- package/dist/docs/assets/chunks/{xychartDiagram-5P7HB3ND.cPN-587n.js → xychartDiagram-5P7HB3ND.NQhMiOOL.js} +1 -1
- package/dist/docs/assets/deployment.md.BtqJrHhp.js +31 -0
- package/dist/docs/assets/{deployment.md.DDmjAVbg.lean.js → deployment.md.BtqJrHhp.lean.js} +1 -1
- package/dist/docs/assets/evals.md.Dne6VRmZ.js +49 -0
- package/dist/docs/assets/evals.md.Dne6VRmZ.lean.js +1 -0
- package/dist/docs/assets/{guides_agent-to-agent.md.D1D5f6Jc.js → guides_agent-to-agent.md.BcmSqL2z.js} +8 -8
- package/dist/docs/assets/guides_agent-to-agent.md.BcmSqL2z.lean.js +1 -0
- package/dist/docs/assets/{guides_bitbucket.md.DkjkBRU8.js → guides_bitbucket.md.BiA6ZMFW.js} +27 -27
- package/dist/docs/assets/{guides_bitbucket.md.DkjkBRU8.lean.js → guides_bitbucket.md.BiA6ZMFW.lean.js} +1 -1
- package/dist/docs/assets/guides_cloud-agents.md.CiXAW6on.js +9 -0
- package/dist/docs/assets/{guides_cloud-agents.md.Ceyjv0ul.lean.js → guides_cloud-agents.md.CiXAW6on.lean.js} +1 -1
- package/dist/docs/assets/guides_convert-automation.md.BvTxsJ8J.js +26 -0
- package/dist/docs/assets/{guides_convert-automation.md.BjraCvok.lean.js → guides_convert-automation.md.BvTxsJ8J.lean.js} +1 -1
- package/dist/docs/assets/{guides_github.md.CgN5sNbW.js → guides_github.md.6jiEH7dg.js} +11 -19
- package/dist/docs/assets/{guides_github.md.CgN5sNbW.lean.js → guides_github.md.6jiEH7dg.lean.js} +1 -1
- package/dist/docs/assets/{guides_gitlab.md.DCE0p7_w.js → guides_gitlab.md.DcKusOcU.js} +63 -73
- package/dist/docs/assets/{guides_gitlab.md.DCE0p7_w.lean.js → guides_gitlab.md.DcKusOcU.lean.js} +1 -1
- package/dist/docs/assets/guides_improve.md.o3WOGR7n.js +16 -0
- package/dist/docs/assets/{guides_improve.md.BFYtrtLE.lean.js → guides_improve.md.o3WOGR7n.lean.js} +1 -1
- package/dist/docs/assets/{guides_jev.md.Ccw4pedT.js → guides_jev.md.DGCzkMUN.js} +20 -60
- package/dist/docs/assets/{guides_jev.md.Ccw4pedT.lean.js → guides_jev.md.DGCzkMUN.lean.js} +1 -1
- package/dist/docs/assets/{guides_mcp-oauth.md.ekpWOZCC.js → guides_mcp-oauth.md.C-Sx_IPa.js} +3 -5
- package/dist/docs/assets/{guides_mcp-oauth.md.ekpWOZCC.lean.js → guides_mcp-oauth.md.C-Sx_IPa.lean.js} +1 -1
- package/dist/docs/assets/guides_migrate.md.BbhHYeCr.js +3 -0
- package/dist/docs/assets/{guides_migrate.md.RS9Eu-Xh.lean.js → guides_migrate.md.BbhHYeCr.lean.js} +1 -1
- package/dist/docs/assets/guides_opentelemetry.md.BRSktBHt.js +26 -0
- package/dist/docs/assets/guides_opentelemetry.md.BRSktBHt.lean.js +1 -0
- package/dist/docs/assets/guides_pagerduty.md.pMXUkZZc.js +61 -0
- package/dist/docs/assets/guides_pagerduty.md.pMXUkZZc.lean.js +1 -0
- package/dist/docs/assets/guides_slack.md.BgIGG9ur.js +82 -0
- package/dist/docs/assets/{guides_slack.md.BqiGSYGX.lean.js → guides_slack.md.BgIGG9ur.lean.js} +1 -1
- package/dist/docs/assets/{guides_webhooks.md.BJk63ZTs.js → guides_webhooks.md.B5DXt2v1.js} +7 -7
- package/dist/docs/assets/{guides_webhooks.md.BJk63ZTs.lean.js → guides_webhooks.md.B5DXt2v1.lean.js} +1 -1
- package/dist/docs/assets/hillclimbing.md.3TkdF79A.js +5 -0
- package/dist/docs/assets/hillclimbing.md.3TkdF79A.lean.js +1 -0
- package/dist/docs/assets/index.md.DRfaoRCZ.js +20 -0
- package/dist/docs/assets/index.md.DRfaoRCZ.lean.js +1 -0
- package/dist/docs/assets/quickstart.md.r-oE8nkX.js +113 -0
- package/dist/docs/assets/{quickstart.md.DaLk4ZIF.lean.js → quickstart.md.r-oE8nkX.lean.js} +1 -1
- package/dist/docs/assets/reference_access.md.C5lblfUC.js +1 -0
- package/dist/docs/assets/{reference_access.md.CExlH_mR.lean.js → reference_access.md.C5lblfUC.lean.js} +1 -1
- package/dist/docs/assets/reference_agent-config.md.C0Tp_Fk9.js +27 -0
- package/dist/docs/assets/{reference_agent-config.md.11E_xe--.lean.js → reference_agent-config.md.C0Tp_Fk9.lean.js} +1 -1
- package/dist/docs/assets/reference_artifacts.md.BJpAI7h9.js +17 -0
- package/dist/docs/assets/{reference_artifacts.md.C-hKR2hp.lean.js → reference_artifacts.md.BJpAI7h9.lean.js} +1 -1
- package/dist/docs/assets/reference_channels.md.CPWOpdsC.js +21 -0
- package/dist/docs/assets/{reference_channels.md.DsJfGSBJ.lean.js → reference_channels.md.CPWOpdsC.lean.js} +1 -1
- package/dist/docs/assets/reference_cli.md.B8GdpaRj.js +83 -0
- package/dist/docs/assets/reference_cli.md.B8GdpaRj.lean.js +1 -0
- package/dist/docs/assets/reference_connections.md.DoY4vrDH.js +54 -0
- package/dist/docs/assets/{reference_connections.md.BoAotr7_.lean.js → reference_connections.md.DoY4vrDH.lean.js} +1 -1
- package/dist/docs/assets/reference_evals.md.DgfUtfIc.js +69 -0
- package/dist/docs/assets/{reference_evals.md.DYKjGFi-.lean.js → reference_evals.md.DgfUtfIc.lean.js} +1 -1
- package/dist/docs/assets/{reference_extensions.md.pEVj72Xo.js → reference_extensions.md.DHbW6eOf.js} +6 -8
- package/dist/docs/assets/{reference_extensions.md.pEVj72Xo.lean.js → reference_extensions.md.DHbW6eOf.lean.js} +1 -1
- package/dist/docs/assets/reference_hooks.md.CSWmOwMM.js +39 -0
- package/dist/docs/assets/reference_hooks.md.CSWmOwMM.lean.js +1 -0
- package/dist/docs/assets/reference_http-api.md.C7Cb0r2J.js +7 -0
- package/dist/docs/assets/{reference_http-api.md._RWELr3d.lean.js → reference_http-api.md.C7Cb0r2J.lean.js} +1 -1
- package/dist/docs/assets/reference_instructions.md.CV6Qq0UX.js +14 -0
- package/dist/docs/assets/reference_instructions.md.CV6Qq0UX.lean.js +1 -0
- package/dist/docs/assets/reference_limits.md.CbdtFr4T.js +8 -0
- package/dist/docs/assets/reference_limits.md.CbdtFr4T.lean.js +1 -0
- package/dist/docs/assets/reference_memory.md.CdoJISM-.js +3 -0
- package/dist/docs/assets/{reference_memory.md.Dd7cyV9V.lean.js → reference_memory.md.CdoJISM-.lean.js} +1 -1
- package/dist/docs/assets/reference_playground.md.DIUsRAcy.js +1 -0
- package/dist/docs/assets/{reference_playground.md.CQiJk9CM.lean.js → reference_playground.md.DIUsRAcy.lean.js} +1 -1
- package/dist/docs/assets/reference_project-layout.md.9DiKoE16.js +26 -0
- package/dist/docs/assets/reference_project-layout.md.9DiKoE16.lean.js +1 -0
- package/dist/docs/assets/reference_schedules.md.RhQ9ZLo1.js +45 -0
- package/dist/docs/assets/{reference_schedules.md.RC47aFm4.lean.js → reference_schedules.md.RhQ9ZLo1.lean.js} +1 -1
- package/dist/docs/assets/reference_sessions.md.NXVQt9mP.js +22 -0
- package/dist/docs/assets/{reference_sessions.md.C7KFhWXV.lean.js → reference_sessions.md.NXVQt9mP.lean.js} +1 -1
- package/dist/docs/assets/{reference_skills.md.Dej2zQxi.js → reference_skills.md.DzCPNPkG.js} +4 -4
- package/dist/docs/assets/{reference_skills.md.Dej2zQxi.lean.js → reference_skills.md.DzCPNPkG.lean.js} +1 -1
- package/dist/docs/assets/reference_subagents.md.Dvpq2sUu.js +10 -0
- package/dist/docs/assets/{reference_subagents.md.CAhvW4yS.lean.js → reference_subagents.md.Dvpq2sUu.lean.js} +1 -1
- package/dist/docs/assets/reference_tools.md.B2OaR1Nb.js +62 -0
- package/dist/docs/assets/{reference_tools.md.DQr7Fnhu.lean.js → reference_tools.md.B2OaR1Nb.lean.js} +1 -1
- package/dist/docs/assets/templates_agentic-owners.md.B6ZmKAzT.js +13 -0
- package/dist/docs/assets/{templates_agentic-owners.md.Dh2nDSqg.lean.js → templates_agentic-owners.md.B6ZmKAzT.lean.js} +1 -1
- package/dist/docs/assets/templates_reviews.md.dr9Xv_KM.js +10 -0
- package/dist/docs/assets/templates_reviews.md.dr9Xv_KM.lean.js +1 -0
- package/dist/docs/assets/troubleshooting.md.DfKKvW1R.js +3 -0
- package/dist/docs/assets/{troubleshooting.md.AGJ3jDzj.lean.js → troubleshooting.md.DfKKvW1R.lean.js} +1 -1
- package/dist/docs/building-with-agents.html +41 -44
- package/dist/docs/building-with-agents.md +11 -104
- package/dist/docs/changelog.html +37 -37
- package/dist/docs/changelog.md +5 -145
- package/dist/docs/deployment.html +54 -54
- package/dist/docs/deployment.md +86 -265
- package/dist/docs/evals.html +52 -71
- package/dist/docs/evals.md +33 -127
- package/dist/docs/guides/agent-to-agent.html +43 -43
- package/dist/docs/guides/agent-to-agent.md +27 -64
- package/dist/docs/guides/bitbucket.html +62 -62
- package/dist/docs/guides/bitbucket.md +73 -134
- package/dist/docs/guides/cloud-agents.html +37 -37
- package/dist/docs/guides/cloud-agents.md +23 -53
- package/dist/docs/guides/convert-automation.html +39 -56
- package/dist/docs/guides/convert-automation.md +31 -115
- package/dist/docs/guides/github.html +46 -54
- package/dist/docs/guides/github.md +49 -131
- package/dist/docs/guides/gitlab.html +98 -108
- package/dist/docs/guides/gitlab.md +104 -184
- package/dist/docs/guides/improve.html +38 -43
- package/dist/docs/guides/improve.md +24 -90
- package/dist/docs/guides/jev.html +55 -95
- package/dist/docs/guides/jev.md +57 -159
- package/dist/docs/guides/mcp-oauth.html +38 -40
- package/dist/docs/guides/mcp-oauth.md +34 -69
- package/dist/docs/guides/migrate.html +38 -43
- package/dist/docs/guides/migrate.md +56 -130
- package/dist/docs/guides/opentelemetry.html +41 -43
- package/dist/docs/guides/opentelemetry.md +32 -27
- package/dist/docs/guides/pagerduty.html +50 -49
- package/dist/docs/guides/pagerduty.md +65 -199
- package/dist/docs/guides/slack.html +51 -57
- package/dist/docs/guides/slack.md +76 -205
- package/dist/docs/guides/webhooks.html +42 -42
- package/dist/docs/guides/webhooks.md +64 -146
- package/dist/docs/hashmap.json +1 -1
- package/dist/docs/hillclimbing.html +40 -42
- package/dist/docs/hillclimbing.md +40 -102
- package/dist/docs/index.html +55 -62
- package/dist/docs/index.md +49 -82
- package/dist/docs/llms-full.txt +2292 -5830
- package/dist/docs/llms.txt +9 -15
- package/dist/docs/quickstart.html +96 -153
- package/dist/docs/quickstart.md +93 -178
- package/dist/docs/reference/access.html +36 -36
- package/dist/docs/reference/access.md +7 -12
- package/dist/docs/reference/agent-config.html +43 -56
- package/dist/docs/reference/agent-config.md +93 -176
- package/dist/docs/reference/artifacts.html +38 -39
- package/dist/docs/reference/artifacts.md +38 -62
- package/dist/docs/reference/channels.html +38 -39
- package/dist/docs/reference/channels.md +102 -151
- package/dist/docs/reference/cli.html +68 -84
- package/dist/docs/reference/cli.md +233 -698
- package/dist/docs/reference/connections.html +45 -57
- package/dist/docs/reference/connections.md +83 -164
- package/dist/docs/reference/evals.html +66 -53
- package/dist/docs/reference/evals.md +97 -128
- package/dist/docs/reference/extensions.html +41 -43
- package/dist/docs/reference/extensions.md +37 -70
- package/dist/docs/reference/hooks.html +40 -52
- package/dist/docs/reference/hooks.md +62 -133
- package/dist/docs/reference/http-api.html +38 -42
- package/dist/docs/reference/http-api.md +66 -118
- package/dist/docs/reference/instructions.html +39 -39
- package/dist/docs/reference/instructions.md +19 -29
- package/dist/docs/reference/limits.html +38 -38
- package/dist/docs/reference/limits.md +9 -21
- package/dist/docs/reference/memory.html +37 -38
- package/dist/docs/reference/memory.md +38 -75
- package/dist/docs/reference/playground.html +36 -36
- package/dist/docs/reference/playground.md +14 -22
- package/dist/docs/reference/project-layout.html +49 -48
- package/dist/docs/reference/project-layout.md +38 -84
- package/dist/docs/reference/schedules.html +46 -48
- package/dist/docs/reference/schedules.md +59 -90
- package/dist/docs/reference/sessions.html +37 -37
- package/dist/docs/reference/sessions.md +66 -113
- package/dist/docs/reference/skills.html +39 -39
- package/dist/docs/reference/skills.md +11 -31
- package/dist/docs/reference/subagents.html +37 -37
- package/dist/docs/reference/subagents.md +17 -31
- package/dist/docs/reference/tools.html +47 -64
- package/dist/docs/reference/tools.md +48 -130
- package/dist/docs/templates/agentic-owners.html +38 -38
- package/dist/docs/templates/agentic-owners.md +50 -74
- package/dist/docs/templates/reviews.html +69 -0
- package/dist/docs/templates/reviews.md +71 -0
- package/dist/docs/troubleshooting.html +38 -36
- package/dist/docs/troubleshooting.md +48 -101
- package/dist/evals.d.ts +2 -2
- package/dist/extensions/jev/extension.d.ts +12 -2
- package/dist/extensions/jev/extension.d.ts.map +1 -1
- package/dist/extensions/jev/extension.js +4 -0
- package/dist/extensions/jev/lib/evaluate.d.ts +31 -4
- package/dist/extensions/jev/lib/evaluate.d.ts.map +1 -1
- package/dist/extensions/jev/lib/evaluate.js +18 -4
- package/dist/internal/cli/command.d.ts +1 -1
- package/dist/internal/cli/command.js +1 -1
- package/dist/internal/cli/commands/channels.js +6 -6
- package/dist/internal/cli/commands/develop.d.ts.map +1 -1
- package/dist/internal/cli/commands/develop.js +23 -14
- package/dist/internal/cli/commands/hosted.js +4 -4
- package/dist/internal/cli/commands/index.d.ts +1 -1
- package/dist/internal/cli/commands/index.d.ts.map +1 -1
- package/dist/internal/cli/commands/index.js +1 -1
- package/dist/internal/cli/commands/mcp.js +1 -1
- package/dist/internal/cli/commands/project.js +4 -4
- package/dist/internal/cli/commands/scaffold.d.ts.map +1 -1
- package/dist/internal/cli/commands/scaffold.js +9 -6
- package/dist/internal/cli/commands/serve.d.ts +1 -1
- package/dist/internal/cli/commands/serve.js +5 -5
- package/dist/internal/cli/commands/session.d.ts.map +1 -1
- package/dist/internal/cli/commands/session.js +12 -7
- package/dist/internal/cli/dispatch.d.ts +3 -3
- package/dist/internal/cli/dispatch.js +3 -3
- package/dist/internal/cli/errors.d.ts +1 -1
- package/dist/internal/cli/errors.d.ts.map +1 -1
- package/dist/internal/cli/errors.js +1 -1
- package/dist/internal/cli/flags.d.ts +2 -2
- package/dist/internal/cli/flags.d.ts.map +1 -1
- package/dist/internal/cli/flags.js +2 -2
- package/dist/internal/cli/help-command.d.ts +1 -1
- package/dist/internal/cli/help-command.js +2 -2
- package/dist/internal/cli/help.d.ts +7 -7
- package/dist/internal/cli/help.d.ts.map +1 -1
- package/dist/internal/cli/help.js +8 -8
- package/dist/internal/cli-ax.d.ts.map +1 -1
- package/dist/internal/cli-ax.js +3 -0
- package/dist/internal/cli-convert-automation.d.ts +1 -1
- package/dist/internal/cli-convert-automation.js +1 -1
- package/dist/internal/cli-deploy.js +1 -1
- package/dist/internal/cli-docs.js +1 -1
- package/dist/internal/cli-images.js +1 -1
- package/dist/internal/cli-migrate.d.ts +1 -1
- package/dist/internal/cli-migrate.js +1 -1
- package/dist/internal/cli-pagerduty.d.ts +1 -1
- package/dist/internal/cli-pagerduty.js +1 -1
- package/dist/internal/cli-skills.js +1 -1
- package/dist/internal/convert-automation/types.d.ts +1 -1
- package/dist/internal/convert-automation/types.js +1 -1
- package/dist/internal/cursor/credentials.js +1 -1
- package/dist/internal/deploy-client.d.ts +2 -2
- package/dist/internal/deploy-client.d.ts.map +1 -1
- package/dist/internal/deploy-manifest.d.ts +1 -0
- package/dist/internal/deploy-manifest.d.ts.map +1 -1
- package/dist/internal/deploy-manifest.js +0 -1
- package/dist/internal/discovery/agent-config.d.ts +2 -6
- package/dist/internal/discovery/agent-config.d.ts.map +1 -1
- package/dist/internal/discovery/agent-config.js +8 -25
- package/dist/internal/discovery/agent.d.ts.map +1 -1
- package/dist/internal/discovery/agent.js +2 -3
- package/dist/internal/discovery/project.d.ts.map +1 -1
- package/dist/internal/discovery/project.js +15 -0
- package/dist/internal/init-project.d.ts +7 -3
- package/dist/internal/init-project.d.ts.map +1 -1
- package/dist/internal/init-project.js +60 -12
- package/dist/internal/init-scaffold.d.ts +2 -1
- package/dist/internal/init-scaffold.d.ts.map +1 -1
- package/dist/internal/init-scaffold.js +20 -7
- package/dist/internal/peer-connections.js +1 -1
- package/dist/internal/reminder-runner.js +1 -1
- package/dist/internal/server.d.ts +1 -1
- package/dist/internal/session-cost.d.ts +4 -4
- package/dist/internal/session-cost.d.ts.map +1 -1
- package/dist/internal/session-cost.js +4 -4
- package/dist/internal/session-engine.d.ts +1 -1
- package/dist/internal/session-engine.js +2 -2
- package/dist/internal/shallow-clone.js +1 -1
- package/dist/playground/assets/index-D6mVn9og.js +62 -0
- package/dist/playground/assets/index-DlALM6gr.css +1 -0
- package/dist/playground/index.html +2 -2
- package/dist/types.d.ts +9 -22
- package/dist/types.d.ts.map +1 -1
- package/docs/README.md +49 -82
- package/docs/building-with-agents.md +11 -104
- package/docs/changelog.md +6 -146
- package/docs/deployment.md +86 -265
- package/docs/evals.md +34 -128
- package/docs/guides/agent-to-agent.md +27 -64
- package/docs/guides/bitbucket.md +73 -134
- package/docs/guides/cloud-agents.md +23 -53
- package/docs/guides/convert-automation.md +31 -115
- package/docs/guides/github.md +49 -131
- package/docs/guides/gitlab.md +104 -184
- package/docs/guides/improve.md +24 -90
- package/docs/guides/jev.md +57 -159
- package/docs/guides/mcp-oauth.md +34 -69
- package/docs/guides/migrate.md +56 -130
- package/docs/guides/opentelemetry.md +37 -27
- package/docs/guides/pagerduty.md +68 -200
- package/docs/guides/slack.md +76 -205
- package/docs/guides/webhooks.md +64 -146
- package/docs/hillclimbing.md +41 -103
- package/docs/quickstart.md +93 -178
- package/docs/reference/access.md +7 -12
- package/docs/reference/agent-config.md +93 -176
- package/docs/reference/artifacts.md +38 -62
- package/docs/reference/channels.md +102 -151
- package/docs/reference/cli.md +233 -698
- package/docs/reference/connections.md +83 -164
- package/docs/reference/evals.md +97 -128
- package/docs/reference/extensions.md +37 -70
- package/docs/reference/hooks.md +61 -132
- package/docs/reference/http-api.md +66 -118
- package/docs/reference/instructions.md +20 -30
- package/docs/reference/limits.md +10 -22
- package/docs/reference/memory.md +38 -75
- package/docs/reference/playground.md +14 -22
- package/docs/reference/project-layout.md +38 -84
- package/docs/reference/schedules.md +59 -90
- package/docs/reference/sessions.md +66 -113
- package/docs/reference/skills.md +12 -32
- package/docs/reference/subagents.md +17 -31
- package/docs/reference/tools.md +48 -130
- package/docs/templates/agentic-owners.md +50 -74
- package/docs/templates/reviews.md +76 -0
- package/docs/troubleshooting.md +48 -101
- package/package.json +3 -9
- package/skills/cli/SKILL.md +15 -15
- package/skills/create-agent/SKILL.md +20 -19
- package/skills/debug/SKILL.md +4 -4
- package/skills/deploy/SKILL.md +2 -2
- package/skills/evals/SKILL.md +8 -8
- package/skills/framework-map/SKILL.md +3 -3
- package/skills/github/SKILL.md +7 -7
- package/skills/hillclimb/SKILL.md +4 -4
- package/skills/mcp-auth/SKILL.md +3 -3
- package/skills/migrate-v2/SKILL.md +40 -41
- package/skills/otel/SKILL.md +2 -2
- package/skills/setup-slack/SKILL.md +8 -8
- package/templates/agentic-owners/README.md +5 -5
- package/templates/agentic-owners/bot/tools/record_review.ts +1 -1
- package/templates/agentic-owners/package.json +1 -1
- package/templates/agents-md/README.md +4 -4
- package/templates/agents-md/package.json +1 -1
- package/templates/code-wiki/README.md +3 -3
- package/templates/code-wiki/package.json +1 -1
- package/templates/demo/README.md +3 -3
- package/templates/demo/package.json +1 -1
- package/templates/pr-autofixer/package.json +1 -1
- package/templates/security-help/README.md +5 -5
- package/templates/security-help/package.json +1 -1
- package/templates/security-reviewer/README.md +3 -3
- package/templates/security-reviewer/package.json +1 -1
- package/templates/thermo-quality-review/README.md +4 -4
- package/templates/thermo-quality-review/package.json +1 -1
- package/templates/thermo-review/README.md +4 -4
- package/templates/thermo-review/package.json +1 -1
- package/templates/triage/README.md +3 -3
- package/templates/triage/overlays/jira/README.md +3 -3
- package/templates/triage/overlays/linear/README.md +3 -3
- package/templates/triage/package.json +1 -1
- package/dist/docs/assets/building-with-agents.md.Bf1yH2tG.js +0 -9
- package/dist/docs/assets/changelog.md.fZ-NNFeJ.js +0 -1
- package/dist/docs/assets/changelog.md.fZ-NNFeJ.lean.js +0 -1
- package/dist/docs/assets/chunks/@localSearchIndexroot.mfzjiOsL.js +0 -1
- package/dist/docs/assets/chunks/channel.goFR5lbe.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.B2yLtFja.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.B2yLtFja.js +0 -1
- package/dist/docs/assets/chunks/clone.CztV97Wu.js +0 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.CZlVHdDZ.js +0 -1
- package/dist/docs/assets/deployment.md.DDmjAVbg.js +0 -31
- package/dist/docs/assets/evals.md.OjKb7tNA.js +0 -68
- package/dist/docs/assets/evals.md.OjKb7tNA.lean.js +0 -1
- package/dist/docs/assets/guides_agent-to-agent.md.D1D5f6Jc.lean.js +0 -1
- package/dist/docs/assets/guides_cloud-agents.md.Ceyjv0ul.js +0 -9
- package/dist/docs/assets/guides_convert-automation.md.BjraCvok.js +0 -43
- package/dist/docs/assets/guides_grokbot-agents.md.D0PpM_Gf.js +0 -15
- package/dist/docs/assets/guides_grokbot-agents.md.D0PpM_Gf.lean.js +0 -1
- package/dist/docs/assets/guides_hooks.md.BjeEiM7s.js +0 -54
- package/dist/docs/assets/guides_hooks.md.BjeEiM7s.lean.js +0 -1
- package/dist/docs/assets/guides_improve.md.BFYtrtLE.js +0 -21
- package/dist/docs/assets/guides_migrate.md.RS9Eu-Xh.js +0 -8
- package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.js +0 -28
- package/dist/docs/assets/guides_opentelemetry.md.CoZ1kNyd.lean.js +0 -1
- package/dist/docs/assets/guides_pagerduty.md.mnKXe9U0.js +0 -60
- package/dist/docs/assets/guides_pagerduty.md.mnKXe9U0.lean.js +0 -1
- package/dist/docs/assets/guides_slack.md.BqiGSYGX.js +0 -88
- package/dist/docs/assets/hillclimbing.md.By61f3uq.js +0 -7
- package/dist/docs/assets/hillclimbing.md.By61f3uq.lean.js +0 -1
- package/dist/docs/assets/index.md.CVRjO09Y.js +0 -27
- package/dist/docs/assets/index.md.CVRjO09Y.lean.js +0 -1
- package/dist/docs/assets/quickstart.md.DaLk4ZIF.js +0 -170
- package/dist/docs/assets/reference_access.md.CExlH_mR.js +0 -1
- package/dist/docs/assets/reference_agent-config.md.11E_xe--.js +0 -40
- package/dist/docs/assets/reference_artifacts.md.C-hKR2hp.js +0 -18
- package/dist/docs/assets/reference_channels.md.DsJfGSBJ.js +0 -22
- package/dist/docs/assets/reference_cli.md.DQ3dCgmk.js +0 -99
- package/dist/docs/assets/reference_cli.md.DQ3dCgmk.lean.js +0 -1
- package/dist/docs/assets/reference_connections.md.BoAotr7_.js +0 -66
- package/dist/docs/assets/reference_evals.md.DYKjGFi-.js +0 -56
- package/dist/docs/assets/reference_hooks.md.B-bwJuiG.js +0 -51
- package/dist/docs/assets/reference_hooks.md.B-bwJuiG.lean.js +0 -1
- package/dist/docs/assets/reference_http-api.md._RWELr3d.js +0 -11
- package/dist/docs/assets/reference_instructions.md.yL2hXLnl.js +0 -14
- package/dist/docs/assets/reference_instructions.md.yL2hXLnl.lean.js +0 -1
- package/dist/docs/assets/reference_limits.md.Da1HegjB.js +0 -8
- package/dist/docs/assets/reference_limits.md.Da1HegjB.lean.js +0 -1
- package/dist/docs/assets/reference_memory.md.Dd7cyV9V.js +0 -4
- package/dist/docs/assets/reference_playground.md.CQiJk9CM.js +0 -1
- package/dist/docs/assets/reference_project-layout.md.BamcPDUn.js +0 -25
- package/dist/docs/assets/reference_project-layout.md.BamcPDUn.lean.js +0 -1
- package/dist/docs/assets/reference_prompt.md.BMjm1Jp3.js +0 -9
- package/dist/docs/assets/reference_prompt.md.BMjm1Jp3.lean.js +0 -1
- package/dist/docs/assets/reference_schedules.md.RC47aFm4.js +0 -47
- package/dist/docs/assets/reference_sessions.md.C7KFhWXV.js +0 -22
- package/dist/docs/assets/reference_subagents.md.CAhvW4yS.js +0 -10
- package/dist/docs/assets/reference_tools.md.DQr7Fnhu.js +0 -79
- package/dist/docs/assets/templates_agentic-owners.md.Dh2nDSqg.js +0 -13
- package/dist/docs/assets/templates_security-reviewer.md.DnwXdnB5.js +0 -3
- package/dist/docs/assets/templates_security-reviewer.md.DnwXdnB5.lean.js +0 -1
- package/dist/docs/assets/templates_thermo-quality-review.md.MJIdHkzE.js +0 -3
- package/dist/docs/assets/templates_thermo-quality-review.md.MJIdHkzE.lean.js +0 -1
- package/dist/docs/assets/templates_thermo-review.md.DfN1OFOl.js +0 -3
- package/dist/docs/assets/templates_thermo-review.md.DfN1OFOl.lean.js +0 -1
- package/dist/docs/assets/templates_triage.md.BYWMloV4.js +0 -9
- package/dist/docs/assets/templates_triage.md.BYWMloV4.lean.js +0 -1
- package/dist/docs/assets/troubleshooting.md.AGJ3jDzj.js +0 -1
- package/dist/docs/guides/grokbot-agents.html +0 -74
- package/dist/docs/guides/grokbot-agents.md +0 -129
- package/dist/docs/guides/hooks.html +0 -113
- package/dist/docs/guides/hooks.md +0 -116
- package/dist/docs/reference/prompt.html +0 -68
- package/dist/docs/reference/prompt.md +0 -47
- package/dist/docs/templates/security-reviewer.html +0 -62
- package/dist/docs/templates/security-reviewer.md +0 -81
- package/dist/docs/templates/thermo-quality-review.html +0 -62
- package/dist/docs/templates/thermo-quality-review.md +0 -75
- package/dist/docs/templates/thermo-review.html +0 -62
- package/dist/docs/templates/thermo-review.md +0 -75
- package/dist/docs/templates/triage.html +0 -68
- package/dist/docs/templates/triage.md +0 -101
- package/dist/extensions/cursor-grokbot-agents/extension.d.ts +0 -71
- package/dist/extensions/cursor-grokbot-agents/extension.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/extension.js +0 -64
- package/dist/extensions/cursor-grokbot-agents/lib/agents.d.ts +0 -11
- package/dist/extensions/cursor-grokbot-agents/lib/agents.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/agents.js +0 -31
- package/dist/extensions/cursor-grokbot-agents/lib/backend.d.ts +0 -56
- package/dist/extensions/cursor-grokbot-agents/lib/backend.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/backend.js +0 -139
- package/dist/extensions/cursor-grokbot-agents/lib/contacts.d.ts +0 -28
- package/dist/extensions/cursor-grokbot-agents/lib/contacts.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/contacts.js +0 -46
- package/dist/extensions/cursor-grokbot-agents/lib/conversation.d.ts +0 -53
- package/dist/extensions/cursor-grokbot-agents/lib/conversation.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/conversation.js +0 -186
- package/dist/extensions/cursor-grokbot-agents/lib/inputs.d.ts +0 -4
- package/dist/extensions/cursor-grokbot-agents/lib/inputs.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/inputs.js +0 -15
- package/dist/extensions/cursor-grokbot-agents/lib/lock.d.ts +0 -12
- package/dist/extensions/cursor-grokbot-agents/lib/lock.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/lib/lock.js +0 -24
- package/dist/extensions/cursor-grokbot-agents/skills/consult.md +0 -40
- package/dist/extensions/cursor-grokbot-agents/tools/ask.d.ts +0 -4
- package/dist/extensions/cursor-grokbot-agents/tools/ask.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/tools/ask.js +0 -26
- package/dist/extensions/cursor-grokbot-agents/tools/check.d.ts +0 -4
- package/dist/extensions/cursor-grokbot-agents/tools/check.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/tools/check.js +0 -21
- package/dist/extensions/cursor-grokbot-agents/tools/interrupt.d.ts +0 -4
- package/dist/extensions/cursor-grokbot-agents/tools/interrupt.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/tools/interrupt.js +0 -13
- package/dist/extensions/cursor-grokbot-agents/tools/list.d.ts +0 -4
- package/dist/extensions/cursor-grokbot-agents/tools/list.d.ts.map +0 -1
- package/dist/extensions/cursor-grokbot-agents/tools/list.js +0 -22
- package/dist/playground/assets/index-BMpVzZzC.css +0 -1
- package/dist/playground/assets/index-_3zz3yh8.js +0 -62
- package/docs/guides/grokbot-agents.md +0 -134
- package/docs/guides/hooks.md +0 -121
- package/docs/reference/prompt.md +0 -52
- package/docs/templates/security-reviewer.md +0 -86
- package/docs/templates/thermo-quality-review.md +0 -80
- package/docs/templates/thermo-review.md +0 -80
- package/docs/templates/triage.md +0 -106
package/dist/docs/quickstart.md
CHANGED
|
@@ -1,43 +1,52 @@
|
|
|
1
1
|
# Build a PR reviewer with Agent SDK
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
changes as `trivial`, `moderate`, or `large`, then approves safe changes or
|
|
5
|
-
requests human review.
|
|
3
|
+
You'll build a reviewer that rates each pull request as `trivial`, `moderate`, or `large`, then approves safe changes or asks for a human review.
|
|
6
4
|
|
|
7
|
-
|
|
5
|
+
When it's deployed, you'll manage it in [Deployed Agents](https://cursor.com/dashboard/deployed-agents).
|
|
8
6
|
|
|
9
|
-
|
|
7
|
+
## Build it with a coding agent
|
|
10
8
|
|
|
11
|
-
|
|
9
|
+
Paste this prompt into your coding agent to build the reviewer from this page. The sections after
|
|
10
|
+
it walk through the same steps by hand.
|
|
12
11
|
|
|
13
12
|
```text
|
|
14
|
-
|
|
13
|
+
Build the PR reviewer from https://cursor.com/docs/agent-sdk/quickstart.md
|
|
14
|
+
in ./pr-reviewer. Fetch that page and follow each step in order.
|
|
15
|
+
|
|
16
|
+
- If agent-sdk isn't on PATH, install it with
|
|
17
|
+
npm install --global @grok/agent-sdk. Wait while I finish agent-sdk login.
|
|
18
|
+
- Use the code from the page as written. Ask me for a GitHub repository and
|
|
19
|
+
a pull request I didn't author, and use them in place of acme/checkout#42.
|
|
20
|
+
- Run both tool-call checks, and confirm the complexity each one reports.
|
|
21
|
+
- Ask me before any step that posts a review on GitHub. Skip the deploy step.
|
|
22
|
+
|
|
23
|
+
Finish with agent-sdk validate --dir . and the project's TypeScript check,
|
|
24
|
+
then tell me what passed.
|
|
15
25
|
```
|
|
16
26
|
|
|
17
|
-
|
|
27
|
+
## Prerequisites
|
|
28
|
+
|
|
29
|
+
You need Node 22.13 or newer and a Cursor login for model turns:
|
|
18
30
|
|
|
19
|
-
```
|
|
31
|
+
```bash
|
|
32
|
+
npm install -g @grok/agent-sdk
|
|
20
33
|
agent-sdk login
|
|
21
34
|
```
|
|
22
35
|
|
|
23
36
|
## Create and run the project
|
|
24
37
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
```text
|
|
38
|
+
```bash
|
|
28
39
|
agent-sdk init ./pr-reviewer
|
|
29
40
|
cd pr-reviewer
|
|
30
41
|
agent-sdk dev
|
|
31
42
|
```
|
|
32
43
|
|
|
33
|
-
|
|
44
|
+
In a second terminal, confirm the agent replies:
|
|
34
45
|
|
|
35
|
-
```
|
|
46
|
+
```bash
|
|
36
47
|
agent-sdk run --dir . --message "Introduce yourself in one sentence."
|
|
37
48
|
```
|
|
38
49
|
|
|
39
|
-
Confirm the agent replies.
|
|
40
|
-
|
|
41
50
|
## Add review instructions
|
|
42
51
|
|
|
43
52
|
Replace `bot/instructions.md`:
|
|
@@ -45,107 +54,72 @@ Replace `bot/instructions.md`:
|
|
|
45
54
|
```md
|
|
46
55
|
# PR reviewer
|
|
47
56
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
57
|
+
Call `inspect_pr` before you judge a pull request, then act on the
|
|
58
|
+
complexity it reports:
|
|
59
|
+
|
|
60
|
+
- `trivial`: approve with `submit_review` if the diff matches the title
|
|
61
|
+
and nothing looks risky.
|
|
62
|
+
- `moderate`: approve only when you understand every patch and see no
|
|
63
|
+
risk. Otherwise request a human review and name the files that worry you.
|
|
64
|
+
- `large`: request a human review right away and point the reviewer at
|
|
65
|
+
the biggest files.
|
|
66
|
+
|
|
67
|
+
Never approve a draft. End with one sentence that gives the verdict and why.
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Share the URL parser
|
|
71
|
+
|
|
72
|
+
Both tools parse a pull request URL, so put the parser in `bot/lib/github.ts`, where Agent SDK doesn't look for tools.
|
|
73
|
+
|
|
74
|
+
```ts
|
|
75
|
+
export function parsePrUrl(prUrl: string) {
|
|
76
|
+
const [owner, repo, pulls, number] = new URL(prUrl).pathname.split("/").filter(Boolean);
|
|
77
|
+
const pull_number = Number.parseInt(number ?? "", 10);
|
|
78
|
+
if (pulls !== "pull" || owner === undefined || repo === undefined || Number.isNaN(pull_number)) {
|
|
79
|
+
throw new Error(`Not a pull request URL: ${prUrl}`);
|
|
80
|
+
}
|
|
81
|
+
return { owner, repo, pull_number };
|
|
82
|
+
}
|
|
67
83
|
```
|
|
68
84
|
|
|
69
85
|
## Add the inspect tool
|
|
70
86
|
|
|
71
|
-
Create `bot/tools/inspect_pr.ts
|
|
87
|
+
Create `bot/tools/inspect_pr.ts`. It skips patches on a large pull request and caps the rest at 3,000 characters.
|
|
72
88
|
|
|
73
89
|
```ts
|
|
74
90
|
import { defineTool } from "@grok/agent-sdk/tools";
|
|
75
91
|
import { z } from "zod";
|
|
92
|
+
import { parsePrUrl } from "../lib/github.js";
|
|
76
93
|
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
function rateComplexity(linesChanged: number, changedFiles: number): Complexity {
|
|
94
|
+
function rateComplexity(linesChanged: number, changedFiles: number) {
|
|
80
95
|
if (linesChanged <= 25 && changedFiles <= 2) {
|
|
81
96
|
return "trivial";
|
|
82
97
|
}
|
|
83
|
-
|
|
84
98
|
if (linesChanged <= 400 && changedFiles <= 15) {
|
|
85
99
|
return "moderate";
|
|
86
100
|
}
|
|
87
|
-
|
|
88
101
|
return "large";
|
|
89
102
|
}
|
|
90
103
|
|
|
91
|
-
/** Keep one oversized file from flooding the model's context. */
|
|
92
|
-
function trimPatch(patch: string | undefined): string | undefined {
|
|
93
|
-
if (patch === undefined || patch.length <= 3000) {
|
|
94
|
-
return patch;
|
|
95
|
-
}
|
|
96
|
-
|
|
97
|
-
return `${patch.slice(0, 3000)}\n[... patch trimmed ...]`;
|
|
98
|
-
}
|
|
99
|
-
|
|
100
104
|
export default defineTool({
|
|
101
|
-
description:
|
|
102
|
-
|
|
103
|
-
inputSchema: z.object({
|
|
104
|
-
prUrl: z
|
|
105
|
-
.string()
|
|
106
|
-
.describe("Pull request URL: https://github.com/owner/repo/pull/123"),
|
|
107
|
-
}),
|
|
105
|
+
description: "Fetch a pull request's title, patches, and complexity.",
|
|
106
|
+
inputSchema: z.object({ prUrl: z.string().describe("GitHub pull request URL") }),
|
|
108
107
|
async execute({ prUrl }, ctx) {
|
|
109
|
-
const
|
|
110
|
-
const [owner, repo, pulls, number] = url.pathname.split("/").filter(Boolean);
|
|
111
|
-
const pull_number = Number.parseInt(number ?? "", 10);
|
|
112
|
-
if (pulls !== "pull" || owner === undefined || Number.isNaN(pull_number)) {
|
|
113
|
-
throw new Error(`Not a pull request URL: ${prUrl}`);
|
|
114
|
-
}
|
|
115
|
-
|
|
108
|
+
const pull = parsePrUrl(prUrl);
|
|
116
109
|
const octokit = await ctx.host.github.getOctokit();
|
|
117
|
-
const { data: pr } = await octokit.rest.pulls.get(
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
pull_number,
|
|
121
|
-
});
|
|
122
|
-
|
|
123
|
-
const { data: files } = await octokit.rest.pulls.listFiles({
|
|
124
|
-
owner,
|
|
125
|
-
repo,
|
|
126
|
-
pull_number,
|
|
127
|
-
per_page: 100,
|
|
128
|
-
});
|
|
129
|
-
|
|
130
|
-
const complexity = rateComplexity(
|
|
131
|
-
pr.additions + pr.deletions,
|
|
132
|
-
pr.changed_files
|
|
133
|
-
);
|
|
110
|
+
const { data: pr } = await octokit.rest.pulls.get(pull);
|
|
111
|
+
const { data: files } = await octokit.rest.pulls.listFiles({ ...pull, per_page: 100 });
|
|
112
|
+
const complexity = rateComplexity(pr.additions + pr.deletions, pr.changed_files);
|
|
134
113
|
|
|
135
114
|
return {
|
|
136
115
|
title: pr.title,
|
|
137
|
-
author: pr.user?.login,
|
|
138
|
-
state: pr.state,
|
|
139
116
|
draft: pr.draft ?? false,
|
|
140
|
-
additions: pr.additions,
|
|
141
|
-
deletions: pr.deletions,
|
|
142
|
-
changedFiles: pr.changed_files,
|
|
143
117
|
complexity,
|
|
144
118
|
files: files.map((file) => ({
|
|
145
119
|
path: file.filename,
|
|
146
120
|
additions: file.additions,
|
|
147
121
|
deletions: file.deletions,
|
|
148
|
-
|
|
122
|
+
patch: complexity === "large" ? undefined : file.patch?.slice(0, 3000),
|
|
149
123
|
})),
|
|
150
124
|
};
|
|
151
125
|
},
|
|
@@ -154,103 +128,66 @@ export default defineTool({
|
|
|
154
128
|
|
|
155
129
|
## Verify complexity classification
|
|
156
130
|
|
|
157
|
-
|
|
131
|
+
Call the tool without a model turn:
|
|
158
132
|
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
```
|
|
133
|
+
```bash
|
|
134
|
+
# Expect "complexity": "trivial"
|
|
135
|
+
agent-sdk tool call inspect_pr --dir . --input '{"prUrl":"https://github.com/facebook/react/pull/35623"}'
|
|
163
136
|
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
Run it against a large pull request:
|
|
167
|
-
|
|
168
|
-
```text
|
|
169
|
-
agent-sdk tool call inspect_pr --dir . \
|
|
170
|
-
--input '{"prUrl":"https://github.com/facebook/react/pull/25229"}'
|
|
137
|
+
# Expect "complexity": "large" and no patch fields
|
|
138
|
+
agent-sdk tool call inspect_pr --dir . --input '{"prUrl":"https://github.com/facebook/react/pull/25229"}'
|
|
171
139
|
```
|
|
172
140
|
|
|
173
|
-
Confirm the result contains `"complexity": "large"` and no `patch`
|
|
174
|
-
fields.
|
|
175
|
-
|
|
176
141
|
## Add the review tool
|
|
177
142
|
|
|
178
|
-
Create `bot/tools/submit_review.ts
|
|
143
|
+
Create `bot/tools/submit_review.ts`:
|
|
179
144
|
|
|
180
145
|
```ts
|
|
181
146
|
import { defineTool } from "@grok/agent-sdk/tools";
|
|
182
147
|
import { z } from "zod";
|
|
148
|
+
import { parsePrUrl } from "../lib/github.js";
|
|
183
149
|
|
|
184
150
|
export default defineTool({
|
|
185
|
-
description:
|
|
186
|
-
"Post the review decision to GitHub: approve the pull request, or comment asking for a human review.",
|
|
151
|
+
description: "Approve the pull request, or comment asking for a human review.",
|
|
187
152
|
inputSchema: z.object({
|
|
188
|
-
prUrl: z
|
|
189
|
-
.string()
|
|
190
|
-
.describe("Pull request URL: https://github.com/owner/repo/pull/123"),
|
|
153
|
+
prUrl: z.string().describe("GitHub pull request URL"),
|
|
191
154
|
verdict: z.enum(["approve", "request_human_review"]),
|
|
192
|
-
summary: z
|
|
193
|
-
.string()
|
|
194
|
-
.describe("One or two sentences explaining the verdict."),
|
|
155
|
+
summary: z.string().describe("One or two sentences on why."),
|
|
195
156
|
}),
|
|
196
157
|
async execute({ prUrl, verdict, summary }, ctx) {
|
|
197
|
-
const
|
|
198
|
-
const [owner, repo, pulls, number] = url.pathname.split("/").filter(Boolean);
|
|
199
|
-
const pull_number = Number.parseInt(number ?? "", 10);
|
|
200
|
-
if (pulls !== "pull" || owner === undefined || Number.isNaN(pull_number)) {
|
|
201
|
-
throw new Error(`Not a pull request URL: ${prUrl}`);
|
|
202
|
-
}
|
|
203
|
-
|
|
204
|
-
const review =
|
|
205
|
-
verdict === "approve"
|
|
206
|
-
? { event: "APPROVE" as const, body: `PR reviewer: ${summary}` }
|
|
207
|
-
: {
|
|
208
|
-
event: "COMMENT" as const,
|
|
209
|
-
body: `PR reviewer: this change needs a human review. ${summary}`,
|
|
210
|
-
};
|
|
211
|
-
|
|
158
|
+
const approve = verdict === "approve";
|
|
212
159
|
const octokit = await ctx.host.github.getOctokit();
|
|
213
160
|
await octokit.rest.pulls.createReview({
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
event: review.event,
|
|
218
|
-
body: review.body,
|
|
161
|
+
...parsePrUrl(prUrl),
|
|
162
|
+
event: approve ? "APPROVE" : "COMMENT",
|
|
163
|
+
body: approve ? summary : `Human review needed. ${summary}`,
|
|
219
164
|
});
|
|
220
|
-
return { posted: true,
|
|
165
|
+
return { posted: true, verdict };
|
|
221
166
|
},
|
|
222
167
|
});
|
|
223
168
|
```
|
|
224
169
|
|
|
225
|
-
|
|
226
|
-
author.
|
|
170
|
+
You need GitHub write access and a pull request you didn't author.
|
|
227
171
|
|
|
228
172
|
## Review a pull request
|
|
229
173
|
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
```text
|
|
233
|
-
agent-sdk run --dir . \
|
|
234
|
-
--message "Review https://github.com/acme/checkout/pull/42"
|
|
174
|
+
```bash
|
|
175
|
+
agent-sdk run --dir . --message "Review https://github.com/acme/checkout/pull/42"
|
|
235
176
|
```
|
|
236
177
|
|
|
237
|
-
Confirm `inspect_pr` runs before `submit_review`, then
|
|
238
|
-
on GitHub.
|
|
178
|
+
Confirm `inspect_pr` runs before `submit_review`, then check the review on GitHub.
|
|
239
179
|
|
|
240
180
|
## Trigger reviews from GitHub
|
|
241
181
|
|
|
242
182
|
Create `bot/channels/github.ts`:
|
|
243
183
|
|
|
244
184
|
```ts
|
|
245
|
-
import {
|
|
246
|
-
defaultGitHubAuth,
|
|
247
|
-
githubChannel,
|
|
248
|
-
} from "@grok/agent-sdk/channels/github";
|
|
185
|
+
import { defaultGitHubAuth, githubChannel } from "@grok/agent-sdk/channels/github";
|
|
249
186
|
|
|
250
187
|
const REVIEW_ACTIONS = new Set(["opened", "reopened", "ready_for_review"]);
|
|
251
188
|
|
|
252
189
|
export default githubChannel({
|
|
253
|
-
botName: "
|
|
190
|
+
botName: "agent-sdk-pr-reviewer",
|
|
254
191
|
cursorAccount: { repos: ["acme/checkout"] },
|
|
255
192
|
onPullRequest: (ctx, pr) => {
|
|
256
193
|
if (!REVIEW_ACTIONS.has(pr.action) || pr.draft) {
|
|
@@ -260,48 +197,26 @@ export default githubChannel({
|
|
|
260
197
|
return {
|
|
261
198
|
auth: defaultGitHubAuth(ctx),
|
|
262
199
|
title: `Review ${ctx.repository.fullName}#${pr.number}`,
|
|
263
|
-
context: [
|
|
264
|
-
`Review ${pr.url}. Inspect it first, then submit your verdict with submit_review.`,
|
|
265
|
-
],
|
|
200
|
+
context: [`Review ${pr.url}.`],
|
|
266
201
|
};
|
|
267
202
|
},
|
|
268
203
|
});
|
|
269
204
|
```
|
|
270
205
|
|
|
271
|
-
|
|
272
|
-
an array. The `context` label under `progress.commitStatus` is a separate
|
|
273
|
-
string option.
|
|
206
|
+
With `agent-sdk dev` running, replay an open pull request. Pull access is enough:
|
|
274
207
|
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
```text
|
|
279
|
-
agent-sdk github replay https://github.com/acme/checkout/pull/42 \
|
|
280
|
-
--dir . --action opened
|
|
208
|
+
```bash
|
|
209
|
+
agent-sdk github replay https://github.com/acme/checkout/pull/42 --dir . --action opened
|
|
281
210
|
```
|
|
282
211
|
|
|
283
|
-
Open the playground and confirm `Review acme/checkout#42`
|
|
284
|
-
trigger, both tool calls, and the verdict.
|
|
212
|
+
Open the playground and confirm `Review acme/checkout#42` shows both tool calls and the verdict.
|
|
285
213
|
|
|
286
|
-
##
|
|
214
|
+
## Deploy the reviewer
|
|
287
215
|
|
|
288
|
-
|
|
289
|
-
```text
|
|
290
|
-
agent-sdk run --dir . --message "Review https://github.com/acme/checkout/pull/42"
|
|
291
|
-
```
|
|
292
|
-
2. **Local replay**
|
|
293
|
-
```text
|
|
294
|
-
agent-sdk github replay https://github.com/acme/checkout/pull/42 \
|
|
295
|
-
--dir . --action opened
|
|
296
|
-
```
|
|
216
|
+
Follow [Deployment](/docs/deployment.md) to run `agent-sdk deploy`, then manage the reviewer in [Deployed Agents](https://cursor.com/dashboard/deployed-agents).
|
|
297
217
|
|
|
298
218
|
## Where to go next
|
|
299
219
|
|
|
300
|
-
-
|
|
301
|
-
|
|
302
|
-
- [
|
|
303
|
-
and direct calls
|
|
304
|
-
- [GitHub](/docs/guides/github.md): fixtures, forwarding, and pulling
|
|
305
|
-
events from Cursor
|
|
306
|
-
- [Building agents with agents](/docs/building-with-agents.md): have a
|
|
307
|
-
coding agent extend the project for you
|
|
220
|
+
- Turn these two PRs into regression checks with [Evals](/docs/evals.md).
|
|
221
|
+
- Read about typed tools in [Tools](/docs/reference/tools.md).
|
|
222
|
+
- Set up fixtures and forwarding with the [GitHub guide](/docs/guides/github.md).
|