From 26d933d55d433cb8f9bf39128affdccb37503fa5 Mon Sep 17 00:00:00 2001 From: Illia Oleksiuk Date: Tue, 12 May 2026 16:47:31 -0700 Subject: [PATCH] docs: mark Agent.instructions as optional MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit `Agent.instructions` has a default value of `None` (see `src/agents/agent.py:283-290`) and the class docstring itself notes "We strongly recommend passing `instructions`" — implying it is recommended, not required. `Agent(name="x")` succeeds at runtime without `instructions`. Update the property table in `docs/agents.md` to mark it as not-required with a note recommending it. --- docs/agents.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/agents.md b/docs/agents.md index 12a9f53b41..f1878559b2 100644 --- a/docs/agents.md +++ b/docs/agents.md @@ -28,7 +28,7 @@ The most common properties of an agent are: | Property | Required | Description | | --- | --- | --- | | `name` | yes | Human-readable agent name. | -| `instructions` | yes | System prompt or dynamic instructions callback. See [Dynamic instructions](#dynamic-instructions). | +| `instructions` | no | System prompt or dynamic instructions callback. Strongly recommended. See [Dynamic instructions](#dynamic-instructions). | | `prompt` | no | OpenAI Responses API prompt configuration. Accepts a static prompt object or a function. See [Prompt templates](#prompt-templates). | | `handoff_description` | no | Short description exposed when this agent is offered as a handoff target. | | `handoffs` | no | Delegate the conversation to specialist agents. See [handoffs](handoffs.md). |