@cursor/july 0.1.113 → 0.2.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/dist/channels/slack/inbound.d.ts +7 -0
- package/dist/channels/slack/inbound.d.ts.map +1 -1
- package/dist/channels/slack/inbound.js +23 -0
- package/dist/channels/slack/slack-channel.d.ts.map +1 -1
- package/dist/channels/slack/slack-channel.js +83 -4
- package/dist/docs/404.html +2 -2
- package/dist/docs/assets/{app.CAeK13eM.js → app.9eAtsjAM.js} +4 -4
- package/dist/docs/assets/chunks/@localSearchIndexroot.DjNBgxTF.js +1 -0
- package/dist/docs/assets/chunks/{VPLocalSearchBox.C9LbPHod.js → VPLocalSearchBox.C9s69nxj.js} +1 -1
- package/dist/docs/assets/chunks/{arc.CmMq2zmS.js → arc.DmWDRaF-.js} +1 -1
- package/dist/docs/assets/chunks/{architectureDiagram-Q4EWVU46.CCXB8Uj5.js → architectureDiagram-Q4EWVU46.BE1Wj4f3.js} +1 -1
- package/dist/docs/assets/chunks/{baseUniq.CyQo6eLe.js → baseUniq.pmEZGnWu.js} +1 -1
- package/dist/docs/assets/chunks/{blockDiagram-DXYQGD6D.JYq6w91N.js → blockDiagram-DXYQGD6D.D6mM-5XN.js} +1 -1
- package/dist/docs/assets/chunks/{c4Diagram-AHTNJAMY.BRV8GPJJ.js → c4Diagram-AHTNJAMY.ZQYTPC1b.js} +1 -1
- package/dist/docs/assets/chunks/channel.BNF8VK-B.js +1 -0
- package/dist/docs/assets/chunks/{chunk-4BX2VUAB.Bv4ooYQR.js → chunk-4BX2VUAB.CKJ7gaK8.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-4TB4RGXK.t4JtKPcj.js → chunk-4TB4RGXK.CL61HnvB.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-55IACEB6.34lCHj9Y.js → chunk-55IACEB6.DsA4XA1m.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-EDXVE4YY.BSwrPNrt.js → chunk-EDXVE4YY.BODHCHFW.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-FMBD7UC4.Beeun-R-.js → chunk-FMBD7UC4.D6NBaZTa.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-OYMX7WX6.BUUFUcJc.js → chunk-OYMX7WX6.BLPuqFXg.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-QZHKN3VN.B2XjHzN_.js → chunk-QZHKN3VN.BFs_ML8Z.js} +1 -1
- package/dist/docs/assets/chunks/{chunk-YZCP3GAM.CLYG8znk.js → chunk-YZCP3GAM.BDjuFyZv.js} +1 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.iViHzfrK.js +1 -0
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.iViHzfrK.js +1 -0
- package/dist/docs/assets/chunks/clone.CJoR2BBM.js +1 -0
- package/dist/docs/assets/chunks/{cose-bilkent-S5V4N54A.DVEa6fZp.js → cose-bilkent-S5V4N54A.D85HNEsi.js} +1 -1
- package/dist/docs/assets/chunks/{dagre-KV5264BT.C9PZQK-S.js → dagre-KV5264BT.V463KlSF.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-5BDNPKRD.DoN0uv3Y.js → diagram-5BDNPKRD.DhBDu1ab.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-G4DWMVQ6.Czv3duqx.js → diagram-G4DWMVQ6.v6sC68zl.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-MMDJMWI5.BinJ5kWb.js → diagram-MMDJMWI5.DhHsdXYv.js} +1 -1
- package/dist/docs/assets/chunks/{diagram-TYMM5635.DW326M4K.js → diagram-TYMM5635.BPWNSFZc.js} +1 -1
- package/dist/docs/assets/chunks/{erDiagram-SMLLAGMA.U2pR_OA7.js → erDiagram-SMLLAGMA.Cq0wTMPL.js} +1 -1
- package/dist/docs/assets/chunks/{flowDiagram-DWJPFMVM.ByWJXeYK.js → flowDiagram-DWJPFMVM.MveMtucC.js} +1 -1
- package/dist/docs/assets/chunks/{ganttDiagram-T4ZO3ILL.OquF0Rtg.js → ganttDiagram-T4ZO3ILL.BzKfGUSf.js} +1 -1
- package/dist/docs/assets/chunks/{gitGraphDiagram-UUTBAWPF.Bpn01P7X.js → gitGraphDiagram-UUTBAWPF.OToXTSW_.js} +1 -1
- package/dist/docs/assets/chunks/{graph.CNRB6ETL.js → graph.D82tam-l.js} +1 -1
- package/dist/docs/assets/chunks/{infoDiagram-42DDH7IO.CqhknMWi.js → infoDiagram-42DDH7IO.DzFlRmcE.js} +1 -1
- package/dist/docs/assets/chunks/{ishikawaDiagram-UXIWVN3A.C6xpR2af.js → ishikawaDiagram-UXIWVN3A.CVPRJiKe.js} +1 -1
- package/dist/docs/assets/chunks/{journeyDiagram-VCZTEJTY.Cg5f7oB3.js → journeyDiagram-VCZTEJTY.CQvNTfQC.js} +1 -1
- package/dist/docs/assets/chunks/{kanban-definition-6JOO6SKY.Cx9YTwlU.js → kanban-definition-6JOO6SKY.BwywywUl.js} +1 -1
- package/dist/docs/assets/chunks/{layout.ljS-wFtK.js → layout.C4BkPPba.js} +1 -1
- package/dist/docs/assets/chunks/{linear.jSxNrsFC.js → linear.FoSfGKD4.js} +1 -1
- package/dist/docs/assets/chunks/{min.Cum8AlQw.js → min.yLh8jqfl.js} +1 -1
- package/dist/docs/assets/chunks/{mindmap-definition-QFDTVHPH.BLiysLpe.js → mindmap-definition-QFDTVHPH.C9Dq2_CN.js} +1 -1
- package/dist/docs/assets/chunks/{pieDiagram-DEJITSTG.BoIDyuKF.js → pieDiagram-DEJITSTG.CiGyBcES.js} +1 -1
- package/dist/docs/assets/chunks/{quadrantDiagram-34T5L4WZ.DLkpDytR.js → quadrantDiagram-34T5L4WZ.1FWea9nj.js} +1 -1
- package/dist/docs/assets/chunks/{requirementDiagram-MS252O5E.DqTVqSu2.js → requirementDiagram-MS252O5E.B1q7ntiV.js} +1 -1
- package/dist/docs/assets/chunks/{sankeyDiagram-XADWPNL6.CG_6FF7j.js → sankeyDiagram-XADWPNL6.Cpr4oU_k.js} +1 -1
- package/dist/docs/assets/chunks/{sequenceDiagram-FGHM5R23.BIp9602K.js → sequenceDiagram-FGHM5R23.CUK68STn.js} +1 -1
- package/dist/docs/assets/chunks/{stateDiagram-FHFEXIEX.COSXsD9I.js → stateDiagram-FHFEXIEX.zU0yL2m4.js} +1 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.nV8Nl-td.js +1 -0
- package/dist/docs/assets/chunks/{theme.CXJ7PNwy.js → theme.DhnKd0CD.js} +2 -2
- package/dist/docs/assets/chunks/{timeline-definition-GMOUNBTQ.CXdVqkLq.js → timeline-definition-GMOUNBTQ.CNYoXo3F.js} +1 -1
- package/dist/docs/assets/chunks/{vennDiagram-DHZGUBPP.CZxGuc4r.js → vennDiagram-DHZGUBPP.DFWH3G9s.js} +1 -1
- package/dist/docs/assets/chunks/{wardley-RL74JXVD.3oVgfqQk.js → wardley-RL74JXVD.Do4PwzeN.js} +1 -1
- package/dist/docs/assets/chunks/{wardleyDiagram-NUSXRM2D.6_irCgGJ.js → wardleyDiagram-NUSXRM2D.7WLkqM7s.js} +1 -1
- package/dist/docs/assets/chunks/{xychartDiagram-5P7HB3ND.TRPe92m3.js → xychartDiagram-5P7HB3ND.-SyUNgWw.js} +1 -1
- package/dist/docs/assets/{deployment.md.D2jQZuFx.js → deployment.md.D2YX7u_I.js} +1 -1
- package/dist/docs/assets/{guides_agent-to-agent.md.CD4T5FIl.js → guides_agent-to-agent.md.C6kPY8nu.js} +2 -2
- package/dist/docs/assets/{guides_cloud-agents.md.Cp1O3u-X.js → guides_cloud-agents.md.BPJqTZjT.js} +1 -1
- package/dist/docs/assets/{guides_grokbot-agents.md.CMhZNdEU.js → guides_grokbot-agents.md.CzV715v8.js} +1 -1
- package/dist/docs/assets/guides_hooks.md.BT9GLwEp.js +50 -0
- package/dist/docs/assets/guides_hooks.md.BT9GLwEp.lean.js +1 -0
- package/dist/docs/assets/{guides_jev.md.F5fAkkfN.js → guides_jev.md.DeSCqMaO.js} +6 -44
- package/dist/docs/assets/guides_jev.md.DeSCqMaO.lean.js +1 -0
- package/dist/docs/assets/{guides_slack.md.Bo96y42E.js → guides_slack.md.DVjNyqq5.js} +3 -3
- package/dist/docs/assets/{guides_slack.md.Bo96y42E.lean.js → guides_slack.md.DVjNyqq5.lean.js} +1 -1
- package/dist/docs/assets/reference_agent-config.md.BRxAlnRy.js +36 -0
- package/dist/docs/assets/{reference_agent-config.md.DGPyw7ms.lean.js → reference_agent-config.md.BRxAlnRy.lean.js} +1 -1
- package/dist/docs/assets/reference_artifacts.md.KRX0sAdt.js +18 -0
- package/dist/docs/assets/reference_artifacts.md.KRX0sAdt.lean.js +1 -0
- package/dist/docs/assets/reference_channels.md.DZr14vm7.js +23 -0
- package/dist/docs/assets/reference_channels.md.DZr14vm7.lean.js +1 -0
- package/dist/docs/assets/reference_cli.md.BvnQM8wd.js +97 -0
- package/dist/docs/assets/reference_cli.md.BvnQM8wd.lean.js +1 -0
- package/dist/docs/assets/{reference_connections.md.Je9dMsdd.js → reference_connections.md.DJGUCxrr.js} +18 -30
- package/dist/docs/assets/{reference_connections.md.Je9dMsdd.lean.js → reference_connections.md.DJGUCxrr.lean.js} +1 -1
- package/dist/docs/assets/{reference_evals.md.DNJzM_yf.js → reference_evals.md.C6umwNC6.js} +6 -7
- package/dist/docs/assets/reference_evals.md.C6umwNC6.lean.js +1 -0
- package/dist/docs/assets/{reference_extensions.md.Cv5aLCz_.js → reference_extensions.md.DbNYu-DP.js} +3 -3
- package/dist/docs/assets/{reference_extensions.md.Cv5aLCz_.lean.js → reference_extensions.md.DbNYu-DP.lean.js} +1 -1
- package/dist/docs/assets/reference_hooks.md.BfOkhTU0.js +45 -0
- package/dist/docs/assets/{reference_hooks.md.B7uzNENk.lean.js → reference_hooks.md.BfOkhTU0.lean.js} +1 -1
- package/dist/docs/assets/reference_http-api.md.DdwtBeCj.js +11 -0
- package/dist/docs/assets/{reference_http-api.md.CduHavZ2.lean.js → reference_http-api.md.DdwtBeCj.lean.js} +1 -1
- package/dist/docs/assets/reference_instructions.md.B2mcIzT6.js +14 -0
- package/dist/docs/assets/reference_instructions.md.B2mcIzT6.lean.js +1 -0
- package/dist/docs/assets/reference_playground.md.CyrQD_n3.js +1 -0
- package/dist/docs/assets/reference_playground.md.CyrQD_n3.lean.js +1 -0
- package/dist/docs/assets/reference_project-layout.md.BEMzxAkq.js +19 -0
- package/dist/docs/assets/{reference_project-layout.md.BGhgpy9V.lean.js → reference_project-layout.md.BEMzxAkq.lean.js} +1 -1
- package/dist/docs/assets/reference_prompt.md.BFrqjHFL.js +9 -0
- package/dist/docs/assets/reference_prompt.md.BFrqjHFL.lean.js +1 -0
- package/dist/docs/assets/reference_schedules.md.BB9N3tRR.js +47 -0
- package/dist/docs/assets/reference_schedules.md.BB9N3tRR.lean.js +1 -0
- package/dist/docs/assets/reference_sessions.md.BBp-GIt-.js +1 -0
- package/dist/docs/assets/{reference_sessions.md.1_6Vyv7x.lean.js → reference_sessions.md.BBp-GIt-.lean.js} +1 -1
- package/dist/docs/assets/reference_skills.md.BVmi3UJ_.js +15 -0
- package/dist/docs/assets/{reference_skills.md.DjQkRefx.lean.js → reference_skills.md.BVmi3UJ_.lean.js} +1 -1
- package/dist/docs/assets/reference_subagents.md.DRoRy2Uj.js +10 -0
- package/dist/docs/assets/{reference_subagents.md.Dl16gcBj.lean.js → reference_subagents.md.DRoRy2Uj.lean.js} +1 -1
- package/dist/docs/assets/{reference_tools.md.B1dH1lpa.js → reference_tools.md.CgocLDX1.js} +9 -6
- package/dist/docs/assets/{reference_tools.md.B1dH1lpa.lean.js → reference_tools.md.CgocLDX1.lean.js} +1 -1
- package/dist/docs/assets/troubleshooting.md.HY95rCCz.js +1 -0
- package/dist/docs/building-with-agents.html +35 -35
- package/dist/docs/deployment.html +37 -37
- package/dist/docs/deployment.md +1 -1
- package/dist/docs/evals.html +35 -35
- package/dist/docs/guides/agent-to-agent.html +38 -38
- package/dist/docs/guides/agent-to-agent.md +11 -12
- package/dist/docs/guides/bitbucket.html +35 -35
- package/dist/docs/guides/cloud-agents.html +36 -36
- package/dist/docs/guides/cloud-agents.md +1 -1
- 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/grokbot-agents.html +37 -37
- package/dist/docs/guides/grokbot-agents.md +1 -1
- package/dist/docs/guides/hooks.html +109 -0
- package/dist/docs/guides/hooks.md +111 -0
- package/dist/docs/guides/improve.html +35 -35
- package/dist/docs/guides/jev.html +42 -80
- package/dist/docs/guides/jev.md +22 -79
- package/dist/docs/guides/mcp-oauth.html +36 -36
- package/dist/docs/guides/opentelemetry.html +35 -35
- package/dist/docs/guides/slack.html +37 -37
- package/dist/docs/guides/slack.md +7 -0
- package/dist/docs/guides/webhooks.html +35 -35
- 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 +1683 -2054
- package/dist/docs/llms.txt +9 -8
- package/dist/docs/quickstart.html +35 -35
- package/dist/docs/reference/agent-config.html +42 -46
- package/dist/docs/reference/agent-config.md +48 -81
- package/dist/docs/reference/artifacts.html +39 -40
- package/dist/docs/reference/artifacts.md +71 -70
- package/dist/docs/reference/channels.html +41 -61
- package/dist/docs/reference/channels.md +134 -201
- package/dist/docs/reference/cli.html +127 -125
- package/dist/docs/reference/cli.md +685 -753
- package/dist/docs/reference/connections.html +54 -66
- package/dist/docs/reference/connections.md +92 -128
- package/dist/docs/reference/evals.html +42 -43
- package/dist/docs/reference/evals.md +42 -50
- package/dist/docs/reference/extensions.html +38 -38
- package/dist/docs/reference/extensions.md +9 -13
- package/dist/docs/reference/hooks.html +39 -67
- package/dist/docs/reference/hooks.md +72 -146
- package/dist/docs/reference/http-api.html +39 -39
- package/dist/docs/reference/http-api.md +137 -161
- package/dist/docs/reference/instructions.html +39 -39
- package/dist/docs/reference/instructions.md +21 -36
- package/dist/docs/reference/playground.html +36 -36
- package/dist/docs/reference/playground.md +26 -43
- package/dist/docs/reference/project-layout.html +38 -38
- package/dist/docs/reference/project-layout.md +12 -17
- package/dist/docs/reference/prompt.html +42 -42
- package/dist/docs/reference/prompt.md +18 -13
- package/dist/docs/reference/schedules.html +56 -91
- package/dist/docs/reference/schedules.md +52 -99
- package/dist/docs/reference/sessions.html +36 -36
- package/dist/docs/reference/sessions.md +36 -40
- package/dist/docs/reference/skills.html +38 -38
- package/dist/docs/reference/skills.md +15 -26
- package/dist/docs/reference/subagents.html +38 -38
- package/dist/docs/reference/subagents.md +20 -30
- package/dist/docs/reference/tools.html +44 -41
- package/dist/docs/reference/tools.md +45 -64
- package/dist/docs/templates/agentic-owners.html +35 -35
- package/dist/docs/templates/pr-autofixer.html +35 -35
- package/dist/docs/templates/security-reviewer.html +35 -35
- package/dist/docs/templates/thermo-quality-review.html +35 -35
- package/dist/docs/templates/thermo-review.html +35 -35
- package/dist/docs/templates/triage.html +35 -35
- package/dist/docs/troubleshooting.html +36 -36
- package/dist/docs/troubleshooting.md +1 -1
- package/dist/internal/cli-deploy.d.ts.map +1 -1
- package/dist/internal/cli-deploy.js +9 -1
- package/dist/internal/deploy-client.d.ts +6 -0
- package/dist/internal/deploy-client.d.ts.map +1 -1
- package/dist/internal/deploy-client.js +3 -0
- package/dist/internal/discovery/agent-config.d.ts +3 -1
- package/dist/internal/discovery/agent-config.d.ts.map +1 -1
- package/dist/internal/discovery/agent-config.js +7 -4
- package/dist/internal/framework-storage-selection.d.ts +1 -1
- package/dist/internal/framework-storage-selection.d.ts.map +1 -1
- package/dist/internal/platform-timers.d.ts.map +1 -1
- package/dist/internal/platform-timers.js +20 -2
- package/dist/internal/reminder-runner.d.ts +79 -1
- package/dist/internal/reminder-runner.d.ts.map +1 -1
- package/dist/internal/reminder-runner.js +276 -44
- package/dist/internal/server.d.ts.map +1 -1
- package/dist/internal/server.js +7 -0
- package/dist/memory.d.ts +4 -0
- package/dist/memory.d.ts.map +1 -1
- package/dist/memory.js +28 -4
- package/dist/playground/assets/index-DLwnR9ys.css +1 -0
- package/dist/playground/index.html +2 -2
- package/dist/types.d.ts +16 -9
- package/dist/types.d.ts.map +1 -1
- package/docs/deployment.md +1 -1
- package/docs/guides/agent-to-agent.md +11 -12
- package/docs/guides/cloud-agents.md +1 -1
- package/docs/guides/grokbot-agents.md +1 -1
- package/docs/guides/hooks.md +116 -0
- package/docs/guides/jev.md +23 -80
- package/docs/guides/slack.md +7 -0
- package/docs/reference/agent-config.md +48 -81
- package/docs/reference/artifacts.md +72 -71
- package/docs/reference/channels.md +135 -202
- package/docs/reference/cli.md +686 -754
- package/docs/reference/connections.md +93 -129
- package/docs/reference/evals.md +43 -51
- package/docs/reference/extensions.md +9 -13
- package/docs/reference/hooks.md +72 -146
- package/docs/reference/http-api.md +137 -161
- package/docs/reference/instructions.md +22 -37
- package/docs/reference/playground.md +26 -43
- package/docs/reference/project-layout.md +12 -17
- package/docs/reference/prompt.md +20 -15
- package/docs/reference/schedules.md +52 -99
- package/docs/reference/sessions.md +36 -40
- package/docs/reference/skills.md +15 -26
- package/docs/reference/subagents.md +20 -30
- package/docs/reference/tools.md +45 -64
- package/docs/troubleshooting.md +1 -1
- package/package.json +1 -1
- package/src/channels/slack/inbound.ts +24 -0
- package/src/channels/slack/slack-channel.ts +123 -1
- package/src/internal/cli-deploy.ts +12 -1
- package/src/internal/deploy-client.ts +9 -0
- package/src/internal/discovery/agent-config.ts +8 -6
- package/src/internal/framework-storage-selection.ts +1 -1
- package/src/internal/platform-timers.ts +24 -2
- package/src/internal/reminder-runner.ts +426 -63
- package/src/internal/server.ts +8 -0
- package/src/memory.ts +37 -3
- package/src/types.ts +16 -9
- package/dist/docs/assets/chunks/@localSearchIndexroot.Ck9E52Ls.js +0 -1
- package/dist/docs/assets/chunks/channel.BHiYmnZ4.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-6PBFFD2Q.Degh8l90.js +0 -1
- package/dist/docs/assets/chunks/classDiagram-v2-HSJHXN6E.Degh8l90.js +0 -1
- package/dist/docs/assets/chunks/clone.BIywbczV.js +0 -1
- package/dist/docs/assets/chunks/stateDiagram-v2-QKLJ7IA2.qrxrbFsX.js +0 -1
- package/dist/docs/assets/guides_jev.md.F5fAkkfN.lean.js +0 -1
- package/dist/docs/assets/reference_agent-config.md.DGPyw7ms.js +0 -40
- package/dist/docs/assets/reference_artifacts.md.Bu_4HmsD.js +0 -19
- package/dist/docs/assets/reference_artifacts.md.Bu_4HmsD.lean.js +0 -1
- package/dist/docs/assets/reference_channels.md.nFWbzAic.js +0 -43
- package/dist/docs/assets/reference_channels.md.nFWbzAic.lean.js +0 -1
- package/dist/docs/assets/reference_cli.md.DLWDz9ij.js +0 -95
- package/dist/docs/assets/reference_cli.md.DLWDz9ij.lean.js +0 -1
- package/dist/docs/assets/reference_evals.md.DNJzM_yf.lean.js +0 -1
- package/dist/docs/assets/reference_hooks.md.B7uzNENk.js +0 -73
- package/dist/docs/assets/reference_http-api.md.CduHavZ2.js +0 -11
- package/dist/docs/assets/reference_instructions.md.CU1My5My.js +0 -14
- package/dist/docs/assets/reference_instructions.md.CU1My5My.lean.js +0 -1
- package/dist/docs/assets/reference_playground.md.Ch2d0Iqi.js +0 -1
- package/dist/docs/assets/reference_playground.md.Ch2d0Iqi.lean.js +0 -1
- package/dist/docs/assets/reference_project-layout.md.BGhgpy9V.js +0 -19
- package/dist/docs/assets/reference_prompt.md.Ccp0R53H.js +0 -1
- package/dist/docs/assets/reference_prompt.md.Ccp0R53H.lean.js +0 -1
- package/dist/docs/assets/reference_schedules.md.B2Nm6FaD.js +0 -82
- package/dist/docs/assets/reference_schedules.md.B2Nm6FaD.lean.js +0 -1
- package/dist/docs/assets/reference_sessions.md.1_6Vyv7x.js +0 -1
- package/dist/docs/assets/reference_skills.md.DjQkRefx.js +0 -15
- package/dist/docs/assets/reference_subagents.md.Dl16gcBj.js +0 -10
- package/dist/docs/assets/troubleshooting.md.mnfFG2Em.js +0 -1
- package/dist/playground/assets/index-DSMAewbx.css +0 -1
- /package/dist/docs/assets/{deployment.md.D2jQZuFx.lean.js → deployment.md.D2YX7u_I.lean.js} +0 -0
- /package/dist/docs/assets/{guides_agent-to-agent.md.CD4T5FIl.lean.js → guides_agent-to-agent.md.C6kPY8nu.lean.js} +0 -0
- /package/dist/docs/assets/{guides_cloud-agents.md.Cp1O3u-X.lean.js → guides_cloud-agents.md.BPJqTZjT.lean.js} +0 -0
- /package/dist/docs/assets/{guides_grokbot-agents.md.CMhZNdEU.lean.js → guides_grokbot-agents.md.CzV715v8.lean.js} +0 -0
- /package/dist/docs/assets/{troubleshooting.md.mnfFG2Em.lean.js → troubleshooting.md.HY95rCCz.lean.js} +0 -0
- /package/dist/playground/assets/{index-De_lpFxE.js → index-CX6oTKwz.js} +0 -0
|
@@ -3,34 +3,33 @@ title: "HTTP API"
|
|
|
3
3
|
description: "Public session, discovery, and channel routes callers use."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
# HTTP API
|
|
7
|
-
|
|
8
|
-
Agent SDK hosts expose
|
|
9
|
-
multi-agent layout each agent
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
|
29
|
-
|
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
| `GET /v1/health` | Host-level liveness, no auth |
|
|
6
|
+
# HTTP API
|
|
7
|
+
|
|
8
|
+
Agent SDK hosts expose one public HTTP surface. In the default
|
|
9
|
+
multi-agent layout, each agent uses `/<slug>/v1/*`; `--mode single`
|
|
10
|
+
serves the same routes at `/v1/*`. Routes use the agent's HTTP auth
|
|
11
|
+
chain, and session-owned resources return `403` to another principal.
|
|
12
|
+
|
|
13
|
+
Unless a section says otherwise, the default auth policy is
|
|
14
|
+
`localDevStrict()`. `--bearer-token` replaces it with bearer auth, and
|
|
15
|
+
`--allow-anonymous` replaces it with anonymous access. Built-in JSON
|
|
16
|
+
routes use `{ ok: false, error: "<code>", message? }` for errors; MCP
|
|
17
|
+
uses JSON-RPC, and custom channel handlers define their own responses.
|
|
18
|
+
|
|
19
|
+
## Host routes
|
|
20
|
+
|
|
21
|
+
These routes live at the host root in multi-agent mode. The index routes
|
|
22
|
+
exist only when the playground is enabled.
|
|
23
|
+
|
|
24
|
+
| Route | Contract |
|
|
25
|
+
| --- | --- |
|
|
26
|
+
| `GET /` | HTML index of mounted agents; no auth |
|
|
27
|
+
| `GET /v1/agents` | JSON index of mounted agents; no auth |
|
|
28
|
+
| `GET /docs`, `GET /docs/*` | Documentation site in either layout; no auth |
|
|
29
|
+
| `GET /v1/health` | Host liveness; no auth |
|
|
30
|
+
|
|
31
|
+
`--no-playground` removes the two index routes. `--no-docs` removes the
|
|
32
|
+
documentation site.
|
|
34
33
|
|
|
35
34
|
## Start a session
|
|
36
35
|
|
|
@@ -44,18 +43,18 @@ curl -X POST http://127.0.0.1:3000/<slug>/v1/session \
|
|
|
44
43
|
# "playgroundUrl":"…?sessionId=ses_…","traceUrl":"…/v1/session/ses_…/events"}
|
|
45
44
|
```
|
|
46
45
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
and `playgroundUrl` deep-links the session in the playground.
|
|
46
|
+
Once accepted, the response returns `sessionId` for inspection and
|
|
47
|
+
`continuationToken` for follow-ups; follow the stream for progress.
|
|
50
48
|
|
|
51
|
-
| Body field |
|
|
49
|
+
| Body field | Contract |
|
|
52
50
|
| --- | --- |
|
|
53
51
|
| `message` | Required user message |
|
|
54
|
-
| `title` |
|
|
52
|
+
| `title` | Display title |
|
|
55
53
|
| `dryRun` | Run read tools and stub write tools |
|
|
56
|
-
| `asOf` | ISO-8601 instant with a timezone
|
|
57
|
-
| `workspaceFiles` |
|
|
54
|
+
| `asOf` | ISO-8601 instant with a timezone; sets `ctx.now()` and rejects omitted, relative, or later declared tool time arguments. Invalid values return `400` |
|
|
55
|
+
| `workspaceFiles` | Relative files added to the session workspace |
|
|
58
56
|
| `cloud` | Per-session cloud options merged over the agent defaults |
|
|
57
|
+
| `purpose` | Use `"eval"` to mark regression traffic |
|
|
59
58
|
|
|
60
59
|
## Send a follow-up
|
|
61
60
|
|
|
@@ -67,15 +66,15 @@ curl -X POST http://127.0.0.1:3000/<slug>/v1/session/ses_… \
|
|
|
67
66
|
-d '{"continuationToken":"http:…","message":"Make it shorter."}'
|
|
68
67
|
```
|
|
69
68
|
|
|
70
|
-
|
|
71
|
-
Each accepted follow-up rotates the token
|
|
72
|
-
|
|
73
|
-
|
|
69
|
+
The route accepts any chat session, including one created by a custom
|
|
70
|
+
channel. Each accepted follow-up rotates the continuation token and
|
|
71
|
+
returns the replacement. A message sent to a busy session interrupts
|
|
72
|
+
the active turn before starting.
|
|
74
73
|
|
|
75
|
-
|
|
76
|
-
|
|
74
|
+
The route returns `409` for a stale token or task session, and `403`
|
|
75
|
+
when the caller doesn't own the session.
|
|
77
76
|
|
|
78
|
-
## Stream
|
|
77
|
+
## Stream or replay session events
|
|
79
78
|
|
|
80
79
|
`GET /v1/session/:sessionId/stream` is the live NDJSON feed.
|
|
81
80
|
|
|
@@ -83,44 +82,36 @@ follow-ups. Expect `403` when the caller is not the session owner.
|
|
|
83
82
|
curl -N 'http://127.0.0.1:3000/<slug>/v1/session/ses_…/stream?startIndex=0'
|
|
84
83
|
```
|
|
85
84
|
|
|
86
|
-
|
|
87
|
-
default
|
|
88
|
-
|
|
89
|
-
resume without duplicates. The stream is durable and reconnectable. For
|
|
90
|
-
the vocabulary, see
|
|
91
|
-
[Sessions](./sessions.md#which-events-can-i-stream).
|
|
85
|
+
The route replays one event per line from `startIndex`, then follows new
|
|
86
|
+
events. The default `0` replays the full stream. To reconnect without
|
|
87
|
+
duplicates, pass the last index you received plus one.
|
|
92
88
|
|
|
93
89
|
`GET /v1/session/:sessionId/events` returns a one-shot NDJSON dump.
|
|
94
|
-
Pass `?format=json` for `{ sessionId, events, playgroundUrl }`.
|
|
95
|
-
|
|
96
|
-
## Stop and list
|
|
97
|
-
|
|
98
|
-
`POST /v1/session/:sessionId/stop` interrupts the in-flight turn without
|
|
99
|
-
sending a new message. `GET /v1/sessions` lists sessions owned by the
|
|
100
|
-
calling principal. Under `serve --dev` on loopback it includes all
|
|
101
|
-
sessions, which is how webhook and schedule sessions show up in the
|
|
102
|
-
playground.
|
|
90
|
+
Pass `?format=json` for `{ sessionId, events, playgroundUrl }`. See
|
|
91
|
+
[Stream events](./sessions.md#stream-events) for the event vocabulary.
|
|
103
92
|
|
|
104
|
-
##
|
|
93
|
+
## Manage sessions
|
|
105
94
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
`
|
|
109
|
-
|
|
110
|
-
|
|
95
|
+
| Route | Contract |
|
|
96
|
+
| --- | --- |
|
|
97
|
+
| `POST /v1/session/:sessionId/stop` | Interrupt the active turn without sending another message |
|
|
98
|
+
| `GET /v1/sessions` | List sessions owned by the caller |
|
|
99
|
+
| `GET /v1/session/:sessionId/cost` | Return per-turn token usage and estimated cost |
|
|
111
100
|
|
|
112
|
-
|
|
101
|
+
On loopback under `serve --dev`, the session list includes every
|
|
102
|
+
principal so webhook and schedule sessions appear in the playground.
|
|
103
|
+
The cost route returns `404` for an unknown session.
|
|
113
104
|
|
|
114
|
-
|
|
105
|
+
## Resolve tool approvals
|
|
115
106
|
|
|
116
|
-
| Route
|
|
117
|
-
|
|
|
118
|
-
| `GET /v1/session/:sessionId/approvals`
|
|
119
|
-
| `POST /v1/session/:sessionId/approvals/:callId` | Resolve one
|
|
107
|
+
| Route | Contract |
|
|
108
|
+
| --- | --- |
|
|
109
|
+
| `GET /v1/session/:sessionId/approvals` | List pending tool approvals |
|
|
110
|
+
| `POST /v1/session/:sessionId/approvals/:callId` | Resolve one with `{"decision":"approve"}` or `{"decision":"deny"}` |
|
|
120
111
|
|
|
121
112
|
For the lifecycle, see [Gate a tool on human approval](./tools.md#gate-a-tool-on-human-approval).
|
|
122
113
|
|
|
123
|
-
## Call a tool
|
|
114
|
+
## Call a tool without a model turn
|
|
124
115
|
|
|
125
116
|
`POST /v1/tools/:toolName` runs a server tool with no model turn.
|
|
126
117
|
|
|
@@ -132,130 +123,115 @@ curl -X POST http://127.0.0.1:3000/<slug>/v1/tools/inspect_pr \
|
|
|
132
123
|
# "isError":false,"result":{…},"durationMs":12}
|
|
133
124
|
```
|
|
134
125
|
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
unknown tools with `404` and the list of available names. For the
|
|
141
|
-
semantics, see [Tools](./tools.md#call-a-tool-without-a-model-turn).
|
|
126
|
+
| Body field | Contract |
|
|
127
|
+
| --- | --- |
|
|
128
|
+
| `input` | Tool input; defaults to `{}` |
|
|
129
|
+
| `sessionId` | Bind the call to an existing session |
|
|
130
|
+
| `continuationToken` | Bind the call by its wire continuation token; mutually exclusive with `sessionId` |
|
|
142
131
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
[Tools](./tools.md#call-a-tool-without-a-model-turn).
|
|
132
|
+
Omit both identifiers for an unbound call. Agent-execution tools return
|
|
133
|
+
`400`, and an unknown name returns `404` with the available names. See
|
|
134
|
+
[Tools](./tools.md#call-a-tool-without-a-model-turn) for session
|
|
135
|
+
binding, busy-session rules, and error codes.
|
|
148
136
|
|
|
149
|
-
## Discovery
|
|
137
|
+
## Discovery routes
|
|
150
138
|
|
|
151
139
|
These read-only routes describe the running agent.
|
|
152
140
|
|
|
153
|
-
| Route
|
|
154
|
-
|
|
|
155
|
-
| `GET /v1/info`
|
|
156
|
-
| `GET /v1/tools`
|
|
157
|
-
| `GET /v1/tools/:name`
|
|
158
|
-
| `GET /v1/health`
|
|
159
|
-
| `GET /v1/logs?after=N` |
|
|
141
|
+
| Route | Contract |
|
|
142
|
+
| --- | --- |
|
|
143
|
+
| `GET /v1/info` | Return the discovered model, tools, skills, connections, subagents, channels, schedules, hooks, and diagnostics |
|
|
144
|
+
| `GET /v1/tools` | Return live server tools and advertised MCP tools as `{ name, title?, source? }`; bind tenant-scoped listings with `session` or `continuationToken` |
|
|
145
|
+
| `GET /v1/tools/:name` | Return one tool's description, execution mode, approval and effect rules, schemas, and source |
|
|
146
|
+
| `GET /v1/health` | Return per-agent liveness; no auth |
|
|
147
|
+
| `GET /v1/logs?after=N` | Return recent server logs and the next polling cursor |
|
|
160
148
|
|
|
161
|
-
|
|
149
|
+
An unknown tool name returns `404` with available names. If an MCP
|
|
150
|
+
connection can't list its tools, the catalog skips that connection and
|
|
151
|
+
includes it in `connectionErrors`.
|
|
162
152
|
|
|
163
|
-
|
|
164
|
-
`tag_artifact`. See [Artifacts](./artifacts.md).
|
|
153
|
+
## List and download artifacts
|
|
165
154
|
|
|
166
|
-
| Route
|
|
167
|
-
|
|
|
168
|
-
| `GET /v1/artifacts`
|
|
169
|
-
| `GET /v1/artifacts/:id/content`
|
|
155
|
+
| Route | Contract |
|
|
156
|
+
| --- | --- |
|
|
157
|
+
| `GET /v1/artifacts` | Return `{ artifacts }`, newest-updated first; filter with `kind`, `sessionId`, and a positive `limit` |
|
|
158
|
+
| `GET /v1/artifacts/:id/content` | Download an artifact's file or blob as an attachment; return `404` when no content exists |
|
|
170
159
|
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
principals, while bearer or custom channel auth keeps strict
|
|
174
|
-
per-principal isolation.
|
|
160
|
+
The list follows the same ownership rules as `GET /v1/sessions`. See
|
|
161
|
+
[Artifacts](./artifacts.md) for tagging and record fields.
|
|
175
162
|
|
|
176
|
-
##
|
|
163
|
+
## Call custom channel routes
|
|
177
164
|
|
|
178
|
-
Authored routes mount under `/v1/channels/<id>` with
|
|
179
|
-
and Zod
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
applies. The GitHub channel verifies `X-Hub-Signature-256` when a
|
|
183
|
-
secret is configured. See [Channels](./channels.md).
|
|
165
|
+
Authored routes mount under `/v1/channels/<id>` with their declared
|
|
166
|
+
methods and paths. The host validates their Zod body and query schemas
|
|
167
|
+
before calling the handler, returning `400` on failure. Each channel's
|
|
168
|
+
auth chain applies. See [Channels](./channels.md).
|
|
184
169
|
|
|
185
170
|
## MCP endpoint
|
|
186
171
|
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
spec-compliant 405s). The tools are `ask` (delegate a message, bounded
|
|
190
|
-
waits), `check` (poll a running session), and `call_tool` (deterministic
|
|
191
|
-
server-tool passthrough, present when the agent has server tools). The
|
|
192
|
-
route runs the same auth chain as the session API. Peer wiring:
|
|
193
|
-
[MCP connections](./connections.md#peer-mcp-connection).
|
|
172
|
+
Both MCP routes use stateless streamable HTTP. Send protocol requests
|
|
173
|
+
with `POST`; `GET` and `DELETE` return `405`.
|
|
194
174
|
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
`/v1/mcp
|
|
199
|
-
|
|
175
|
+
| Route | Tools and auth |
|
|
176
|
+
| --- | --- |
|
|
177
|
+
| `/v1/mcp` | `ask`, `check`, and `call_tool` when server tools exist; uses the session API auth chain |
|
|
178
|
+
| `/v1/mcp/tools` | Deterministic server tools only; uses the CLI-level loopback, bearer, or anonymous auth chain |
|
|
179
|
+
|
|
180
|
+
See [MCP connections](./connections.md#peer-mcp-connection) to connect
|
|
181
|
+
one agent to another.
|
|
200
182
|
|
|
201
183
|
## Playground eval routes
|
|
202
184
|
|
|
203
|
-
The playground Evals tab and
|
|
185
|
+
The playground Evals tab and remote eval commands use these routes:
|
|
204
186
|
|
|
205
|
-
| Route
|
|
206
|
-
|
|
|
207
|
-
| `GET /v1/dev/evals`
|
|
208
|
-
| `GET /v1/dev/evals/runs`
|
|
209
|
-
| `POST /v1/dev/evals/runs`
|
|
210
|
-
| `GET /v1/dev/evals/runs/:runId` |
|
|
211
|
-
| `POST /v1/dev/evals/runs/:runId/cancel` | Cancel
|
|
187
|
+
| Route | Contract |
|
|
188
|
+
| --- | --- |
|
|
189
|
+
| `GET /v1/dev/evals` | List discovered cases and eval config |
|
|
190
|
+
| `GET /v1/dev/evals/runs` | List recent run snapshots, newest first |
|
|
191
|
+
| `POST /v1/dev/evals/runs` | Start `{ filterIds?, tags?, timeoutMs?, verbose? }`; return `202`, `404` for no match, or `409` while another run is active |
|
|
192
|
+
| `GET /v1/dev/evals/runs/:runId` | Return progress and the final snapshot |
|
|
193
|
+
| `POST /v1/dev/evals/runs/:runId/cancel` | Cancel an active run; return `404` when unknown or `409` when no longer running |
|
|
212
194
|
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
use OR semantics. When both fields are present, a case must match one
|
|
217
|
-
entry from each field. Listed runs persist across restarts when
|
|
218
|
-
durable storage is configured. Otherwise they are
|
|
219
|
-
process-memory only.
|
|
195
|
+
Poll the run route until its status is `completed`, `failed`, or
|
|
196
|
+
`cancelled`. Entries within `filterIds` and `tags` use OR semantics;
|
|
197
|
+
when both fields are present, a case must match each group.
|
|
220
198
|
|
|
221
199
|
## Dev-mode routes
|
|
222
200
|
|
|
223
201
|
These routes exist only under `serve --dev`.
|
|
224
202
|
|
|
225
|
-
| Route
|
|
226
|
-
|
|
|
203
|
+
| Route | Contract |
|
|
204
|
+
| --- | --- |
|
|
227
205
|
| `POST /v1/dev/schedules/:scheduleId` | Dispatch a schedule by hand, exactly once. Returns `{scheduleId, sessionIds}` |
|
|
228
|
-
| `GET /v1/dev/reminders`
|
|
229
|
-
| `POST /v1/dev/reminders/:reminderId` | Fire a reminder by hand
|
|
206
|
+
| `GET /v1/dev/reminders` | List reminders |
|
|
207
|
+
| `POST /v1/dev/reminders/:reminderId` | Fire a reminder by hand |
|
|
230
208
|
|
|
231
209
|
Schedules and reminders never fire automatically in dev mode. These
|
|
232
|
-
routes
|
|
210
|
+
routes run them manually.
|
|
233
211
|
|
|
234
212
|
## Playground assets
|
|
235
213
|
|
|
236
214
|
`GET /playground` and `GET /playground/assets/:file` serve the
|
|
237
|
-
playground
|
|
238
|
-
above and has no privileged surface.
|
|
215
|
+
playground. `--no-playground` removes both routes.
|
|
239
216
|
|
|
240
217
|
## Status codes
|
|
241
218
|
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
| Code | Meaning here |
|
|
245
|
-
| ----- | -------------------------------------------------------------------------------------------------------------------------- |
|
|
246
|
-
| `400` | Schema-invalid body or query, agent-execution tool called on the host, malformed request |
|
|
247
|
-
| `401` | No auth policy admitted the request |
|
|
248
|
-
| `403` | Authenticated, but not the session owner |
|
|
249
|
-
| `404` | Unknown session, tool, schedule, reminder, or eval run; no eval datapoints match a run request |
|
|
250
|
-
| `405` | Wrong method (GET on the MCP endpoint, say) |
|
|
251
|
-
| `409` | Stale continuation token, a busy session-bound tool call, a non-followable task session, or an eval run already in progress |
|
|
252
|
-
| `202` | Accepted for background work (GitHub `{ task }` hooks, eval runs) |
|
|
253
|
-
|
|
254
|
-
## What's next
|
|
219
|
+
Built-in routes use these common status codes.
|
|
255
220
|
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
221
|
+
| Code | Meaning |
|
|
222
|
+
| --- | --- |
|
|
223
|
+
| `400` | Invalid body, query, tool input, or request shape |
|
|
224
|
+
| `401` | No auth policy admitted the request |
|
|
225
|
+
| `403` | The caller is authenticated but doesn't own the resource |
|
|
226
|
+
| `404` | A named resource doesn't exist, or an eval selection matches no cases |
|
|
227
|
+
| `405` | The route doesn't accept this method |
|
|
228
|
+
| `409` | The resource state rejects the request, such as a stale token or busy write |
|
|
229
|
+
| `202` | The request was accepted for asynchronous work |
|
|
230
|
+
| `500` | A write-effect tool can't create its session workspace (`workspace_unavailable`) |
|
|
231
|
+
|
|
232
|
+
## Related
|
|
233
|
+
|
|
234
|
+
- [Sessions](./sessions.md)
|
|
235
|
+
- [Channels](./channels.md)
|
|
236
|
+
- [Tools](./tools.md)
|
|
237
|
+
- [Deployment](../deployment.md)
|
|
@@ -1,23 +1,21 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Instructions"
|
|
3
|
-
description: "The always-on system prompt: authoring forms, how it reaches
|
|
3
|
+
description: "The always-on system prompt: authoring forms, how it reaches each runtime, and what belongs in it."
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Instructions
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
8
|
+
Agent instructions form the always-on system prompt and reach the model
|
|
9
|
+
on every turn. A root agent requires them; a subagent may inline
|
|
10
|
+
`instructions` in `agent.ts` instead.
|
|
11
11
|
|
|
12
12
|
## Authoring forms
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
| Form | Reach for it when |
|
|
14
|
+
| Form | Use it when |
|
|
17
15
|
| --- | --- |
|
|
18
|
-
| `agent/instructions.md` | Plain Markdown for most agents
|
|
19
|
-
| `agent/instructions.ts` | Generated prompts. Default-export `defineInstructions({ markdown })` or a plain string
|
|
20
|
-
| `agent/instructions/` directory | A long prompt split across files, composed in filename order
|
|
16
|
+
| `agent/instructions.md` | Plain Markdown for most agents |
|
|
17
|
+
| `agent/instructions.ts` | Generated prompts. Default-export `defineInstructions({ markdown })` or a plain string |
|
|
18
|
+
| `agent/instructions/` directory | A long prompt split across files, composed in filename order |
|
|
21
19
|
|
|
22
20
|
```ts
|
|
23
21
|
// agent/instructions.ts
|
|
@@ -28,22 +26,17 @@ export default defineInstructions({
|
|
|
28
26
|
});
|
|
29
27
|
```
|
|
30
28
|
|
|
31
|
-
##
|
|
32
|
-
|
|
33
|
-
On the local runtime, instructions land in the session workspace as
|
|
34
|
-
`AGENTS.md`, and the harness loads them natively. On the cloud runtime,
|
|
35
|
-
they're prepended to the first prompt, because the cloud VM doesn't
|
|
36
|
-
share the local session workspace.
|
|
29
|
+
## Delivery
|
|
37
30
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
covers
|
|
31
|
+
Local and cloud turns receive the composed instructions. They aren't
|
|
32
|
+
written into the session workspace. Parent directories can still
|
|
33
|
+
contribute ambient `AGENTS.md` and `.cursor` settings; [Agent config:
|
|
34
|
+
local cwd](./agent-config.md#local-cwd) covers how to control that.
|
|
42
35
|
|
|
43
|
-
##
|
|
36
|
+
## Contents
|
|
44
37
|
|
|
45
|
-
Keep them a few lines: identity, when to use which tool, output
|
|
46
|
-
The [quickstart PR approver](../quickstart.md) is the pattern:
|
|
38
|
+
Keep them a few lines: identity, when to use which tool, and the output
|
|
39
|
+
shape. The [quickstart PR approver](../quickstart.md) is the pattern:
|
|
47
40
|
|
|
48
41
|
```md
|
|
49
42
|
# PR approver
|
|
@@ -57,21 +50,13 @@ You review GitHub pull requests. Be specific and brief.
|
|
|
57
50
|
End with one sentence: the verdict and why.
|
|
58
51
|
```
|
|
59
52
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
model only sometimes needs belongs in `agent/skills/`, where it loads
|
|
66
|
-
on demand and keeps the always-on prompt small.
|
|
67
|
-
|
|
68
|
-
Instructions are the third lever in the
|
|
69
|
-
[hillclimbing loop](../hillclimbing.md), after host preparation and evidence
|
|
70
|
-
shape. If a fixture keeps failing, look there before rewriting prose.
|
|
71
|
-
|
|
72
|
-
## What's next
|
|
53
|
+
Name the tools and the decision rule ("use X before answering about
|
|
54
|
+
Y"), not general encouragement. State the output contract, including
|
|
55
|
+
length, format, and fences, so your [evals](../evals.md) can gate it.
|
|
56
|
+
Put multi-step workflows the model only sometimes needs in
|
|
57
|
+
`agent/skills/`; they load on demand and keep the always-on prompt small.
|
|
73
58
|
|
|
74
|
-
|
|
59
|
+
## Related
|
|
75
60
|
|
|
76
61
|
- [Skills](./skills.md): procedures the model loads only when relevant
|
|
77
62
|
- [Agent config](./agent-config.md): the file next to this one
|
|
@@ -5,55 +5,38 @@ description: "The built-in web UI: chat with streaming, Try buttons and slash co
|
|
|
5
5
|
|
|
6
6
|
# Playground
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
`agent-sdk serve` enables a web playground at
|
|
9
9
|
`http://127.0.0.1:3000/<slug>/playground` (or `/playground` in single
|
|
10
|
-
mode).
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
- **Evals**: list and run filesystem evals from the browser (backed by
|
|
32
|
-
`/v1/dev/evals`). Schedule hand-dispatch still requires `--dev`.
|
|
33
|
-
- **The surface**: inspect the discovered tools, skills, subagents, MCP
|
|
34
|
-
connections, channels, and hooks.
|
|
35
|
-
- **Custom tool chips**: drop `agent/playground/tools/<toolName>.tsx` to
|
|
36
|
-
change how that tool renders. Chips compile from the agent tree;
|
|
37
|
-
an [extension](./extensions.md) cannot contribute them.
|
|
38
|
-
- **Raw events pane**: flip it on to inspect the event stream.
|
|
39
|
-
- **Logs tab**: recent server log lines, polled from `GET /v1/logs`.
|
|
40
|
-
|
|
41
|
-
In multi-agent mode each agent has its own playground at
|
|
42
|
-
`/<slug>/playground`, and `/` is an index of them all.
|
|
43
|
-
|
|
44
|
-
## Share it beyond localhost
|
|
10
|
+
mode). In multi-agent mode, each agent has its own playground, and `/`
|
|
11
|
+
lists them all.
|
|
12
|
+
|
|
13
|
+
## Playground surfaces
|
|
14
|
+
|
|
15
|
+
| Surface | What you can do |
|
|
16
|
+
| --- | --- |
|
|
17
|
+
| Chat | Talk to the agent. Text and reasoning stream live, and tool calls appear inline with their arguments, output, and error state |
|
|
18
|
+
| Slash commands | Custom channel routes without path parameters become composer commands; GitHub and Slack ingress routes are excluded. A `drive` route becomes `/drive <pr-url>`, with `/help` and autocomplete |
|
|
19
|
+
| Try | Invoke a custom channel route from the Agent tab. The modal remembers your last body per endpoint, copies curl, and opens a session when the route creates one |
|
|
20
|
+
| Runs | Browse the sessions you own and eval runs. Search by title or identifier; open sessions in Chat, Trace, or Raw and eval runs in Evals |
|
|
21
|
+
| Approvals | Parked `needsApproval` tool calls render Approve / Deny buttons |
|
|
22
|
+
| Evals | List and run filesystem evals from the browser |
|
|
23
|
+
| Agent | Inspect the discovered tools, skills, subagents, MCP connections, channels, and hooks |
|
|
24
|
+
| Raw | Inspect the selected session's event stream |
|
|
25
|
+
| Logs | Recent server log lines, polled from `GET /v1/logs` |
|
|
26
|
+
|
|
27
|
+
In `--dev` on loopback, or with `--allow-anonymous`, the session list
|
|
28
|
+
includes every principal.
|
|
29
|
+
|
|
30
|
+
## Remote access
|
|
45
31
|
|
|
46
32
|
The default `localDevStrict()` auth admits direct loopback calls only
|
|
47
33
|
and rejects proxy-forwarding headers, so a tunnel or LAN address won't
|
|
48
|
-
work
|
|
49
|
-
until you pass `--bearer-token <secret>` (or
|
|
34
|
+
work until you pass `--bearer-token <secret>` (or
|
|
50
35
|
`serve(dir, { authToken })`). Open the playground on the remote device
|
|
51
|
-
and paste the token into the token field in the navbar.
|
|
52
|
-
demo-only alternative for trusted networks.
|
|
53
|
-
|
|
54
|
-
## What's next
|
|
36
|
+
and paste the token into the token field in the navbar.
|
|
37
|
+
`--allow-anonymous` is the demo-only alternative for trusted networks.
|
|
55
38
|
|
|
56
|
-
|
|
39
|
+
## Related
|
|
57
40
|
|
|
58
41
|
- [HTTP API](./http-api.md): the HTTP surface the playground uses
|
|
59
42
|
- [Sessions and streaming](./sessions.md): the streams it renders
|