@cursor/july 0.1.30 → 0.1.31
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 +1 -1
- package/README.md +10 -5
- package/dist/bin/agent-serve.js +4 -4
- package/dist/channels/github/index.d.ts +1 -1
- package/dist/channels/github/index.js +1 -1
- package/dist/channels/slack/bot-mentions.d.ts +1 -1
- package/dist/channels/slack/bot-mentions.d.ts.map +1 -1
- package/dist/channels/slack/bot-mentions.js +1 -1
- package/dist/channels/slack/eval-directive.js +1 -1
- package/dist/channels/slack/external-policy.d.ts +1 -1
- package/dist/channels/slack/external-policy.js +1 -1
- package/dist/channels/slack/log.d.ts +1 -1
- package/dist/channels/slack/log.js +1 -1
- package/dist/channels/slack/setup.js +1 -1
- package/dist/channels/slack/socket-mode.js +1 -1
- package/dist/docs/404.html +3 -3
- package/dist/docs/ab.html +11 -11
- package/dist/docs/assets/{ab.md.BMCZ6Hd7.js → ab.md.DAQoJ-up.js} +6 -6
- package/dist/docs/assets/{ab.md.BMCZ6Hd7.lean.js → ab.md.DAQoJ-up.lean.js} +1 -1
- package/dist/docs/assets/{app.Cm4lsMc4.js → app.DigB_9cQ.js} +1 -1
- package/dist/docs/assets/building-with-agents.md.CnHqvYDd.js +13 -0
- package/dist/docs/assets/{building-with-agents.md.CJCtZCyi.lean.js → building-with-agents.md.CnHqvYDd.lean.js} +1 -1
- package/dist/docs/assets/chunks/@localSearchIndexroot.CnFFl07y.js +1 -0
- package/dist/docs/assets/chunks/{VPLocalSearchBox.CYUFXspH.js → VPLocalSearchBox.BCMX25Bv.js} +1 -1
- package/dist/docs/assets/chunks/{theme.CTjkX9vc.js → theme.BDDWeELx.js} +2 -2
- package/dist/docs/assets/concepts.md.DFaQEFkA.js +4 -0
- package/dist/docs/assets/concepts.md.DFaQEFkA.lean.js +1 -0
- package/dist/docs/assets/deployment.md.9MYBuKM1.js +55 -0
- package/dist/docs/assets/deployment.md.9MYBuKM1.lean.js +1 -0
- package/dist/docs/assets/{evals.md.DYOjkRCX.js → evals.md.BIUoVZ6X.js} +13 -13
- package/dist/docs/assets/evals.md.BIUoVZ6X.lean.js +1 -0
- package/dist/docs/assets/{example-agents_approval-buddy.md.DFGBYLcc.js → example-agents_approval-buddy.md.BhEfleVx.js} +4 -4
- package/dist/docs/assets/{example-agents_approval-buddy.md.DFGBYLcc.lean.js → example-agents_approval-buddy.md.BhEfleVx.lean.js} +1 -1
- package/dist/docs/assets/example-agents_benny.md.2Et1qa8f.js +7 -0
- package/dist/docs/assets/{example-agents_bugbot.md.DelIdhxB.js → example-agents_bugbot.md.ByUexi5i.js} +5 -5
- package/dist/docs/assets/{example-agents_codebase-wiki.md.DC6sgwn0.js → example-agents_codebase-wiki.md.B4y-7ZVW.js} +6 -6
- package/dist/docs/assets/{example-agents_codebase-wiki.md.DC6sgwn0.lean.js → example-agents_codebase-wiki.md.B4y-7ZVW.lean.js} +1 -1
- package/dist/docs/assets/{example-agents_codeowners-review.md.Ku_tG2RY.js → example-agents_codeowners-review.md.D6ay4nvf.js} +6 -6
- package/dist/docs/assets/{example-agents_codeowners-review.md.Ku_tG2RY.lean.js → example-agents_codeowners-review.md.D6ay4nvf.lean.js} +1 -1
- package/dist/docs/assets/{example-agents_concierge.md.4rQTSMXt.js → example-agents_concierge.md.lL8rhYlj.js} +7 -7
- package/dist/docs/assets/{example-agents_fsd.md.CzgUrDfi.js → example-agents_fsd.md.DfNKQTHz.js} +5 -5
- package/dist/docs/assets/example-agents_index.md.DgGBwckv.js +2 -0
- package/dist/docs/assets/example-agents_index.md.DgGBwckv.lean.js +1 -0
- package/dist/docs/assets/{example-agents_knowledge-base.md.BPJiVueF.js → example-agents_knowledge-base.md.CzyZ2DCr.js} +5 -5
- package/dist/docs/assets/{example-agents_knowledge-base.md.BPJiVueF.lean.js → example-agents_knowledge-base.md.CzyZ2DCr.lean.js} +1 -1
- package/dist/docs/assets/example-agents_oncall.md.wFFXXEyW.js +10 -0
- package/dist/docs/assets/{example-agents_security-reviewer.md.Dhj_m7_B.js → example-agents_security-reviewer.md.Dkf1gyo6.js} +8 -8
- package/dist/docs/assets/example-agents_slack-agent.md.DvgvT4nn.js +5 -0
- package/dist/docs/assets/example-agents_weather-agent.md.Dmrcphhl.js +24 -0
- package/dist/docs/assets/example-agents_weather-agent.md.Dmrcphhl.lean.js +1 -0
- package/dist/docs/assets/{guides_agent-to-agent.md.Bpzgq2Pq.js → guides_agent-to-agent.md.Bmbxy-FA.js} +4 -4
- package/dist/docs/assets/guides_cloud-runtime.md.BZ2GA7Es.js +9 -0
- package/dist/docs/assets/{guides_github.md.DOOCpqsW.js → guides_github.md.R2QlpR75.js} +5 -5
- package/dist/docs/assets/{guides_human-in-the-loop.md.DlUqsp1S.js → guides_human-in-the-loop.md.BWvT7UqY.js} +1 -1
- package/dist/docs/assets/{guides_mcp-oauth.md.Dd8EgSem.js → guides_mcp-oauth.md.C7G7IykG.js} +5 -5
- package/dist/docs/assets/guides_mcp-oauth.md.C7G7IykG.lean.js +1 -0
- package/dist/docs/assets/guides_slack.md.zriQpU_9.js +47 -0
- package/dist/docs/assets/guides_slack.md.zriQpU_9.lean.js +1 -0
- package/dist/docs/assets/{guides_webhooks.md.wSOYas3X.js → guides_webhooks.md.DiAwSR42.js} +1 -1
- package/dist/docs/assets/{hillclimbing.md.DHNast08.js → hillclimbing.md.D9Y1_bYh.js} +1 -1
- package/dist/docs/assets/index.md.CZqbBJPB.js +20 -0
- package/dist/docs/assets/index.md.CZqbBJPB.lean.js +1 -0
- package/dist/docs/assets/{quickstart.md.BU6Iwi_9.js → quickstart.md.TnEXYgYW.js} +12 -12
- package/dist/docs/assets/{reference_agent-config.md.DrW2JUM8.js → reference_agent-config.md.kuN6-OxK.js} +1 -1
- package/dist/docs/assets/reference_cli.md.sD-IUWjg.js +73 -0
- package/dist/docs/assets/{reference_cli.md.ccoKOoXt.lean.js → reference_cli.md.sD-IUWjg.lean.js} +1 -1
- package/dist/docs/assets/{reference_connections.md.B9Q3TOve.js → reference_connections.md.DGqAsFXb.js} +3 -3
- package/dist/docs/assets/reference_http-api.md.CfVM_ICa.js +11 -0
- package/dist/docs/assets/{reference_project-layout.md.Bd_CKtNS.js → reference_project-layout.md.D8E6ZmHJ.js} +4 -4
- package/dist/docs/assets/{reference_project-layout.md.Bd_CKtNS.lean.js → reference_project-layout.md.D8E6ZmHJ.lean.js} +1 -1
- package/dist/docs/assets/{reference_schedules.md.w_F2mXB6.js → reference_schedules.md.gmfYzf_I.js} +1 -1
- package/dist/docs/assets/{reference_sessions.md.DLd6mvbv.js → reference_sessions.md.C_ouF_uf.js} +3 -3
- package/dist/docs/assets/{reference_tools.md.BRSDnTbN.js → reference_tools.md.BswAQM41.js} +3 -3
- package/dist/docs/assets/{scaffolding-agents.md.C3pTrmoE.js → scaffolding-agents.md.Bsr9Pwzu.js} +1 -1
- package/dist/docs/assets/{scaffolding-agents.md.C3pTrmoE.lean.js → scaffolding-agents.md.Bsr9Pwzu.lean.js} +1 -1
- package/dist/docs/assets/{storage.md.DRTdnFvd.js → storage.md.xZoiGM58.js} +3 -3
- package/dist/docs/assets/storage.md.xZoiGM58.lean.js +1 -0
- package/dist/docs/assets/troubleshooting.md.B5RVX_tL.js +1 -0
- package/dist/docs/assets/{troubleshooting.md.CmQkmnzC.lean.js → troubleshooting.md.B5RVX_tL.lean.js} +1 -1
- package/dist/docs/building-with-agents.html +12 -12
- package/dist/docs/concepts.html +6 -6
- package/dist/docs/deployment.html +32 -32
- package/dist/docs/evals.html +19 -19
- package/dist/docs/example-agents/approval-buddy.html +9 -9
- package/dist/docs/example-agents/benny.html +11 -11
- package/dist/docs/example-agents/bugbot.html +10 -10
- package/dist/docs/example-agents/codebase-wiki.html +11 -11
- package/dist/docs/example-agents/codeowners-review.html +11 -11
- package/dist/docs/example-agents/concierge.html +12 -12
- package/dist/docs/example-agents/fsd.html +10 -10
- package/dist/docs/example-agents/index.html +7 -7
- package/dist/docs/example-agents/knowledge-base.html +10 -10
- package/dist/docs/example-agents/oncall.html +10 -10
- package/dist/docs/example-agents/security-reviewer.html +13 -13
- package/dist/docs/example-agents/slack-agent.html +10 -10
- package/dist/docs/example-agents/weather-agent.html +16 -16
- package/dist/docs/guides/agent-to-agent.html +9 -9
- package/dist/docs/guides/cloud-runtime.html +7 -7
- package/dist/docs/guides/github.html +10 -10
- package/dist/docs/guides/human-in-the-loop.html +7 -7
- package/dist/docs/guides/mcp-oauth.html +11 -11
- package/dist/docs/guides/slack.html +22 -17
- package/dist/docs/guides/webhooks.html +7 -7
- package/dist/docs/hashmap.json +1 -1
- package/dist/docs/hillclimbing.html +7 -7
- package/dist/docs/index.html +9 -9
- package/dist/docs/quickstart.html +17 -17
- package/dist/docs/reference/agent-config.html +7 -7
- package/dist/docs/reference/channels.html +5 -5
- package/dist/docs/reference/cli.html +56 -48
- package/dist/docs/reference/connections.html +9 -9
- package/dist/docs/reference/hooks.html +5 -5
- package/dist/docs/reference/http-api.html +7 -7
- package/dist/docs/reference/instructions.html +5 -5
- package/dist/docs/reference/playground.html +5 -5
- package/dist/docs/reference/project-layout.html +9 -9
- package/dist/docs/reference/prompt.html +5 -5
- package/dist/docs/reference/schedules.html +7 -7
- package/dist/docs/reference/sessions.html +8 -8
- package/dist/docs/reference/skills.html +5 -5
- package/dist/docs/reference/subagents.html +5 -5
- package/dist/docs/reference/tools.html +9 -9
- package/dist/docs/scaffolding-agents.html +6 -6
- package/dist/docs/storage.html +9 -9
- package/dist/docs/troubleshooting.html +6 -6
- package/dist/evals/reporters.d.ts +1 -1
- package/dist/evals/reporters.js +1 -1
- package/dist/evals.d.ts +2 -2
- package/dist/files-backends/agent-store-presigned-url.d.ts +100 -0
- package/dist/files-backends/agent-store-presigned-url.d.ts.map +1 -0
- package/dist/files-backends/agent-store-presigned-url.js +347 -0
- package/dist/files-backends/cursor-hosted.d.ts +87 -0
- package/dist/files-backends/cursor-hosted.d.ts.map +1 -0
- package/dist/files-backends/cursor-hosted.js +540 -0
- package/dist/files-backends/local-fs.d.ts +33 -0
- package/dist/files-backends/local-fs.d.ts.map +1 -0
- package/dist/files-backends/local-fs.js +199 -0
- package/dist/files.d.ts +139 -0
- package/dist/files.d.ts.map +1 -0
- package/dist/files.js +89 -0
- package/dist/internal/ab-collector.js +2 -2
- package/dist/internal/ab-fold.js +1 -1
- package/dist/internal/cli-ax.d.ts +2 -2
- package/dist/internal/cli-ax.js +2 -2
- package/dist/internal/cli-deploy.d.ts +1 -1
- package/dist/internal/cli-deploy.d.ts.map +1 -1
- package/dist/internal/cli-deploy.js +7 -2
- package/dist/internal/cli-docs.d.ts +1 -1
- package/dist/internal/cli-docs.js +1 -1
- package/dist/internal/cli-github.js +13 -13
- package/dist/internal/cli-mcp-oauth.d.ts +1 -1
- package/dist/internal/cli-mcp-oauth.js +2 -2
- package/dist/internal/cli-mcp.d.ts +3 -3
- package/dist/internal/cli-mcp.js +4 -4
- package/dist/internal/cli-skills.js +1 -1
- package/dist/internal/cloud-turn-cost.d.ts +9 -1
- package/dist/internal/cloud-turn-cost.d.ts.map +1 -1
- package/dist/internal/cloud-turn-cost.js +14 -4
- package/dist/internal/cursor/account-mcp.js +5 -5
- package/dist/internal/cursor/backend-client.js +1 -1
- package/dist/internal/cursor/github-credentials.js +3 -3
- package/dist/internal/cursor-account-mcp-auth.d.ts +1 -1
- package/dist/internal/cursor-account-mcp-auth.js +1 -1
- package/dist/internal/cursor-event-relay.js +1 -1
- package/dist/internal/cursor-relay-core.d.ts +1 -1
- package/dist/internal/cursor-relay-core.d.ts.map +1 -1
- package/dist/internal/cursor-slack-relay.js +1 -1
- package/dist/internal/deploy-client.d.ts +6 -1
- package/dist/internal/deploy-client.d.ts.map +1 -1
- package/dist/internal/deploy-client.js +3 -2
- package/dist/internal/deploy-source.d.ts +2 -2
- package/dist/internal/deploy-source.js +2 -2
- package/dist/internal/discovery.js +2 -2
- package/dist/internal/distribution.d.ts +5 -5
- package/dist/internal/distribution.d.ts.map +1 -1
- package/dist/internal/distribution.js +6 -6
- package/dist/internal/docs-site.js +5 -5
- package/dist/internal/eval-run-store.js +8 -8
- package/dist/internal/evals-client.d.ts +1 -1
- package/dist/internal/evals-client.js +1 -1
- package/dist/internal/github-fanout.js +2 -2
- package/dist/internal/host-files.d.ts +29 -0
- package/dist/internal/host-files.d.ts.map +1 -0
- package/dist/internal/host-files.js +283 -0
- package/dist/internal/host-platforms.js +5 -5
- package/dist/internal/hosting.d.ts +1 -1
- package/dist/internal/hosting.js +1 -1
- package/dist/internal/http-channel.d.ts.map +1 -1
- package/dist/internal/http-channel.js +26 -0
- package/dist/internal/install-cursor-skills.d.ts +1 -1
- package/dist/internal/install-cursor-skills.d.ts.map +1 -1
- package/dist/internal/install-cursor-skills.js +33 -4
- package/dist/internal/local-control-plane.js +2 -2
- package/dist/internal/logs-client.d.ts +2 -2
- package/dist/internal/logs-client.js +2 -2
- package/dist/internal/mcp-endpoint.js +1 -1
- package/dist/internal/mcp-oauth.js +2 -2
- package/dist/internal/platform-schedule-sync.js +2 -2
- package/dist/internal/playground/toolchain.js +6 -6
- package/dist/internal/reminder-runner.js +13 -13
- package/dist/internal/resolved-connections.js +6 -6
- package/dist/internal/schedule-runner.js +1 -1
- package/dist/internal/sdk-runner.js +5 -5
- package/dist/internal/server.js +16 -16
- package/dist/internal/session-cost.d.ts +3 -2
- package/dist/internal/session-cost.d.ts.map +1 -1
- package/dist/internal/session-cost.js +7 -6
- package/dist/internal/session-engine.d.ts +31 -1
- package/dist/internal/session-engine.d.ts.map +1 -1
- package/dist/internal/session-engine.js +119 -31
- package/dist/internal/slack-provision-client.js +1 -1
- package/dist/internal/storage-coordinator.js +7 -7
- package/dist/internal/trajectory.js +2 -2
- package/dist/internal/turn-cost.d.ts +27 -0
- package/dist/internal/turn-cost.d.ts.map +1 -0
- package/dist/internal/turn-cost.js +83 -0
- package/dist/internal/update-check.d.ts +3 -3
- package/dist/internal/update-check.d.ts.map +1 -1
- package/dist/internal/update-check.js +5 -5
- package/dist/memory.d.ts +1 -1
- package/dist/memory.js +1 -1
- package/dist/playground/assets/index-50PKeJlG.css +1 -0
- package/dist/playground/assets/index-C0f2Wl1q.js +85 -0
- package/dist/playground/index.html +2 -2
- package/dist/storage.d.ts +1 -1
- package/dist/storage.js +1 -1
- package/dist/types.d.ts +120 -16
- package/dist/types.d.ts.map +1 -1
- package/docs/README.md +23 -23
- package/docs/ab.md +12 -12
- package/docs/building-with-agents.md +9 -9
- package/docs/concepts.md +11 -11
- package/docs/deployment.md +55 -43
- package/docs/evals.md +20 -20
- package/docs/example-agents/approval-buddy.md +9 -9
- package/docs/example-agents/benny.md +13 -13
- package/docs/example-agents/bugbot.md +6 -6
- package/docs/example-agents/codebase-wiki.md +8 -8
- package/docs/example-agents/codeowners-review.md +8 -8
- package/docs/example-agents/concierge.md +10 -10
- package/docs/example-agents/fsd.md +7 -7
- package/docs/example-agents/index.md +8 -8
- package/docs/example-agents/knowledge-base.md +9 -9
- package/docs/example-agents/oncall.md +7 -7
- package/docs/example-agents/security-reviewer.md +12 -12
- package/docs/example-agents/slack-agent.md +10 -10
- package/docs/example-agents/weather-agent.md +30 -26
- package/docs/guides/agent-to-agent.md +4 -4
- package/docs/guides/cloud-runtime.md +3 -3
- package/docs/guides/github.md +6 -6
- package/docs/guides/human-in-the-loop.md +1 -1
- package/docs/guides/mcp-oauth.md +9 -9
- package/docs/guides/slack.md +94 -21
- package/docs/guides/webhooks.md +1 -1
- package/docs/hillclimbing.md +3 -3
- package/docs/quickstart.md +18 -18
- package/docs/reference/agent-config.md +1 -1
- package/docs/reference/cli.md +110 -79
- package/docs/reference/connections.md +3 -3
- package/docs/reference/http-api.md +2 -2
- package/docs/reference/project-layout.md +7 -7
- package/docs/reference/schedules.md +1 -1
- package/docs/reference/sessions.md +7 -7
- package/docs/reference/tools.md +3 -3
- package/docs/scaffolding-agents.md +2 -2
- package/docs/storage.md +5 -5
- package/docs/troubleshooting.md +11 -10
- package/package.json +3 -1
- package/skills/ab/SKILL.md +5 -5
- package/skills/create-agent/SKILL.md +17 -17
- package/skills/debug/SKILL.md +10 -10
- package/skills/evals/SKILL.md +13 -13
- package/skills/framework-map/SKILL.md +3 -3
- package/skills/github/SKILL.md +11 -11
- package/skills/hillclimb/SKILL.md +9 -9
- package/skills/mcp-auth/SKILL.md +11 -11
- package/skills/setup-slack/SKILL.md +28 -28
- package/src/bin/agent-serve.ts +4 -4
- package/src/channels/github/index.ts +1 -1
- package/src/channels/slack/bot-mentions.ts +1 -1
- package/src/channels/slack/eval-directive.ts +1 -1
- package/src/channels/slack/external-policy.ts +1 -1
- package/src/channels/slack/log.ts +1 -1
- package/src/channels/slack/setup.ts +1 -1
- package/src/channels/slack/socket-mode.ts +1 -1
- package/src/evals/reporters.ts +1 -1
- package/src/evals.ts +2 -2
- package/src/files-backends/agent-store-presigned-url.ts +402 -0
- package/src/files-backends/cursor-hosted.ts +698 -0
- package/src/files-backends/local-fs.ts +178 -0
- package/src/files.ts +195 -0
- package/src/internal/ab-collector.ts +2 -2
- package/src/internal/ab-fold.ts +1 -1
- package/src/internal/cli-ax.ts +2 -2
- package/src/internal/cli-deploy.ts +7 -2
- package/src/internal/cli-docs.ts +1 -1
- package/src/internal/cli-github.ts +13 -13
- package/src/internal/cli-mcp-oauth.ts +2 -2
- package/src/internal/cli-mcp.ts +4 -4
- package/src/internal/cli-skills.ts +1 -1
- package/src/internal/cloud-turn-cost.ts +20 -4
- package/src/internal/cursor/account-mcp.ts +5 -5
- package/src/internal/cursor/backend-client.ts +1 -1
- package/src/internal/cursor/github-credentials.ts +3 -3
- package/src/internal/cursor-account-mcp-auth.ts +1 -1
- package/src/internal/cursor-event-relay.ts +1 -1
- package/src/internal/cursor-relay-core.ts +1 -1
- package/src/internal/cursor-slack-relay.ts +1 -1
- package/src/internal/deploy-client.ts +8 -2
- package/src/internal/deploy-source.ts +2 -2
- package/src/internal/discovery.ts +2 -2
- package/src/internal/distribution.ts +6 -6
- package/src/internal/docs-site.ts +5 -5
- package/src/internal/eval-run-store.ts +8 -8
- package/src/internal/evals-client.ts +1 -1
- package/src/internal/github-fanout.ts +2 -2
- package/src/internal/host-files.ts +372 -0
- package/src/internal/host-platforms.ts +5 -5
- package/src/internal/hosting.ts +1 -1
- package/src/internal/http-channel.ts +30 -0
- package/src/internal/install-cursor-skills.ts +31 -3
- package/src/internal/local-control-plane.ts +2 -2
- package/src/internal/logs-client.ts +2 -2
- package/src/internal/mcp-endpoint.ts +1 -1
- package/src/internal/mcp-oauth.ts +2 -2
- package/src/internal/platform-schedule-sync.ts +2 -2
- package/src/internal/playground/toolchain.ts +6 -6
- package/src/internal/reminder-runner.ts +13 -13
- package/src/internal/resolved-connections.ts +6 -6
- package/src/internal/schedule-runner.ts +1 -1
- package/src/internal/sdk-runner.ts +5 -5
- package/src/internal/server.ts +16 -16
- package/src/internal/session-cost.ts +7 -6
- package/src/internal/session-engine.ts +141 -28
- package/src/internal/slack-provision-client.ts +1 -1
- package/src/internal/storage-coordinator.ts +7 -7
- package/src/internal/trajectory.ts +2 -2
- package/src/internal/turn-cost.ts +110 -0
- package/src/internal/update-check.ts +6 -6
- package/src/memory.ts +1 -1
- package/src/storage.ts +1 -1
- package/src/types.ts +148 -16
- package/dist/docs/assets/building-with-agents.md.CJCtZCyi.js +0 -13
- package/dist/docs/assets/chunks/@localSearchIndexroot.CbQshWFK.js +0 -1
- package/dist/docs/assets/concepts.md.Cfb9b-k1.js +0 -4
- package/dist/docs/assets/concepts.md.Cfb9b-k1.lean.js +0 -1
- package/dist/docs/assets/deployment.md.TecHo0_2.js +0 -55
- package/dist/docs/assets/deployment.md.TecHo0_2.lean.js +0 -1
- package/dist/docs/assets/evals.md.DYOjkRCX.lean.js +0 -1
- package/dist/docs/assets/example-agents_benny.md.B0gjhI-p.js +0 -7
- package/dist/docs/assets/example-agents_index.md.D2PEVSXl.js +0 -2
- package/dist/docs/assets/example-agents_index.md.D2PEVSXl.lean.js +0 -1
- package/dist/docs/assets/example-agents_oncall.md.BG_sUMly.js +0 -10
- package/dist/docs/assets/example-agents_slack-agent.md.buLbgvBf.js +0 -5
- package/dist/docs/assets/example-agents_weather-agent.md.C9Qv-W0o.js +0 -24
- package/dist/docs/assets/example-agents_weather-agent.md.C9Qv-W0o.lean.js +0 -1
- package/dist/docs/assets/guides_cloud-runtime.md.gVzabdQL.js +0 -9
- package/dist/docs/assets/guides_mcp-oauth.md.Dd8EgSem.lean.js +0 -1
- package/dist/docs/assets/guides_slack.md.CjmJSvZS.js +0 -42
- package/dist/docs/assets/guides_slack.md.CjmJSvZS.lean.js +0 -1
- package/dist/docs/assets/index.md.CH_s5uZe.js +0 -20
- package/dist/docs/assets/index.md.CH_s5uZe.lean.js +0 -1
- package/dist/docs/assets/reference_cli.md.ccoKOoXt.js +0 -65
- package/dist/docs/assets/reference_http-api.md.BncLd3PZ.js +0 -11
- package/dist/docs/assets/storage.md.DRTdnFvd.lean.js +0 -1
- package/dist/docs/assets/troubleshooting.md.CmQkmnzC.js +0 -1
- package/dist/internal/model-pricing.d.ts +0 -49
- package/dist/internal/model-pricing.d.ts.map +0 -1
- package/dist/internal/model-pricing.js +0 -377
- package/dist/playground/assets/index-CquRB-l0.js +0 -85
- package/dist/playground/assets/index-Dj0bWpkn.css +0 -1
- package/src/internal/model-pricing.ts +0 -426
- /package/dist/docs/assets/{example-agents_benny.md.B0gjhI-p.lean.js → example-agents_benny.md.2Et1qa8f.lean.js} +0 -0
- /package/dist/docs/assets/{example-agents_bugbot.md.DelIdhxB.lean.js → example-agents_bugbot.md.ByUexi5i.lean.js} +0 -0
- /package/dist/docs/assets/{example-agents_concierge.md.4rQTSMXt.lean.js → example-agents_concierge.md.lL8rhYlj.lean.js} +0 -0
- /package/dist/docs/assets/{example-agents_fsd.md.CzgUrDfi.lean.js → example-agents_fsd.md.DfNKQTHz.lean.js} +0 -0
- /package/dist/docs/assets/{example-agents_oncall.md.BG_sUMly.lean.js → example-agents_oncall.md.wFFXXEyW.lean.js} +0 -0
- /package/dist/docs/assets/{example-agents_security-reviewer.md.Dhj_m7_B.lean.js → example-agents_security-reviewer.md.Dkf1gyo6.lean.js} +0 -0
- /package/dist/docs/assets/{example-agents_slack-agent.md.buLbgvBf.lean.js → example-agents_slack-agent.md.DvgvT4nn.lean.js} +0 -0
- /package/dist/docs/assets/{guides_agent-to-agent.md.Bpzgq2Pq.lean.js → guides_agent-to-agent.md.Bmbxy-FA.lean.js} +0 -0
- /package/dist/docs/assets/{guides_cloud-runtime.md.gVzabdQL.lean.js → guides_cloud-runtime.md.BZ2GA7Es.lean.js} +0 -0
- /package/dist/docs/assets/{guides_github.md.DOOCpqsW.lean.js → guides_github.md.R2QlpR75.lean.js} +0 -0
- /package/dist/docs/assets/{guides_human-in-the-loop.md.DlUqsp1S.lean.js → guides_human-in-the-loop.md.BWvT7UqY.lean.js} +0 -0
- /package/dist/docs/assets/{guides_webhooks.md.wSOYas3X.lean.js → guides_webhooks.md.DiAwSR42.lean.js} +0 -0
- /package/dist/docs/assets/{hillclimbing.md.DHNast08.lean.js → hillclimbing.md.D9Y1_bYh.lean.js} +0 -0
- /package/dist/docs/assets/{quickstart.md.BU6Iwi_9.lean.js → quickstart.md.TnEXYgYW.lean.js} +0 -0
- /package/dist/docs/assets/{reference_agent-config.md.DrW2JUM8.lean.js → reference_agent-config.md.kuN6-OxK.lean.js} +0 -0
- /package/dist/docs/assets/{reference_connections.md.B9Q3TOve.lean.js → reference_connections.md.DGqAsFXb.lean.js} +0 -0
- /package/dist/docs/assets/{reference_http-api.md.BncLd3PZ.lean.js → reference_http-api.md.CfVM_ICa.lean.js} +0 -0
- /package/dist/docs/assets/{reference_schedules.md.w_F2mXB6.lean.js → reference_schedules.md.gmfYzf_I.lean.js} +0 -0
- /package/dist/docs/assets/{reference_sessions.md.DLd6mvbv.lean.js → reference_sessions.md.C_ouF_uf.lean.js} +0 -0
- /package/dist/docs/assets/{reference_tools.md.BRSDnTbN.lean.js → reference_tools.md.BswAQM41.lean.js} +0 -0
package/docs/quickstart.md
CHANGED
|
@@ -19,12 +19,12 @@ inspectable in the playground.
|
|
|
19
19
|
You need:
|
|
20
20
|
|
|
21
21
|
- Node 22.13 or newer. Bun isn't supported.
|
|
22
|
-
- The `
|
|
22
|
+
- The `agent-sdk` CLI. See [Run the CLI](./README.md#run-the-cli)
|
|
23
23
|
for the current package and command names.
|
|
24
24
|
- A Cursor credential for model turns. Sign in once:
|
|
25
25
|
|
|
26
26
|
```bash
|
|
27
|
-
|
|
27
|
+
agent-sdk login
|
|
28
28
|
```
|
|
29
29
|
|
|
30
30
|
You can also set `CURSOR_API_KEY` instead of signing in.
|
|
@@ -53,12 +53,12 @@ full guided workflow.
|
|
|
53
53
|
Start with the built-in scaffold:
|
|
54
54
|
|
|
55
55
|
```bash
|
|
56
|
-
|
|
56
|
+
agent-sdk init ./pr-approver
|
|
57
57
|
cd pr-approver
|
|
58
|
-
|
|
58
|
+
agent-sdk dev
|
|
59
59
|
```
|
|
60
60
|
|
|
61
|
-
The scaffold creates the files
|
|
61
|
+
The scaffold creates the files the Agent SDK discovers, plus empty capability
|
|
62
62
|
folders (each with a `.gitkeep`) so you can drop tools, channels, and
|
|
63
63
|
evals in place:
|
|
64
64
|
|
|
@@ -91,8 +91,8 @@ framework runs your TypeScript directly, so nothing compiles.
|
|
|
91
91
|
Check the project before you run it:
|
|
92
92
|
|
|
93
93
|
```bash
|
|
94
|
-
|
|
95
|
-
|
|
94
|
+
agent-sdk validate --dir .
|
|
95
|
+
agent-sdk info --dir .
|
|
96
96
|
```
|
|
97
97
|
|
|
98
98
|
These commands inspect the project without starting a model turn.
|
|
@@ -102,14 +102,14 @@ These commands inspect the project without starting a model turn.
|
|
|
102
102
|
The scaffold already works. Run one turn from the terminal:
|
|
103
103
|
|
|
104
104
|
```bash
|
|
105
|
-
|
|
105
|
+
agent-sdk run --dir . \
|
|
106
106
|
--message "Introduce yourself in one sentence."
|
|
107
107
|
```
|
|
108
108
|
|
|
109
109
|
`run` starts the agent, sends the message, and waits for the final
|
|
110
110
|
reply. It prints a JSON trajectory with the response, tool calls, and
|
|
111
111
|
token usage. It also writes an NDJSON trace under
|
|
112
|
-
`.
|
|
112
|
+
`.agent-sdk/traces/`.
|
|
113
113
|
|
|
114
114
|
## Teach it to review
|
|
115
115
|
|
|
@@ -266,7 +266,7 @@ a GitHub App) without parsing any of it.
|
|
|
266
266
|
Call the tool directly first, on a real merged pull request:
|
|
267
267
|
|
|
268
268
|
```bash
|
|
269
|
-
|
|
269
|
+
agent-sdk call inspect_pr --dir . \
|
|
270
270
|
--input '{"prUrl":"https://github.com/react/react/pull/35623"}'
|
|
271
271
|
```
|
|
272
272
|
|
|
@@ -289,7 +289,7 @@ Now call it on the PR that added `experimental_useEvent` to React:
|
|
|
289
289
|
1,027 additions across 26 files.
|
|
290
290
|
|
|
291
291
|
```bash
|
|
292
|
-
|
|
292
|
+
agent-sdk call inspect_pr --dir . \
|
|
293
293
|
--input '{"prUrl":"https://github.com/react/react/pull/25229"}'
|
|
294
294
|
```
|
|
295
295
|
|
|
@@ -363,7 +363,7 @@ teammate's open PR is the right pick: write access to the repo, and
|
|
|
363
363
|
not authored by you.
|
|
364
364
|
|
|
365
365
|
```bash
|
|
366
|
-
|
|
366
|
+
agent-sdk run --dir . \
|
|
367
367
|
--message "Review https://github.com/acme/checkout/pull/42"
|
|
368
368
|
```
|
|
369
369
|
|
|
@@ -425,17 +425,17 @@ webhook delivery, and POSTs it to the channel. No repo admin, no
|
|
|
425
425
|
tunnel:
|
|
426
426
|
|
|
427
427
|
```bash
|
|
428
|
-
|
|
428
|
+
agent-sdk dev
|
|
429
429
|
# second terminal:
|
|
430
|
-
|
|
430
|
+
agent-sdk github replay https://github.com/acme/checkout/pull/42 \
|
|
431
431
|
--dir . --action opened
|
|
432
432
|
```
|
|
433
433
|
|
|
434
434
|
The replay prints the delivery, and the serve terminal shows the wake:
|
|
435
435
|
|
|
436
436
|
```text
|
|
437
|
-
[
|
|
438
|
-
[
|
|
437
|
+
[agent-sdk] replaying acme/checkout#42 (pull_request) → 1 channel
|
|
438
|
+
[agent-sdk] pull_request.opened → pr-approver/github 200
|
|
439
439
|
```
|
|
440
440
|
|
|
441
441
|
The agent runs the same inspect-then-submit loop, unprompted this time.
|
|
@@ -445,7 +445,7 @@ conversation.
|
|
|
445
445
|
|
|
446
446
|
## Open the playground
|
|
447
447
|
|
|
448
|
-
Keep `
|
|
448
|
+
Keep `agent-sdk dev` running and open the playground URL it printed. The
|
|
449
449
|
webhook session is in the session list, titled
|
|
450
450
|
`Review acme/checkout#42`, with the trigger message, both tool calls,
|
|
451
451
|
and the verdict laid out. Start a new chat there and ask for another
|
|
@@ -456,7 +456,7 @@ review to watch a turn stream live.
|
|
|
456
456
|
Replay is for development. For real deliveries, serve with
|
|
457
457
|
`--cursor-events --repo owner/repo` to pull events for repositories
|
|
458
458
|
connected to Cursor with no public URL, or run
|
|
459
|
-
`
|
|
459
|
+
`agent-sdk github forward` to relay webhooks to your dev server. The
|
|
460
460
|
[GitHub guide](./guides/github.md) compares the options. In production,
|
|
461
461
|
give the host GitHub App credentials so reviews post as your app's bot
|
|
462
462
|
identity instead of a personal account.
|
|
@@ -141,7 +141,7 @@ console.log(`listening on ${handle.url}`);
|
|
|
141
141
|
`authToken` (the `--bearer-token` equivalent), `allowAnonymous`,
|
|
142
142
|
`publicUrl`, `cursorEvents`, and `mode: "single" | "multi"`. The Cursor
|
|
143
143
|
credential resolves in one order everywhere: explicit `apiKey`, then
|
|
144
|
-
`CURSOR_API_KEY`, then the key stored by `
|
|
144
|
+
`CURSOR_API_KEY`, then the key stored by `agent-sdk login`.
|
|
145
145
|
|
|
146
146
|
## What's next
|
|
147
147
|
|
package/docs/reference/cli.md
CHANGED
|
@@ -6,16 +6,16 @@ description: "Commands and common flags for local development, running servers,
|
|
|
6
6
|
# CLI reference
|
|
7
7
|
|
|
8
8
|
`@cursor/july` installs `july` (so `npx @cursor/july docs` works),
|
|
9
|
-
`
|
|
10
|
-
page use `
|
|
9
|
+
`agent-sdk`, and the legacy `agent-serve` alias. The examples on this
|
|
10
|
+
page use `agent-sdk`. Run the CLI with Node 22.13 or newer. Don't run it
|
|
11
11
|
with Bun; Bun corrupts tool-result streams from the Cursor SDK.
|
|
12
12
|
|
|
13
13
|
The current release still uses `.agent-serve` for on-disk state. See the
|
|
14
14
|
[rename table](../README.md#run-the-cli) for identifiers still moving to
|
|
15
|
-
|
|
15
|
+
agent-sdk names.
|
|
16
16
|
|
|
17
|
-
`
|
|
18
|
-
also provide `
|
|
17
|
+
`agent-sdk help` prints the built-in summary. The Slack and GitHub packs
|
|
18
|
+
also provide `agent-sdk slack help` and `agent-sdk github help`.
|
|
19
19
|
|
|
20
20
|
| Command | Description |
|
|
21
21
|
| ------------------------------------------------------- | -------------------------------------------------------------- |
|
|
@@ -45,7 +45,7 @@ also provide `agentkit slack help` and `agentkit github help`.
|
|
|
45
45
|
| [`rotate-pod-credential`](#rotate-pod-credential) | Replace a deployment's pod credential |
|
|
46
46
|
| [`secrets`](#secrets) | Manage deployment secrets |
|
|
47
47
|
| [`mcp oauth`](#mcp-oauth) | Authorize host MCP OAuth; optional `--store` to deployment secrets |
|
|
48
|
-
| [`slack ...`](#slack) |
|
|
48
|
+
| [`slack ...`](#slack) | Provision, set up, and check Slack channels |
|
|
49
49
|
| [`github ...`](#github) | Forward, replay, and inspect GitHub webhook channels |
|
|
50
50
|
|
|
51
51
|
## Choose a target
|
|
@@ -76,7 +76,7 @@ for `login`, `serve`, hosted targets, and managed-hosting commands.
|
|
|
76
76
|
`eval` servers. Running and hosted targets ignore it.
|
|
77
77
|
|
|
78
78
|
For ephemeral `run`, `call`, and `eval` commands, omitting `--slug`
|
|
79
|
-
selects an unslugged root mount when one exists. Otherwise,
|
|
79
|
+
selects an unslugged root mount when one exists. Otherwise, the Agent SDK
|
|
80
80
|
selects the first discovered agent.
|
|
81
81
|
|
|
82
82
|
## serve
|
|
@@ -84,7 +84,7 @@ selects the first discovered agent.
|
|
|
84
84
|
`serve` hosts every agent under `--dir` in multi-agent mode by default.
|
|
85
85
|
|
|
86
86
|
```bash
|
|
87
|
-
|
|
87
|
+
agent-sdk serve [--dir <path>] [--port 3000] [--host 127.0.0.1] [--dev]
|
|
88
88
|
[--mode multi|single] [--api-key <key>]
|
|
89
89
|
[--state-root <path>] [--bearer-token <secret> | --allow-anonymous]
|
|
90
90
|
[--allow-anonymous-cursor-github]
|
|
@@ -129,9 +129,9 @@ and `docs`.
|
|
|
129
129
|
agent folder as a positional path, or run it from inside the project:
|
|
130
130
|
|
|
131
131
|
```bash
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
132
|
+
agent-sdk dev
|
|
133
|
+
agent-sdk dev ./pr-approver
|
|
134
|
+
agent-sdk dev ./pr-approver --port 3000
|
|
135
135
|
```
|
|
136
136
|
|
|
137
137
|
`dev` accepts the same flags as [`serve`](#serve). You can use `--dir`
|
|
@@ -148,10 +148,10 @@ path with a different `--dir`.
|
|
|
148
148
|
server.
|
|
149
149
|
|
|
150
150
|
```bash
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
151
|
+
agent-sdk chat --url http://127.0.0.1:3000/pr-approver
|
|
152
|
+
agent-sdk chat --message "Is the PR ready to approve?"
|
|
153
|
+
agent-sdk chat --message "Inspect PR 42" --json
|
|
154
|
+
agent-sdk chat --prod --slug pr-approver --team 123
|
|
155
155
|
```
|
|
156
156
|
|
|
157
157
|
`chat` streams text, tool calls, and a per-turn usage footer.
|
|
@@ -173,10 +173,10 @@ continuation token.
|
|
|
173
173
|
`resume` is the direct way to reattach the chat REPL.
|
|
174
174
|
|
|
175
175
|
```bash
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
176
|
+
agent-sdk resume ses_123 --url http://127.0.0.1:3000/pr-approver
|
|
177
|
+
agent-sdk resume --url http://127.0.0.1:3000/pr-approver
|
|
178
|
+
agent-sdk resume ses_123 --prod --team 123 --slug pr-approver
|
|
179
|
+
agent-sdk resume ses_123 --message "Continue the review" --json
|
|
180
180
|
```
|
|
181
181
|
|
|
182
182
|
Pass a session ID to select it. Omit the ID to select the most recently
|
|
@@ -190,8 +190,8 @@ available as `chat --session <id>` or `chat --resume`.
|
|
|
190
190
|
`logs` follows the local or hosted log buffer.
|
|
191
191
|
|
|
192
192
|
```bash
|
|
193
|
-
|
|
194
|
-
|
|
193
|
+
agent-sdk logs [--url http://127.0.0.1:3000] [--once] [--json]
|
|
194
|
+
agent-sdk logs --prod [--slug <slug>] [--team <id>] [--once] [--json]
|
|
195
195
|
```
|
|
196
196
|
|
|
197
197
|
Local mode reads `/v1/logs` from the running server. Hosted mode reports
|
|
@@ -205,7 +205,7 @@ buffer and exits. `--json` emits newline-delimited JSON events.
|
|
|
205
205
|
`sessions` lists sessions on a running or hosted agent.
|
|
206
206
|
|
|
207
207
|
```bash
|
|
208
|
-
|
|
208
|
+
agent-sdk sessions [--url <baseUrl> | --prod] [--slug <slug>]
|
|
209
209
|
[--team <id>] [--bearer-token <token>] [--json]
|
|
210
210
|
```
|
|
211
211
|
|
|
@@ -218,7 +218,7 @@ and update time. `--json` prints full session summaries in
|
|
|
218
218
|
`session` inspects the event stream for one session.
|
|
219
219
|
|
|
220
220
|
```bash
|
|
221
|
-
|
|
221
|
+
agent-sdk session <sessionId> [--url <baseUrl> | --prod]
|
|
222
222
|
[--slug <slug>] [--team <id>]
|
|
223
223
|
[--json | --text | --events]
|
|
224
224
|
```
|
|
@@ -234,7 +234,7 @@ same format. `--json` prints the trajectory object. `--events` prints
|
|
|
234
234
|
`playground` opens an agent's web playground.
|
|
235
235
|
|
|
236
236
|
```bash
|
|
237
|
-
|
|
237
|
+
agent-sdk playground [--url <baseUrl> | --prod] [--session <id>]
|
|
238
238
|
[--slug <slug>] [--team <id>]
|
|
239
239
|
[--bearer-token <token>] [--print]
|
|
240
240
|
```
|
|
@@ -254,7 +254,7 @@ it in a browser. You don't need an agent project.
|
|
|
254
254
|
|
|
255
255
|
```bash
|
|
256
256
|
npx @cursor/july docs
|
|
257
|
-
|
|
257
|
+
agent-sdk docs [--port <n>] [--host 127.0.0.1] [--print]
|
|
258
258
|
```
|
|
259
259
|
|
|
260
260
|
The site is the same VitePress build mounted at `/docs` on a running
|
|
@@ -267,11 +267,11 @@ the URL without opening a browser.
|
|
|
267
267
|
`run` sends one or more turns and prints a JSON result.
|
|
268
268
|
|
|
269
269
|
```bash
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
270
|
+
agent-sdk run --dir . --message "Is https://github.com/acme/checkout/pull/42 ready?"
|
|
271
|
+
agent-sdk run --dir . --message "Inspect PR 42" --message "Summarize the risks"
|
|
272
|
+
agent-sdk run --url http://127.0.0.1:3000/pr-approver --message "Inspect PR 42"
|
|
273
|
+
agent-sdk run --prod --slug pr-approver --team 123 --message "Inspect PR 42"
|
|
274
|
+
agent-sdk run --dir . --messages-file ./prompts.json
|
|
275
275
|
```
|
|
276
276
|
|
|
277
277
|
Without `--url` or `--prod`, the command starts an ephemeral server on
|
|
@@ -303,13 +303,13 @@ non-zero when the trajectory fails.
|
|
|
303
303
|
`call` invokes a server tool directly, with no model turn.
|
|
304
304
|
|
|
305
305
|
```bash
|
|
306
|
-
|
|
306
|
+
agent-sdk call inspect_pr --dir . \
|
|
307
307
|
--input '{"prUrl":"https://github.com/acme/checkout/pull/42"}'
|
|
308
|
-
|
|
308
|
+
agent-sdk call inspect_pr --url http://127.0.0.1:3000/pr-approver \
|
|
309
309
|
--input '{"prUrl":"https://github.com/acme/checkout/pull/42"}'
|
|
310
|
-
|
|
310
|
+
agent-sdk call refresh_cache --url http://127.0.0.1:3000/pr-approver \
|
|
311
311
|
--session ses_123
|
|
312
|
-
|
|
312
|
+
agent-sdk call inspect_pr --prod --slug pr-approver --team 123 --input '{}'
|
|
313
313
|
```
|
|
314
314
|
|
|
315
315
|
`call` sends `POST /v1/tools/:toolName` and runs the tool in the serving
|
|
@@ -330,17 +330,17 @@ response succeeds with `ok: true`. See
|
|
|
330
330
|
`eval` runs the project's filesystem evals.
|
|
331
331
|
|
|
332
332
|
```bash
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
333
|
+
agent-sdk eval --dir . --list # discovered datapoints
|
|
334
|
+
agent-sdk eval --dir . # run all
|
|
335
|
+
agent-sdk eval --dir . builds/checkout # one datapoint
|
|
336
|
+
agent-sdk eval --dir . builds # every datapoint in the file
|
|
337
|
+
agent-sdk eval --dir . --tag smoke # by tag (repeatable)
|
|
338
|
+
agent-sdk eval --dir . --json # machine-readable results
|
|
339
|
+
agent-sdk eval --dir . --verbose # stream t.log lines + reply snippets
|
|
340
|
+
agent-sdk eval --prod --slug pr-approver --team 123
|
|
341
341
|
# prints Eval ID immediately on --prod/--url; then:
|
|
342
|
-
|
|
343
|
-
|
|
342
|
+
agent-sdk eval status <evalId> --prod --slug pr-approver
|
|
343
|
+
agent-sdk eval cancel <evalId> --prod --slug pr-approver
|
|
344
344
|
```
|
|
345
345
|
|
|
346
346
|
`eval` runs `evals/**/*.eval.{ts,js}` on an ephemeral server or against
|
|
@@ -362,7 +362,7 @@ matching cases exit `2`. See [Evals](../evals.md).
|
|
|
362
362
|
`trajectory` summarizes a saved event stream.
|
|
363
363
|
|
|
364
364
|
```bash
|
|
365
|
-
|
|
365
|
+
agent-sdk trajectory --events /tmp/run.ndjson [--text]
|
|
366
366
|
```
|
|
367
367
|
|
|
368
368
|
`trajectory` converts a saved NDJSON stream into the trajectory JSON
|
|
@@ -374,9 +374,9 @@ non-zero when the reconstructed trajectory failed.
|
|
|
374
374
|
`init` scaffolds a new project.
|
|
375
375
|
|
|
376
376
|
```bash
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
377
|
+
agent-sdk init ./my-agent # scaffold package.json, tsconfig.json, agent/ + a demo tool
|
|
378
|
+
agent-sdk init ./my-agent --json # machine-readable summary for tooling
|
|
379
|
+
agent-sdk init # no directory: print the setup guide
|
|
380
380
|
```
|
|
381
381
|
|
|
382
382
|
`init` leaves existing files unchanged and labels each one `create` or
|
|
@@ -388,9 +388,9 @@ skills in `~/.cursor/skills/agentkit/`. If accepted, it overwrites them
|
|
|
388
388
|
with the version bundled in the installed package. The prompt is skipped
|
|
389
389
|
for `--json` and non-interactive hosts.
|
|
390
390
|
|
|
391
|
-
If the host isn't signed in, `init` runs `
|
|
392
|
-
the browser flow. It then prints the `cd`, `
|
|
393
|
-
`
|
|
391
|
+
If the host isn't signed in, `init` runs `agent-sdk login` and waits for
|
|
392
|
+
the browser flow. It then prints the `cd`, `agent-sdk login`, and
|
|
393
|
+
`agent-sdk dev` steps still needed.
|
|
394
394
|
|
|
395
395
|
With `--json`, `init` still installs dependencies but never blocks on
|
|
396
396
|
login or skill installation. It prints
|
|
@@ -402,7 +402,7 @@ login or skill installation. It prints
|
|
|
402
402
|
`info` prints the discovered agent surface.
|
|
403
403
|
|
|
404
404
|
```bash
|
|
405
|
-
|
|
405
|
+
agent-sdk info --dir . [--json]
|
|
406
406
|
```
|
|
407
407
|
|
|
408
408
|
`info` reports the model, instruction size, tools, skills, MCP
|
|
@@ -417,7 +417,7 @@ exit status.
|
|
|
417
417
|
`validate` checks the project and sets the exit code.
|
|
418
418
|
|
|
419
419
|
```bash
|
|
420
|
-
|
|
420
|
+
agent-sdk validate --dir .
|
|
421
421
|
```
|
|
422
422
|
|
|
423
423
|
`validate` prints diagnostics for each agent and exits non-zero when any
|
|
@@ -429,9 +429,9 @@ are present. Warnings don't change the exit status.
|
|
|
429
429
|
Three commands manage the host's Cursor credential.
|
|
430
430
|
|
|
431
431
|
```bash
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
432
|
+
agent-sdk login [--api-key <key>] [--key-name <name>]
|
|
433
|
+
agent-sdk whoami [--json]
|
|
434
|
+
agent-sdk logout
|
|
435
435
|
```
|
|
436
436
|
|
|
437
437
|
`login` signs the host in to Cursor: browser sign-in mints a named,
|
|
@@ -456,10 +456,10 @@ the other.
|
|
|
456
456
|
`update` upgrades an installed copy to the latest published version.
|
|
457
457
|
|
|
458
458
|
```bash
|
|
459
|
-
|
|
459
|
+
agent-sdk update
|
|
460
460
|
```
|
|
461
461
|
|
|
462
|
-
The command checks npm's `latest` tag, detects how
|
|
462
|
+
The command checks npm's `latest` tag, detects how the Agent SDK was installed,
|
|
463
463
|
and runs the matching npm, pnpm, Yarn, or Bun upgrade command. It handles
|
|
464
464
|
global installs and project dependencies. It doesn't prompt before
|
|
465
465
|
running the package-manager command.
|
|
@@ -476,7 +476,7 @@ commands with an explicit `--json` flag skip this automatic check.
|
|
|
476
476
|
`deploy` sends one or more agents to Cursor managed hosting.
|
|
477
477
|
|
|
478
478
|
```bash
|
|
479
|
-
|
|
479
|
+
agent-sdk deploy [--dir <path>] [--slug <slug> | --all] [--team <id>]
|
|
480
480
|
[--repo <https-url>] [--ref <git-ref>] [--path <agent-path>]
|
|
481
481
|
[--cursor-events-repo owner/name]...
|
|
482
482
|
[--allow-domain <domain>]... [--no-wait] [--json]
|
|
@@ -525,7 +525,7 @@ state layout.
|
|
|
525
525
|
`deployments` lists the selected team's deployments.
|
|
526
526
|
|
|
527
527
|
```bash
|
|
528
|
-
|
|
528
|
+
agent-sdk deployments [--team <id>] [--json]
|
|
529
529
|
```
|
|
530
530
|
|
|
531
531
|
Text output shows each slug, status, generation, deployment kind, and
|
|
@@ -536,7 +536,7 @@ update time. `--json` prints `{ deployments }`.
|
|
|
536
536
|
`deployment` prints the full status of one deployment.
|
|
537
537
|
|
|
538
538
|
```bash
|
|
539
|
-
|
|
539
|
+
agent-sdk deployment <slug> [--team <id>] [--json]
|
|
540
540
|
```
|
|
541
541
|
|
|
542
542
|
Text output includes status, generation, kind, alias, source, egress
|
|
@@ -549,7 +549,7 @@ domains, secret names, engine state, and the last error when present.
|
|
|
549
549
|
`stop` shuts down a deployment.
|
|
550
550
|
|
|
551
551
|
```bash
|
|
552
|
-
|
|
552
|
+
agent-sdk stop <slug> [--team <id>] [--no-wait] [--json]
|
|
553
553
|
```
|
|
554
554
|
|
|
555
555
|
The command polls for up to ten minutes until the status reaches
|
|
@@ -561,7 +561,7 @@ The command polls for up to ten minutes until the status reaches
|
|
|
561
561
|
playground.
|
|
562
562
|
|
|
563
563
|
```bash
|
|
564
|
-
|
|
564
|
+
agent-sdk rotate-token <slug> [--team <id>] [--json]
|
|
565
565
|
```
|
|
566
566
|
|
|
567
567
|
The old token stops working immediately. The replacement is shown once.
|
|
@@ -573,7 +573,7 @@ The old token stops working immediately. The replacement is shown once.
|
|
|
573
573
|
engine pod.
|
|
574
574
|
|
|
575
575
|
```bash
|
|
576
|
-
|
|
576
|
+
agent-sdk rotate-pod-credential <slug> [--team <id>] [--json]
|
|
577
577
|
```
|
|
578
578
|
|
|
579
579
|
The command returns only the masked key and revokes the old credential
|
|
@@ -589,12 +589,12 @@ connection with a browser PKCE flow. Tokens are written to
|
|
|
589
589
|
`MCP_OAUTH_<CONNECTION>_*` secrets on the hosted deployment.
|
|
590
590
|
|
|
591
591
|
```bash
|
|
592
|
-
|
|
592
|
+
agent-sdk mcp oauth <connection> [--dir .] [--store] [--slug <slug>] [--team <id>]
|
|
593
593
|
```
|
|
594
594
|
|
|
595
595
|
`<connection>` is the `agent/mcp-connections/<connection>.ts` basename.
|
|
596
596
|
`--slug` defaults to the `--dir` basename. `--team` defaults to the
|
|
597
|
-
signed-in account's team. You need `
|
|
597
|
+
signed-in account's team. You need `agent-sdk login` (or `--api-key`)
|
|
598
598
|
before `--store`.
|
|
599
599
|
|
|
600
600
|
Secret names are `MCP_OAUTH_<NAME>_ACCESS_TOKEN`,
|
|
@@ -612,9 +612,9 @@ See the [Host MCP OAuth guide](../guides/mcp-oauth.md).
|
|
|
612
612
|
`secrets` manages environment secrets for a deployment.
|
|
613
613
|
|
|
614
614
|
```bash
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
615
|
+
agent-sdk secrets set <slug> NAME[=VALUE]... [--team <id>] [--json]
|
|
616
|
+
agent-sdk secrets list <slug> [--team <id>] [--json]
|
|
617
|
+
agent-sdk secrets unset <slug> NAME [--team <id>] [--json]
|
|
618
618
|
```
|
|
619
619
|
|
|
620
620
|
Omit `=VALUE` from `secrets set` to enter the value at a hidden TTY
|
|
@@ -634,25 +634,56 @@ and `{ removed }` for `unset`.
|
|
|
634
634
|
|
|
635
635
|
## slack
|
|
636
636
|
|
|
637
|
-
The `slack` pack generates and checks Socket Mode channel
|
|
637
|
+
The `slack` pack provisions, generates, and checks Socket Mode channel
|
|
638
|
+
setup.
|
|
638
639
|
|
|
639
640
|
```bash
|
|
640
|
-
|
|
641
|
-
|
|
641
|
+
agent-sdk slack setup
|
|
642
|
+
agent-sdk slack create [--dir <path>] [--name <name>] [--prod]
|
|
643
|
+
[--slack-team <T…>] [--team <id>]
|
|
644
|
+
[--icon <https-url-or-file>] [--force]
|
|
645
|
+
[--prefix <prefix> | --no-prefix] [--json]
|
|
646
|
+
agent-sdk slack destroy [--dir <path>] [--prod] [--slack-team <T…>]
|
|
647
|
+
[--team <id>] [--json]
|
|
648
|
+
agent-sdk slack icon <https-url-or-file> [--dir <path>] [--prod]
|
|
649
|
+
[--slack-team <T…>] [--team <id>] [--json]
|
|
650
|
+
agent-sdk slack init [--dir <path>] [--name <name>]
|
|
642
651
|
[--prefix <prefix> | --no-prefix] [--channel-posts]
|
|
643
|
-
|
|
652
|
+
agent-sdk slack manifest [--dir <path>] [--name <name>]
|
|
644
653
|
[--env dev|prod|both] [--channel-posts] [--print]
|
|
645
|
-
|
|
654
|
+
agent-sdk slack doctor [--prefix <prefix>] [--json]
|
|
646
655
|
```
|
|
647
656
|
|
|
648
657
|
`slack setup` prints a guided checklist and doesn't change files.
|
|
649
658
|
|
|
659
|
+
`slack create` provisions a dedicated Socket Mode app through Cursor's
|
|
660
|
+
Add to Slack API instead of the manual manifest import. It requires a
|
|
661
|
+
signed-in host (`agent-sdk login` or `CURSOR_API_KEY`) and the
|
|
662
|
+
provisioning feature to be enabled for the account. The command
|
|
663
|
+
scaffolds the channel file when missing, opens the browser consent flow
|
|
664
|
+
when the workspace isn't connected to Cursor yet, creates and installs
|
|
665
|
+
the app, writes the bot and app-level tokens into `<dir>/.env.local`,
|
|
666
|
+
and ends with a `doctor` pass. `--prod` provisions the production app;
|
|
667
|
+
the default is the development app. When the install needs a Slack
|
|
668
|
+
workspace admin's approval, the command prints the approval page and
|
|
669
|
+
exits non-zero; re-run it after the approval to finish and mint the
|
|
670
|
+
tokens. A re-run rebuilds the manifest from the command's flags and
|
|
671
|
+
refuses to overwrite edits made by hand in Slack unless you pass
|
|
672
|
+
`--force`.
|
|
673
|
+
|
|
674
|
+
`slack destroy` deletes the provisioned app for the selected
|
|
675
|
+
environment. Tokens already written to `.env.local` stay in place and
|
|
676
|
+
stop working.
|
|
677
|
+
|
|
678
|
+
`slack icon` sets the provisioned app's icon from an https image URL or
|
|
679
|
+
a local png, jpg, or gif file of at most 512KB.
|
|
680
|
+
|
|
650
681
|
`slack init` creates the channel file, development and production
|
|
651
682
|
manifests, `env.example`, and setup status under the project. It refuses
|
|
652
683
|
to overwrite a target file. If a collision occurs, it exits non-zero;
|
|
653
684
|
files created earlier in the run remain. The token prefix defaults to
|
|
654
685
|
the directory basename normalized to uppercase snake case. Explicit
|
|
655
|
-
`--prefix` values use the same normalization when
|
|
686
|
+
`--prefix` values use the same normalization when the Agent SDK builds token
|
|
656
687
|
variable names. For example, `pr-approver` becomes
|
|
657
688
|
`PR_APPROVER_SLACK_BOT_TOKEN`. `--no-prefix` uses shared
|
|
658
689
|
`SLACK_BOT_TOKEN` and `SLACK_APP_TOKEN`. `--channel-posts` subscribes
|
|
@@ -676,12 +707,12 @@ The `github` pack discovers `githubChannel()` definitions and sends live
|
|
|
676
707
|
or synthesized deliveries to them.
|
|
677
708
|
|
|
678
709
|
```bash
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
710
|
+
agent-sdk github doctor [--install] [--json]
|
|
711
|
+
agent-sdk github events [--dir <path>] [--host <host>] [--port <n>] [--json]
|
|
712
|
+
agent-sdk github forward [--dir <path>] [--slug <slug>] [--channel <id>]
|
|
682
713
|
[--repo owner/repo | --org <org>] [--events a,b,c] [--url <url>]
|
|
683
714
|
[--host <host>] [--port <n>] [--secret <secret>] [--install]
|
|
684
|
-
|
|
715
|
+
agent-sdk github replay <pr-url|owner/repo#N> --dir .
|
|
685
716
|
[--events a,b,c|'*'] [--action <action>] [--conclusion <result>]
|
|
686
717
|
[--comment <body>] [--context <name>] [--slug <slug>] [--channel <id>]
|
|
687
718
|
[--host <host>] [--port <n>] [--url <url>] [--secret <secret>]
|
|
@@ -42,8 +42,8 @@ export default defineConnection({
|
|
|
42
42
|
```
|
|
43
43
|
|
|
44
44
|
```bash
|
|
45
|
-
|
|
46
|
-
|
|
45
|
+
agent-sdk mcp oauth inventory # browser PKCE → local mcp-auth.json
|
|
46
|
+
agent-sdk mcp oauth inventory --store # also upsert deployment secrets
|
|
47
47
|
```
|
|
48
48
|
|
|
49
49
|
Full walkthrough: [Host MCP OAuth](../guides/mcp-oauth.md). Companion
|
|
@@ -94,7 +94,7 @@ export default defineConnection({
|
|
|
94
94
|
});
|
|
95
95
|
```
|
|
96
96
|
|
|
97
|
-
The host must be signed in (`
|
|
97
|
+
The host must be signed in (`agent-sdk login` or `CURSOR_API_KEY`).
|
|
98
98
|
`serve` fails fast at startup otherwise, and logs each connector's live
|
|
99
99
|
status (`connected`, `needsAuth`, `error`) as it starts.
|
|
100
100
|
|
|
@@ -5,7 +5,7 @@ description: "Every route the server mounts: sessions, approvals, deterministic
|
|
|
5
5
|
|
|
6
6
|
# HTTP API reference
|
|
7
7
|
|
|
8
|
-
Every
|
|
8
|
+
Every Agent SDK host speaks the same stable HTTP API. In the default
|
|
9
9
|
multi-agent layout each agent is namespaced under its slug
|
|
10
10
|
(`/<slug>/v1/session`, `/<slug>/playground`), with host-level routes at
|
|
11
11
|
the root. With `--mode single`, one agent serves the same surface
|
|
@@ -132,7 +132,7 @@ Five read-only routes describe the running agent.
|
|
|
132
132
|
|
|
133
133
|
| Route | What it does |
|
|
134
134
|
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
135
|
-
| `GET /v1/info` | The manifest snapshot: model, tools, skills, MCP connections, subagents, channels and routes (with schemas), schedules, hooks, A/B experiments, diagnostics; the same shape as `
|
|
135
|
+
| `GET /v1/info` | The manifest snapshot: model, tools, skills, MCP connections, subagents, channels and routes (with schemas), schedules, hooks, A/B experiments, diagnostics; the same shape as `agent-sdk info --json` |
|
|
136
136
|
| `GET /v1/health` | Per-agent liveness, no auth |
|
|
137
137
|
| `GET /v1/meta` | SPA bootstrap: agent name, dev flag, base path (no auth) |
|
|
138
138
|
| `GET /v1/logs?after=N` | Recent server log lines from the ring buffer, with a polling cursor |
|
|
@@ -5,9 +5,9 @@ description: "The folder structure under agent/ and the path-derived naming rule
|
|
|
5
5
|
|
|
6
6
|
# Project layout
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
The Agent SDK builds an agent by walking the filesystem under `agent/`.
|
|
9
9
|
Each folder has a defined purpose. The path a file lands in determines
|
|
10
|
-
how
|
|
10
|
+
how the Agent SDK loads it.
|
|
11
11
|
|
|
12
12
|
## Folder structure
|
|
13
13
|
|
|
@@ -92,9 +92,9 @@ Each path maps to a capability and a reference page.
|
|
|
92
92
|
`agent/` is discovery surface. A stray `.ts` file in one of these
|
|
93
93
|
folders is treated as a definition.
|
|
94
94
|
|
|
95
|
-
## Why didn't
|
|
95
|
+
## Why didn't the Agent SDK discover my file?
|
|
96
96
|
|
|
97
|
-
Run `
|
|
97
|
+
Run `agent-sdk validate --dir .` and `agent-sdk info --dir .`.
|
|
98
98
|
`validate` prints diagnostics, and `serve` refuses to start on
|
|
99
99
|
error-severity ones. Warnings, such as cloud runtime combined with
|
|
100
100
|
local-only capabilities, print but don't block. `info` lists the discovered
|
|
@@ -103,9 +103,9 @@ there, check the folder reference: the file is usually in the wrong directory
|
|
|
103
103
|
or has the wrong extension.
|
|
104
104
|
|
|
105
105
|
```bash
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
106
|
+
agent-sdk validate --dir . # diagnostics; non-zero exit on errors
|
|
107
|
+
agent-sdk info --dir . # human-readable surface
|
|
108
|
+
agent-sdk info --dir . --json # machine-readable manifest (same shape as GET /v1/info)
|
|
109
109
|
```
|
|
110
110
|
|
|
111
111
|
## What's next
|
|
@@ -66,7 +66,7 @@ and `host` (shared services: `host.mcp`, `host.github`, `host.slack`,
|
|
|
66
66
|
|
|
67
67
|
### Dispatch and dev mode
|
|
68
68
|
|
|
69
|
-
In production (`
|
|
69
|
+
In production (`agent-sdk serve`), schedules fire on their cron
|
|
70
70
|
cadence. Disable them with `--no-schedules`. There's no cross-host
|
|
71
71
|
coordination, so run them in exactly one process per project.
|
|
72
72
|
|