Skip to content

Commit 22507a3

Browse files
committed
fix
1 parent 72e845a commit 22507a3

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

sdk/guides/agent-file-based.mdx

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: Define specialized sub-agents as simple Markdown files with YAML fr
55

66
import RunExampleCode from "/sdk/shared-snippets/how-to-run-example.mdx";
77

8+
> A ready-to-run example is available [here](#ready-to-run-example)!
9+
810
File-based agents let you define specialized sub-agents using Markdown files. Each file declares the agent's name, description, tools, and system prompt — the same things you'd pass to `register_agent()` in code, but without writing any Python.
911

1012
This is the fastest way to create reusable, domain-specific agents that can be invoked via [delegation](/sdk/guides/agent-delegation).
@@ -48,7 +50,7 @@ The YAML frontmatter configures the agent. The Markdown body becomes the agent's
4850
| `description` | No | `""` | What this agent does. Shown to the orchestrator |
4951
| `tools` | No | `[]` | List of tools the agent can use |
5052
| `model` | No | `"inherit"` | LLM model (`"inherit"` uses the parent agent's model) |
51-
| `color` | No | `None` | Display color for the agent |
53+
| `color` | No | `None` | [Rich color name](https://rich.readthedocs.io/en/stable/appendix/colors.html) (e.g., `"blue"`, `"green"`) used by visualizers to style this agent's output in terminal panels |
5254

5355
### `<example>` Tags
5456

@@ -70,9 +72,9 @@ Place agent files in these directories, scanned in **priority order** (first mat
7072
| Priority | Location | Scope |
7173
|----------|----------|-------|
7274
| 1 | `{project}/.agents/agents/*.md` | Project-level (primary) |
73-
| 2 | `{project}/.openhands/agents/*.md` | Project-level (legacy) |
75+
| 2 | `{project}/.openhands/agents/*.md` | Project-level (secondary) |
7476
| 3 | `~/.agents/agents/*.md` | User-level (primary) |
75-
| 4 | `~/.openhands/agents/*.md` | User-level (legacy) |
77+
| 4 | `~/.openhands/agents/*.md` | User-level (secondary) |
7678

7779
<Tree>
7880
<Tree.Folder name="my-project/" defaultOpen>
@@ -270,7 +272,10 @@ Always include a usage example with expected output when documenting functions o
270272

271273
## Agents in Plugins
272274

273-
File-based agents can also be bundled inside [plugins](/sdk/guides/plugins). Place them in the `agents/` directory of your plugin:
275+
> Plugins bundle agents, tools, skills, and MCP servers into reusable packages.
276+
Learn more about plugins [here](/sdk/guides/plugins).
277+
278+
File-based agents can also be bundled inside plugins. Place them in the `agents/` directory of your plugin:
274279

275280
<Tree>
276281
<Tree.Folder name="my-plugin/" defaultOpen>

0 commit comments

Comments
 (0)