docs(studio): document the Node path and lead the nav with Studio - #885
Merged
0xlucasliao merged 2 commits intoAug 25, 2026
Merged
Conversation
The Studio quickstart and overview described a product that does not ship. Verified against the published @bnbagent/studio-cli 0.0.12 tarball: quickstart.md — every one of these was wrong, not merely stale: - "Framework Google ADK (--framework adk)": zero trace of ADK anywhere in the package — not in package.json deps, not in any skill or recipe. - Python workspace layout (main.py, signing.py, managed_model.py, service.py): the scaffold is TypeScript. The recipes emit sellerCore.ts, signing.ts, tools.ts, main.ts, mcpMain.ts, dualMain.ts. - "npm install -g @aws/agentcore # Node >= 20": the requirement is Node >= 22 (engines.node), cloud lifecycle is delegated to the pinned @bnbagent/deploy-cli, and the AWS CLI is optional — used only by a read-only AgentCore quota check. Rewritten around what actually ships: skill-first workflow, the six-stage journey, the real generated tree, and the three deploy targets. Azure Foundry is included: recipe status is v1, `bag deploy --provider azure` is real, and it deploys A2A scaffolds only (MCP is rejected before deploy). The studio-cli README omits Azure entirely, which is why it was missed. index.md — replaced the two-layer Layer A / Layer B keyless model with the shipped "one runtime, one signer": one process serving composable A2A (:9000) / MCP (:8000/mcp) / X402 (/x402) faces, holding the only key, signing in fixed code. Dropped "v0.0.1 is seller-only ... deferred to v2" and the Python package names (bnbagent_studio_core) in favour of @bnbagent/studio-runtime and @bnbagent/deploy-cli. Added an explicit Studio-vs-SDK table, since conflating the two is the most common confusion. Nav: Developer Kit now leads with BNB Agent Studio, ahead of the SDK, matching the agentic-first ordering the marketing site already uses. The developer-kit landing table is reordered to match. Not in this PR: bnbchain-studio/architecture.md still documents the Layer A / Layer B model and needs the same treatment.
Pull Request ReviewThis PR rewrites the BNB Agent Studio overview and quickstart to match the published TypeScript-based CLI, documenting the skill-first workflow, generated project structure, single-runtime signing model, payment rails, and BNB/AWS/Azure deployment paths. It also clarifies the distinction between Studio and the SDK and moves BNB Agent Studio ahead of the SDK in the Developer Kit landing page and MkDocs navigation. Sensitive ContentNo sensitive content detected. Security IssuesNo serious security issues detected. Generated by Hashdit Bot. This tool can absolutely NOT replace manual audits. |
Contributor
Author
|
Heads-up on merge order: this PR and #884 both edit the same Suggested order: merge this one first, then rebase #884 — the resolution is mechanical (keep Studio-above-SDK here, plus #884's two quickstart lines inside the SDK block). |
The generated tree listed `main.ts` as the A2A/X402 entrypoint. No such
file is emitted. The recipes ship three entrypoint templates and none of
them is main.ts:
recipes/runtimes/agentcore/code/{{PKG}}/unifiedMain.ts.tmpl
recipes/runtimes/agentcore/code/{{PKG}}/mcpMain.ts.tmpl
recipes/runtimes/agentcore/code/{{PKG}}/dualMain.ts.tmpl
recipes/runtimes/azure-foundry/code/{{PKG}}/unifiedMain.ts.tmpl
recipes/runtimes/azure-foundry/code/{{PKG}}/mcpMain.ts.tmpl
`find recipes -name 'main.ts.tmpl'` returns nothing. The name came from
the studio-cli README's own tree (README.md:138), which is wrong; the
skill body and the recipes agree on unifiedMain.ts.
Also notes the ports each entrypoint binds, and that dualMain.ts is
AgentCore-only — azure-foundry ships no dualMain template, consistent
with Foundry deploying A2A scaffolds only.
Pull Request ReviewThis documentation-only PR rewrites the BNB Agent Studio overview and quickstart to match the shipped TypeScript CLI/runtime architecture, deployment targets, generated project layout, payment flows, and safety guidance. It also moves BNB Agent Studio ahead of the BNB Agent SDK in the Developer Kit landing page and MkDocs navigation. Sensitive ContentNo sensitive content detected. Security IssuesNo serious security issues detected. Generated by Hashdit Bot. This tool can absolutely NOT replace manual audits. |
0xlucasliao
pushed a commit
that referenced
this pull request
Aug 25, 2026
Completes the sweep started in #885 and #886. Verified against the published @bnbagent/studio-cli 0.0.12 tarball. deployment.md — rewritten. It described shipping "two artifacts": Layer A to AgentCore and Layer B to EC2/Fargate, with `bag deploy agent` + `bag deploy package` + a manual EC2 upload. One runtime ships now, and every deploy explicitly selects bnb | aws | azure. Documents the real per-target constraints (48h testnet trial runs in the operator's cloud so signing material leaves your control; Azure is container-only and A2A-only) and the per-target secret channel (Secrets Manager / Foundry CustomKeys / managed store). Notes that local deliverable storage fails readiness by design, and that cloud lifecycle is delegated to the pinned @bnbagent/deploy-cli — no azd, no azure.yaml in the scaffold. configuration.md — dropped the second `app/service/studio.toml` config and the keyless-Service env section; one runtime means one studio.toml. `--project-root app/service` no longer exists. cli-reference.md — removed `bag deploy prepare --include-service-preflight` (absent from the shipped CLI) and the Python flat-imports section. Fixed `bag erc8004 register --endpoint .../apex/`: no `apex` route exists in the package; the runtime serves /readiness, /invocations, /responses, /mcp and /x402. troubleshooting.md — replaced the two-studio.toml drift check, the `main.py` flat-import advice, and the `@aws/agentcore` + Node>=20 prerequisite. Retargeted the funded-jobs checklist at the single runtime and /readiness, and noted settle is manual. demo.md — NOT rewritten, deliberately. It is a 610-line walkthrough of recorded IDE transcripts and command output. A faithful version has to be executed to be trustworthy, not adapted on paper; inferring one would produce a confident guide that does not work. Added a prominent banner pointing at the current Quickstart and Architecture, and fixed a pre-existing broken link (../../bnbagent-sdk/networks.md was one level too deep). Verified: the four rewritten pages contain zero stale markers, and all 37 relative links across the studio doc set resolve.
0xlucasliao
approved these changes
Aug 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The Studio docs described a product that does not ship. This rewrites the two entry pages against the published
@bnbagent/studio-cli@0.0.12tarball, and moves Studio to the front of the Developer Kit nav.quickstart.md— these were wrong, not merely stale--framework adk)"package.jsondeps, not in any skill or recipe filemain.py,signing.py,managed_model.py,service.pysellerCore.ts,signing.ts,tools.ts,main.ts,mcpMain.ts,dualMain.tsnpm install -g @aws/agentcore # Node ≥ 20engines.node); cloud lifecycle delegated to the pinned@bnbagent/deploy-cli; AWS CLI optional, used only by a read-only quota checkRewritten around what ships: the skill-first workflow, the six-stage journey, the real generated tree, and the three deploy targets.
Azure Foundry is included —
recipes/runtimes/azure-foundry/recipe.tomlisstatus = "v1",bag deploy --provider azureis real, and it deploys A2A scaffolds only (MCP is rejected before a Foundry deploy). Worth flagging upstream: thestudio-cliREADME never mentions Azure and its deployment table says "Every deploy asks forbnboraws", which is why this was easy to miss.index.md— the two-layer model is goneReplaced Layer A / Layer B (
app/service/→ EC2/Fargate, "keyless", "no LLM, no sign") with the shipped one runtime, one signer: a single process serving composable A2A (:9000) / MCP (:8000/mcp) / X402 (/x402) faces, holding the only key, signing in fixed code atapp/agent/src/signing.ts.Also:
bnbagent_studio_core) with@bnbagent/studio-runtimeand@bnbagent/deploy-cliNav
Developer Kit now leads with BNB Agent Studio, ahead of the SDK, matching the agentic-first ordering the marketing site already uses. The developer-kit landing table is reordered to match.
Verification
mkdocs.ymlparses; all 33developer-kitnav paths resolveGoogle ADK|--framework adk|main.py|managed_model.py|@aws/agentcore|Node ≥ 20|Layer A|Layer B|keyless|EC2|Fargate|bnbagent_studio_core|seller-only|deferred to v2across both pages returns only one deliberate hit: the sentence "There is no separate keyless service tier."Not in this PR
bnbchain-studio/architecture.mdstill documents the Layer A / Layer B model in full (diagram,app/service/service.py, keyless boundary invariants) and needs the same treatment. Kept separate to stay reviewable.