Skip to content

[ML-70356] [m] Reorganize Agent Bricks getting-started docs - #685

Draft
jamesbxwu wants to merge 4 commits into
mainfrom
james-wu/agentbricks-readme-ml-70356
Draft

jamesbxwu wants to merge 4 commits into
mainfrom
james-wu/agentbricks-readme-ml-70356

Conversation

@jamesbxwu

@jamesbxwu jamesbxwu commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

The Agent Bricks README put architecture and API details ahead of setup, customization, and maintenance. Move a complete framework-specific Quickstart and working Python tool example to the top, then link to focused guides for deployment, resources, upgrades, memory/sessions, tools, migration, and coding-agent skills.

The deployment guide distinguishes the Runtime Store, conversation state, and memory; explains create/reuse/delete behavior; and documents dependency inputs and the excluded local lockfile. The upgrade guide separates installed library updates from copied template changes, with version checks and a comparison workflow that preserves custom code.

Refresh the guides against current main: managed Runtime Store defaults, automatic store detach, UC request-user tools, volume-only sandbox scopes, memory put/four-tool behavior, and persisted OpenAI approval checkpoints. The approval section explicitly identifies the fix as newer than PyPI 0.5.1 and explains the copied-harness adoption requirements. Keep the existing telemetry disclosure and workflow/cleanup documentation accessible after the reorganization.

Validation:

  • 189 focused scaffold, skill, CLI, Runtime Store provisioning, and unbind/grant tests passed.
  • Generated both framework projects using the real CLI, added the documented tool, and invoked each framework's discovered tool: both returned 4. Confirmed init refuses to overwrite the customized project.
  • Checked 122 local Markdown paths/anchors and parsed 9 Python plus 8 TOML fenced examples. git diff --check passed.
  • Documentation/source verification only; no new live deployment or current-PyPI-wheel installation is claimed. Optional private integration testing is coordinated separately.

Tracking: ML-70356

Public CI baseline: the framework job fails the same six memory-backed parallel-history ordering cases as current main (expected last/first, observed first/last). Confirmed independently against main run https://github.com/databricks/databricks-ai-bridge/actions/runs/38662891535/job/116188048864; no forced skips. Other checks are tracked separately.

Bug-bash integration validation

The test-only combined branch at be2fa8ee8d6d3b3e011ecfa285e6455b90f9433a contains this exact PR head and eleven other reviewed heads. Its Agent Bricks unit suite passed 2,154 tests, 24 skipped. This is combined-source validation, not an isolated run of this PR; the branch must not be merged into main.

Private run 38698567494 passed all 20 live Claude cache tests at e231ca2 (OpenAI 8, LangGraph 4, generated adapters 8). Run 38701390693 at 53f9db8 passed OpenAI 8, LangGraph 4 and 3 adapter cases; the remaining 5 adapter cases returned HTTP403 because the shared test-workspace Gateway budget reached its $10 limit. Production source is identical across those runs and the final combined source; later changes affect only matrix fixtures, cleanup, regression tests and documentation. The rerun is not all green, and no budgets were changed.

The corrected Apps test passed 20/20 matrix rows, two grant snapshots, transitive-permission controls and repeat-deploy idempotency. Its evidence confirms clean source and wheel/source matching. That live run predates the final cleanup correction: the harness recorded twelve successful cleanup operations but omitted the implicit Runtime Store/role for direct-authoring Apps. #752 now includes ownership-checked cleanup for every App and safe retry/evidence handling, covered by focused regressions and the final unit suite. No new full model matrix was run for those cleanup-only changes.

Independent read-only run 38708044949 confirmed all 13 exact prior-run resources absent, including three consecutive typed404 observations for the omitted Runtime Store, dedicated database and role. One separate current-window database/role pair remains present and unattributed: SCIM did not recover its App identity and one bounded audit SELECT failed. That pair was left intact; full cleanup of the current matrix run is not established. No resources were deleted using name/time correlation alone.

The Apps matrix covers LangGraph, CLI/direct authoring, dev/deployed runtime and five tool kinds. Separate cache tests cover both LangGraph and OpenAI Agents. These checks do not establish fresh-account provisioning rights or freshly consented deployed Genie OBO acceptance.

All public checks finished. #694/#727 have 54 green; the other ten PRs have 53 green and the same framework job red. Its six memory-backed parallel-history ordering failures also occur on current main. No forced skips or weakened grant assertions were applied.

Comment thread integrations/agentbricks/README.md Outdated
Comment on lines +38 to +39
Create a project using LangGraph (the default framework). Use `--framework openai` instead to
create an **OpenAI Agents SDK** project. This chooses the agent framework, not the model provider;

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Create a project using LangGraph (the default framework). Use `--framework openai` instead to
create an **OpenAI Agents SDK** project. This chooses the agent framework, not the model provider;
Create your new agent project (with default framework of LangGraph). Use `--framework openai` instead to
create an **OpenAI Agents SDK** project. This chooses the agent framework, not the model provider;

Comment thread integrations/agentbricks/README.md Outdated
Comment on lines +96 to +102
```sh
SESSION_ID=$(python3 -c 'import uuid; print(uuid.uuid4())')
INVOCATION_ID=$(python3 -c 'import uuid; print(uuid.uuid4())')
agentbricks endpoint invoke --url http://localhost:8000 \
--path /api/invocations \
--json "{\"id\":\"$INVOCATION_ID\",\"session_id\":\"$SESSION_ID\",\"input\":{\"messages\":[{\"role\":\"user\",\"content\":\"Use count_words to count the words in: the quick brown fox\"}]}}"
```

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It feels weird that we're introducing the invoke command for the first time only down here in the tool section. Should it be moved up after you do dev or deploy?

Comment thread integrations/agentbricks/README.md Outdated
output for access or tracing warnings. `deployments get` prints the App URL and status; open the URL
and send a message to verify the deployed agent.

## Add a custom tool

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why should the custom tool here be in the quick start instead of later on?

Comment thread integrations/agentbricks/README.md Outdated
memory = memory.update(content="The user prefers very concise answers.")
memory.delete()
```
## Project ownership and upgrades

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this more about a dev guide and less of a user guide?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in general I still and we need to be very hard to follow. I see this as a combination of helping the user to get started and teaching them how to do things, but then there's also a combination of how developers could iterate on this. I feel like the split is not exactly clear. Is there a better way that we can structure?

@jamesbxwu jamesbxwu changed the title [ML-70356] Clarify Agent Bricks setup and lifecycle in README [ML-70356] Reorganize Agent Bricks getting-started docs Oct 3, 2026
@jamesbxwu
jamesbxwu marked this pull request as draft October 15, 2026 07:16
@jamesbxwu jamesbxwu changed the title [ML-70356] Reorganize Agent Bricks getting-started docs [ML-70356] [m] Reorganize Agent Bricks getting-started docs Oct 15, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant