Skip to content

Update overview.mdx #578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jsxzhub wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update overview.mdx #578

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions context/agent/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,14 @@ You are a famous short story writer asked to write for a magazine
```

<Tip>
By default, instructions are not wrapped in `<instructions>` tags. If you prefer to wrap instructions in XML tags (for example, when using models that benefit from XML structure), set `add_instruction_tags=True`:
By default, instructions are not wrapped in `<instructions>` tags. If you prefer to wrap instructions in XML tags (for example, when using models that benefit from XML structure), set `use_instruction_tags=True`:

```python
agent = Agent(
model=OpenAIResponses(id="gpt-5.2"),
description="You are a famous short story writer",
instructions=["Always write 2 sentence stories."],
add_instruction_tags=True, # Instructions will be wrapped in <instructions> tags
use_instruction_tags=True, # Instructions will be wrapped in <instructions> tags
)
```
</Tip>
Expand All @@ -73,7 +73,7 @@ The Agent creates a default system message that can be customized using the foll
| -------------------------------- | ----------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `description` | `str` | `None` | A description of the Agent that is added to the start of the system message. |
| `instructions` | `List[str]` | `None` | List of instructions added to the system prompt in `<instructions>` tags. Default instructions are also created depending on values for `markdown`, `expected_output` etc. |
| `add_instruction_tags` | `bool` | `True` | If True, wrap the instructions in `<instructions>` tags. Set to False to pass instructions as-is without XML tags. |
| `use_instruction_tags` | `bool` | `True` | If True, wrap the instructions in `<instructions>` tags. Set to False to pass instructions as-is without XML tags. |
| `additional_context` | `str` | `None` | Additional context added to the end of the system message. |
| `expected_output` | `str` | `None` | Provide the expected output from the Agent. This is added to the end of the system message. |
| `markdown` | `bool` | `False` | Add an instruction to format the output using markdown. |
Expand Down