Skip to content

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

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

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

Conversation

@jamesbxwu

@jamesbxwu jamesbxwu commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Make the Agent Bricks README a short getting-started path: prerequisites, installation, framework choice, local and deployed verification, a command-line invocation, and a first custom Python tool. The README is now 161 lines, down from 1,145 before this PR.
  • Move dependency inputs and the resource/state lifecycle matrix into a deployment guide, and scaffold ownership and upgrades into a separate guide for owners of generated agents.
  • Move AgentKit SDK, memory, and session examples into a state guide. Keep detailed managed tools, runtime, migration, and CLI material in their task references, with README links to each.
  • Keep repository development and testing instructions in CONTRIBUTING.md.

Verification

  • Checked local Markdown paths and anchors across the edited guides.
  • Parsed Python and TOML fenced examples and the README invocation JSON; verified the deployed App OAuth requirement against CLI source.
  • git diff --check and the repository commit hook passed.
  • Live workspace integration tests were not run for this documentation change.

Tracking: ML-70356

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

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