Skip to content

docs: update subagent configuration schema table #26983

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
mwilliams31 wants to merge 2 commits into
base: main
Choose a base branch
from
+4 −3
Open

docs: update subagent configuration schema table #26983

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5c040de
feat(docs): add display_name field to subagent configuration
mwilliams31 May 13, 2026
c52b8b4
fix(docs): correct spelling of 'mcp_servers' in subagent configuration
mwilliams31 May 13, 2026
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
7 changes: 4 additions & 3 deletions docs/core/subagents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,9 +367,10 @@ it yourself; just report it.
| :------------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `name` | string | Yes | Unique identifier (slug) used as the tool name for the agent. Only lowercase letters, numbers, hyphens, and underscores. |
| `description` | string | Yes | Short description of what the agent does. This is visible to the main agent to help it decide when to call this subagent. |
| `display_name` | string | No | Human-readable display name for the agent. Used in UIs and user-facing output to present the agent in a more friendly format. |
| `kind` | string | No | `local` (default) or `remote`. |
| `tools` | array | No | List of tool names this agent can use. Supports wildcards: `*` (all tools), `mcp_*` (all MCP tools), `mcp_server_*` (all tools from a server). **If omitted, it inherits all tools from the parent session.** |
| `mcpServers` | object | No | Configuration for inline Model Context Protocol (MCP) servers isolated to this specific agent. |
| `mcp_servers` | object | No | Configuration for inline Model Context Protocol (MCP) servers isolated to this specific agent. |
Comment thread
mwilliams31 marked this conversation as resolved.
| `model` | string | No | Specific model to use (for example, `gemini-3-preview`). Defaults to `inherit` (uses the main session model). |
| `temperature` | number | No | Model temperature (0.0 - 2.0). Defaults to `1`. |
| `max_turns` | number | No | Maximum number of conversation turns allowed for this agent before it must return. Defaults to `30`. |
Expand Down Expand Up @@ -425,7 +426,7 @@ You can configure tool isolation for a subagent by updating its markdown
frontmatter. This lets you explicitly state which tools the subagent can use,
rather than relying on the global registry.

Add an `mcpServers` object to define inline MCP servers that are unique to the
Add an `mcp_servers` object to define inline MCP servers that are unique to the
agent.

**Example:**
Expand All @@ -436,7 +437,7 @@ name: my-isolated-agent
tools:
- grep_search
- read_file
mcpServers:
mcp_servers:
my-custom-server:
command: 'node'
args: ['path/to/server.js']
Expand Down