Skip to content

Commit fc3d17a

Browse files
docs: Update hello-world.mdx (#1324)
* docs: Update hello-world.mdx Signed-off-by: Jenna Winkler <[email protected]> --------- Signed-off-by: Jenna Winkler <[email protected]>
1 parent bcf4d8b commit fc3d17a

File tree

1 file changed

+33
-25
lines changed

1 file changed

+33
-25
lines changed

docs/introduction/hello-world.mdx

Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,30 @@ title: "Build Hello World"
33
description: "Start building your own agent with a simple Hello World example"
44
---
55

6-
Now that your BeeAI Platform is up and running, and you have a basic understanding of how to run the agent via either the GUI or CLI, let’s get to some coding.
6+
Now that your BeeAI Platform is up and running, and you know how to run an agent via the GUI or CLI, it’s time to create your first agent.
77

8-
To build an agent that automatically appears in the platform, all you need to do is use the BeeAI SDK library, which handles the registration process for you.
9-
10-
Although building a “Hello World” agent is straightforward, we’ve streamlined the process for you with a starter repository that you can begin editing right away.
8+
With the BeeAI SDK, you can build an agent that automatically registers with the platform — no extra setup required.
119

10+
To make things even easier, we’ve provided a starter repository. You can clone it and start coding immediately, so you can focus on your agent logic instead of boilerplate setup.
1211

1312
## Prerequisites
1413

15-
- BeeAI Platform installed (see [Quickstart](/introduction/quickstart))
14+
- BeeAI Platform installed ([Quickstart](/introduction/quickstart))
1615
- [uv](https://docs.astral.sh/uv/) package manager (should be already installed if you followed the quickstart)
1716

1817
## Start From Template
1918

2019
<Steps>
21-
<Step title="Use the official starter template to get started quickly.">
20+
<Step title="Use the official starter template">
2221
<Tabs>
23-
<Tab title="Clone Directly">
22+
<Tab title="Clone directly">
2423
```bash
2524
git clone https://github.com/i-am-bee/beeai-platform-agent-starter my-agent
2625
cd my-agent
2726
```
2827
</Tab>
2928
<Tab title="Use as a GitHub template">
30-
1. Go to [the template repository](https://github.com/i-am-bee/beeai-platform-agent-starter)
29+
1. Go to the [template repository](https://github.com/i-am-bee/beeai-platform-agent-starter)
3130
2. Click "Use this template" → "Create a new repository"
3231
3. Clone your new repository locally
3332
</Tab>
@@ -40,9 +39,17 @@ cd my-agent
4039
uv run server
4140
```
4241

42+
<Tip>
43+
**Enable auto-reload during development:** Add `watchfiles` to automatically restart your server when code changes:
44+
```bash
45+
uv run watchfiles beeai_agents.agent.run
46+
```
47+
</Tip>
48+
4349
</Step>
44-
<Step title="Then in another terminal">
50+
<Step title="Run your agent">
4551

52+
In another terminal:
4653

4754
```bash
4855
beeai run example_agent "Alice"
@@ -52,13 +59,13 @@ beeai run example_agent "Alice"
5259

5360
You should see: "Ciao Alice!" 🎉
5461

55-
With your first agent up and running, you can now modify the code to do whatever you want.
62+
With your first agent running, you can now modify it to do anything you want.
5663

5764
## Implement Your Agent Logic
5865

59-
Navigate to [src/beeai_agents/agent.py](https://github.com/i-am-bee/beeai-platform-agent-starter/blob/main/src/beeai_agents/agent.py) and replace the example with your agent implementation.
66+
Navigate to [src/beeai_agents/agent.py](https://github.com/i-am-bee/beeai-platform-agent-starter/blob/main/src/beeai_agents/agent.py) and replace the example with your agent logic.
6067

61-
The example implementation doesn’t do much. It’s intended purely for demonstration purposes.
68+
The starter example is minimal and intended for demonstration purposes only:
6269

6370
```python
6471
import os
@@ -98,7 +105,7 @@ Add the `@server.agent` decorator to your function so the platform recognizes it
98105
</Step>
99106

100107
<Step title="Name your agent">
101-
Whatever you name the function will be the agent’s name in the platform.
108+
The function name becomes the agent’s name in the platform.
102109
</Step>
103110

104111
<Step title="Describe your agent">
@@ -127,19 +134,20 @@ The agent function should be asynchronous and yield results as they’re ready.
127134

128135
## Starting from Scratch
129136

130-
Want to build your agent without using our starter repo?
131-
132-
All you need to do is set up an empty Python project, install `beeai-sdk` as a dependency, and then use the code above.
137+
If you prefer not to use the starter repo:
138+
- Create an empty Python project
139+
- Install `beeai-sdk`
140+
- Copy the example code above
133141

134-
There’s no magic in the starter repo. It simply provides some basic Python scaffolding, a simple GitHub workflow, and a Dockerfile, most of which are entirely optional.
142+
The starter repo mainly provides basic scaffolding, a GitHub workflow, and a Dockerfile — all optional.
135143

136144
## Next Steps
137145

138-
Now that you've built your Hello World agent, you can:
139-
- Explore how to provide more [GUI configuration](/build-agents/agent-details) options through the concept of `AgentDetail`
140-
- Leverage [LLM Access](/build-agents/llm-access) in your agent
141-
- Understand how [Messages](/build-agents/messages) are used for communication between Agent and the Client
142-
- Build beautiful GUI for your agents with [GUI Components](/build-agents/gui-components)
143-
- Request structured input from the user using [forms](/build-agents/forms)
144-
- Learn how to work with [files](/build-agents/files)
145-
- [Share your agent](/how-to/share-agents) with the others
146+
After building your Hello World agent, you can:
147+
- Provide more [GUI configuration](/build-agents/agent-details) via `AgentDetail`
148+
- Leverage [LLM Access](/build-agents/llm-access)
149+
- Explore [Messages](/build-agents/messages) for communication between agents and clients
150+
- Build beautiful GUIs for your agents with [GUI components](/build-agents/gui-components)
151+
- Request structured inputs with [forms](/build-agents/forms)
152+
- Work with [files](/build-agents/files)
153+
- [Share your agent](/how-to/share-agents) with others

0 commit comments

Comments
 (0)