Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/check-broken-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
node-version: '22'

- name: Install Mint CLI
run: npm install -g mint@latest
Expand Down
4 changes: 3 additions & 1 deletion sdk/guides/agent-file-based.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: File-Based Agents
description: Define specialized sub-agents as simple Markdown files with YAML frontmatter — no Python code required.

Check warning on line 3 in sdk/guides/agent-file-based.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

sdk/guides/agent-file-based.mdx#L3

Did you really mean 'frontmatter'?
---

import RunExampleCode from "/sdk/shared-snippets/how-to-run-example.mdx";
Expand All @@ -13,7 +13,7 @@

## Agent File Format

An agent is a single `.md` file with YAML frontmatter and a Markdown body:

Check warning on line 16 in sdk/guides/agent-file-based.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

sdk/guides/agent-file-based.mdx#L16

Did you really mean 'frontmatter'?

```markdown icon="markdown"
---
Expand All @@ -40,16 +40,18 @@
Keep feedback concise and actionable. For each issue, suggest a fix.
```

The YAML frontmatter configures the agent. The Markdown body becomes the agent's system prompt.

Check warning on line 43 in sdk/guides/agent-file-based.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

sdk/guides/agent-file-based.mdx#L43

Did you really mean 'frontmatter'?

### Frontmatter Fields

Check warning on line 45 in sdk/guides/agent-file-based.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

sdk/guides/agent-file-based.mdx#L45

Did you really mean 'Frontmatter'?

| Field | Required | Default | Description |
|-------|----------|---------|-------------|
| `name` | Yes | - | Agent identifier (e.g., `code-reviewer`) |
| `description` | No | `""` | What this agent does. Shown to the orchestrator |
| `tools` | No | `[]` | List of tools the agent can use |
| `model` | No | `"inherit"` | LLM model (`"inherit"` uses the parent agent's model) |
| `model` | No | `"inherit"` | LLM model profile to load and use for the subagent (`"inherit"` uses the parent agent's model) |
| `skills` | No | `[]` | List of skill names for this agent (see [Skill Loading Precedence](/overview/skills#skill-loading-precedence) for resolution order). |
| `max_iteration_per_run` | No | `None`| Maximum iterations per run. Must be strictly positive, or `None` for the default value. |
| `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 |

### `<example>` Tags
Expand Down Expand Up @@ -160,7 +162,7 @@
print(f"Registered {len(agent_names)} agents: {agent_names}")
```

This scans both project-level and user-level directories, deduplicates by name, and registers each agent as a delegate that can be spawned by the orchestrator.

Check warning on line 165 in sdk/guides/agent-file-based.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

sdk/guides/agent-file-based.mdx#L165

Did you really mean 'deduplicates'?

## Manual Loading

Expand Down Expand Up @@ -212,7 +214,7 @@
```

The factory:
- Maps tool names from the frontmatter to `Tool` objects

Check warning on line 217 in sdk/guides/agent-file-based.mdx

View check run for this annotation

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck

sdk/guides/agent-file-based.mdx#L217

Did you really mean 'frontmatter'?
- Appends the Markdown body to the parent system message via `AgentContext(system_message_suffix=...)`
- Respects the `model` field (`"inherit"` keeps the parent LLM; an explicit model name creates a copy)

Expand Down
Loading