Agent skill

Building Pydantic AI Agents

by docling-project in docling-project/docling

Patterns and tested examples for building agents with Pydantic AI: tools, capabilities, structured output, dependency injection, hooks, YAML specs, streaming and testing.

MITAuto-check passedAI & LLM Engineering

Install Building Pydantic AI Agents

skills CLI
$ npx skills add docling-project/docling --skill building-pydantic-ai-agents -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install docling-project/docling building-pydantic-ai-agents --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/docling-project/docling.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/building-pydantic-ai-agents .claude/skills/building-pydantic-ai-agents && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
building-pydantic-ai-agents
GitHub stars
69k
Token cost
~2.8k tokens
SKILL.md length
778 words
Files
11 (incl. references)
Skills in repo
4
Repo updated
First seen
Licence
MIT

At a glance

Patterns and tested examples for building agents with Pydantic AI: tools, capabilities, structured output, dependency injection, hooks, YAML specs, streaming and testing.

  • Building a new AI agent with Pydantic AI
  • SKILL.md covers When to Use This Skill, Quick-Start Patterns, Task Routing Table and Architecture and Decisions, plus 3 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Adding tools, capabilities or structured output to an existing agent

What it does

The skill covers Pydantic AI, a Python agent framework for production generative AI applications. It applies when you mention the framework, when code imports pydantic_ai, or when you ask for an agent with tools, streaming, delegation or tests. Quick-start patterns show a basic agent, tools that use RunContext, structured output through Pydantic models, dependency injection, testing with TestModel, capabilities such as Thinking and WebSearch, lifecycle hooks, and agents defined from a YAML or JSON spec with Agent.from_file.

Capabilities are described as reusable units that bundle tools, hooks, instructions and model settings, while Hooks intercept model requests, tool calls and runs through decorators with no subclassing. Eleven reference files go deeper on core agents, architecture, built-in tools, capabilities and hooks, common tasks, input and history, orchestration and integrations, testing and debugging, and core and advanced tools. Observability with Logfire is also mentioned.

It is not meant for the plain Pydantic validation library, for other agent frameworks such as LangChain, LlamaIndex or CrewAI, or for general Python work. Python 3.10 or newer is required.

When your agent uses it

  • Building a new AI agent with Pydantic AI
  • Adding tools, capabilities or structured output to an existing agent
  • Streaming agent events or delegating work between agents
  • Writing tests for agent behavior with TestModel
  • Defining an agent from a YAML or JSON spec

Example prompts

  • “Build a Pydantic AI agent that looks up order status through a tool and returns a typed result.”
  • “Add web search and thinking capabilities to my existing agent.”
  • “Write a pytest test for my support agent using TestModel so it never calls a real model.”
  • “Define the research agent in agents/research.yaml and load it with Agent.from_file.”

Requirements

  • Python 3.10 or newer
  • The pydantic_ai package
  • Compatibility (from SKILL.md): Requires Python 3.10+

What it can do on your machine

Read from SKILL.md and the folder at commit 21588f5. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are python).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

  • Compatibility

    Requires Python 3.10+

    From compatibility in the SKILL.md frontmatter.

Context cost

Building Pydantic AI Agents loads about 2.8k tokens when it runs, and up to ~12k if it reads all its reference files. Until then it costs about 82 tokens; SKILL.md has 778 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~82
When it runs · the whole SKILL.md, loaded when a task matches
~2.8k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~12k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from docling-project/docling at commit 21588f5, republished under its MIT licence (© docling-project). 778 words, ~2,786 tokens.

Download SKILL.mdSave it as .claude/skills/building-pydantic-ai-agents/SKILL.md (or your agent's skills folder). This skill also uses 10 other files; get the full folder from GitHub.
name
building-pydantic-ai-agents
description
Build AI agents with Pydantic AI — tools, capabilities, structured output, streaming, testing, and multi-agent patterns. Use when the user mentions Pydantic AI, imports pydantic_ai, or asks to build an AI agent, add tools/capabilities, stream output, define agents from YAML, or test agent behavior.
compatibility
Requires Python 3.10+
license
MIT
metadata.version
1.1.0
metadata.author
pydantic

Building AI Agents with Pydantic AI

Pydantic AI is a Python agent framework for building production-grade Generative AI applications. This skill provides patterns, architecture guidance, and tested code examples for building applications with Pydantic AI.

When to Use This Skill

Invoke this skill when:

  • User asks to build an AI agent, create an LLM-powered app, or mentions Pydantic AI
  • User wants to add tools, capabilities (thinking, web search), or structured output to an agent
  • User asks to define agents from YAML/JSON specs or use template strings
  • User wants to stream agent events, delegate between agents, or test agent behavior
  • Code imports pydantic_ai or references Pydantic AI classes (Agent, RunContext, Tool)
  • User asks about hooks, lifecycle interception, or agent observability with Logfire

Do not use this skill for:

  • The Pydantic validation library alone (pydantic/BaseModel without agents)
  • Other AI frameworks (LangChain, LlamaIndex, CrewAI, AutoGen)
  • General Python development unrelated to AI agents

Quick-Start Patterns

Create a Basic Agent
python
from pydantic_ai import Agent

agent = Agent(
    'anthropic:claude-sonnet-4-6',
    instructions='Be concise, reply with one sentence.',
)

result = agent.run_sync('Where does "hello world" come from?')
print(result.output)
"""
The first known use of "hello, world" was in a 1974 textbook about the C programming language.
"""
Add Tools to an Agent
python
import random

from pydantic_ai import Agent, RunContext

agent = Agent(
    'google-gla:gemini-3-flash-preview',
    deps_type=str,
    instructions=(
        "You're a dice game, you should roll the die and see if the number "
        "you get back matches the user's guess. If so, tell them they're a winner. "
        "Use the player's name in the response."
    ),
)


@agent.tool_plain
def roll_dice() -> str:
    """Roll a six-sided die and return the result."""
    return str(random.randint(1, 6))


@agent.tool
def get_player_name(ctx: RunContext[str]) -> str:
    """Get the player's name."""
    return ctx.deps


dice_result = agent.run_sync('My guess is 4', deps='Anne')
print(dice_result.output)
#> Congratulations Anne, you guessed correctly! You're a winner!
Structured Output with Pydantic Models
python
from pydantic import BaseModel

from pydantic_ai import Agent


class CityLocation(BaseModel):
    city: str
    country: str


agent = Agent('google-gla:gemini-3-flash-preview', output_type=CityLocation)
result = agent.run_sync('Where were the olympics held in 2012?')
print(result.output)
#> city='London' country='United Kingdom'
print(result.usage())
#> RunUsage(input_tokens=57, output_tokens=8, requests=1)
Dependency Injection
python
from datetime import date

from pydantic_ai import Agent, RunContext

agent = Agent(
    'openai:gpt-5.2',
    deps_type=str,
    instructions="Use the customer's name while replying to them.",
)


@agent.instructions
def add_the_users_name(ctx: RunContext[str]) -> str:
    return f"The user's name is {ctx.deps}."


@agent.instructions
def add_the_date() -> str:
    return f'The date is {date.today()}.'


result = agent.run_sync('What is the date?', deps='Frank')
print(result.output)
#> Hello Frank, the date today is 2032-01-02.
Testing with TestModel
python
from pydantic_ai import Agent
from pydantic_ai.models.test import TestModel

my_agent = Agent('openai:gpt-5.2', instructions='...')


async def test_my_agent():
    """Unit test for my_agent, to be run by pytest."""
    m = TestModel()
    with my_agent.override(model=m):
        result = await my_agent.run('Testing my agent...')
        assert result.output == 'success (no tool calls)'
    assert m.last_model_request_parameters.function_tools == []
Use Capabilities

Capabilities are reusable, composable units of agent behavior — bundling tools, hooks, instructions, and model settings.

python
from pydantic_ai import Agent
from pydantic_ai.capabilities import Thinking, WebSearch

agent = Agent(
    'anthropic:claude-opus-4-6',
    instructions='You are a research assistant. Be thorough and cite sources.',
    capabilities=[
        Thinking(effort='high'),
        WebSearch(),
    ],
)
Add Lifecycle Hooks

Use Hooks to intercept model requests, tool calls, and runs with decorators — no subclassing needed.

python
from pydantic_ai import Agent, RunContext
from pydantic_ai.capabilities.hooks import Hooks
from pydantic_ai.models import ModelRequestContext

hooks = Hooks()


@hooks.on.before_model_request
async def log_request(ctx: RunContext[None], request_context: ModelRequestContext) -> ModelRequestContext:
    print(f'Sending {len(request_context.messages)} messages')
    return request_context


agent = Agent('openai:gpt-5.2', capabilities=[hooks])
Define Agent from YAML Spec

Use Agent.from_file to load agents from YAML or JSON — no Python agent construction code needed.

python
from pydantic_ai import Agent

# agent.yaml:
# model: anthropic:claude-opus-4-6
# instructions: You are a helpful research assistant.
# capabilities:
#   - WebSearch
#   - Thinking:
#       effort: high

agent = Agent.from_file('agent.yaml')

Task Routing Table

Load only the most relevant reference first. Read additional references only if the task spans multiple areas.

I want to...Reference
Create/configure agents, choose output types, use deps, define specs, or pick run methodsAgents Core
Bundle reusable behavior or intercept lifecycle eventsCapabilities and Hooks
Add function tools, toolsets, MCP servers, or explicit search toolsTools Core
Use provider-native web search, web fetch, or code executionBuilt-in Tools
Use advanced tool features such as approval, retries, ToolReturn, validators, timeouts, or tool searchTools Advanced
Work with multimodal input, message history, or context trimmingInput and History
Test or debug agent behaviorTesting and Debugging
Coordinate multiple agents or build graph workflowsOrchestration and Integrations
Call the model directly, expose A2A, use durable execution, embeddings, evals, or third-party integrationsOrchestration and Integrations
Compare abstractions, output modes, decorators, or model-string patternsArchitecture and Decision Guide
Follow an older link into COMMON-TASKS.mdTask Reference Map

Architecture and Decisions

Load Architecture and Decision Guide only when the user is choosing between abstractions or wants comparison tables and decision trees:

TopicWhat it covers
Decision TreesTool registration, output modes, multi-agent patterns, capabilities, testing approaches, extensibility
Comparison TablesOutput modes, model provider prefixes, tool decorators, built-in capabilities, agent methods
Architecture OverviewExecution flow, generic types, construction patterns, lifecycle hooks, model string format

Quick reference — model string format: "provider:model-name" (e.g., "openai:gpt-5.2", "anthropic:claude-sonnet-4-6", "google-gla:gemini-3-pro-preview")

Quick reference — key agent methods: run(), run_sync(), run_stream(), run_stream_sync(), run_stream_events(), iter()

Show full SKILL.md (311 more words)Show less

Key Practices

  • Python 3.10+ compatibility required
  • Observability: Pydantic AI has first-class integration with Logfire for tracing agent runs, tool calls, and model requests. Add it with logfire.instrument_pydantic_ai(). For deeper HTTP-level visibility, logfire.instrument_httpx(capture_all=True) captures the exact payloads sent to model providers.
  • Testing: Use TestModel for deterministic tests, FunctionModel for custom logic

Common Gotchas

These are mistakes agents commonly make with Pydantic AI. Getting these wrong produces silent failures or confusing errors.

  • @agent.tool requires RunContext as first param; @agent.tool_plain must not have it. Mixing these up causes runtime errors. Use tool_plain when you don't need deps, usage, or messages.
  • Model strings need the provider prefix: 'openai:gpt-5.2' not 'gpt-5.2'. Without the prefix, Pydantic AI can't resolve the provider.
  • TestModel requires agent.override(): Don't set agent.model directly. Always use the context manager: with agent.override(model=TestModel()):.
  • str in output_type allows plain text to end the run: If your union includes str (or no output_type is set), the model can return plain text instead of structured output. Omit str from the union to force tool-based output.
  • Hook decorator names on .on don't repeat on_: Use hooks.on.run_error and hooks.on.model_request_error — not hooks.on.on_run_error.
  • history_processors is plural: The Agent parameter is history_processors=[...], not history_processor=.

Task-Family References

Load exactly one of these unless the task clearly spans multiple families:

Task familyReference
Core agent setup, output, deps, specs, models, run methodsAgents Core
Capabilities, hooks, and reusable behaviorCapabilities and Hooks
Function tools, toolsets, MCP, explicit search toolsTools Core
Provider-native builtin toolsBuilt-in Tools
Approval, retries, validators, timeouts, rich tool returns, deferred loadingTools Advanced
Multimodal input, message history, history processorsInput and History
Testing, request inspection, and Logfire debuggingTesting and Debugging
Multi-agent patterns, graphs, direct API, A2A, durable execution, embeddings, evals, third-party integrationsOrchestration and Integrations

Use Task Reference Map only for compatibility with older links or when you need a pointer from an old section name to the new file.

© docling-project, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 10 other files (references) in .agents/skills/building-pydantic-ai-agents of docling-project/docling.

  • SKILL.md
  • references/AGENTS-CORE.md
  • references/ARCHITECTURE.md
  • references/BUILTIN-TOOLS.md
  • references/CAPABILITIES-AND-HOOKS.md
  • references/COMMON-TASKS.md
  • references/INPUT-AND-HISTORY.md
  • references/ORCHESTRATION-AND-INTEGRATIONS.md
  • references/TESTING-AND-DEBUGGING.md
  • references/TOOLS-ADVANCED.md
  • references/TOOLS-CORE.md

Open the folder on GitHubat commit 21588f5

Compare with similar skills

Building Pydantic AI Agents next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Building Pydantic AI Agents compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Building Pydantic AI Agents this skilldocling-project/docling69k—~2.8kAutomated safety check: PassMIT
Building Pydantic AI Agentspydantic/skills140—~5.4kAutomated safety check: PassMIT
Building Pydantic AI Agentspydantic/pydantic-ai21k—~8.2kAutomated safety check: PassMIT
Migrating Langchain To Pydantic AIpydantic/pydantic-ai21k—~2.5kAutomated safety check: PassMIT
Logfire Instrumentationpydantic/skills140—~6.1kAutomated safety check: PassMIT
Pydantic AIdavila7/claude-code-templates33k3 repos~2.9kAutomated safety check: PassMIT

Similar skills

  • Official

    Build AI agents with Pydantic AI — tools, capabilities (including on-demand loading), structured output, streaming, testing, and multi-agent patterns.

    140 GitHub stars~5.4k tokensUpdated 10 days ago
    AI & LLM EngineeringAuto-check passed
  • Building Pydantic AI Agents

    pydantic/pydantic-ai

    Official

    Build AI agents with Pydantic AI — tools, capabilities (including on-demand loading), workspaces, structured output, streaming, testing, and multi-agent patterns.

    21k GitHub stars~8.2k tokensUpdated today
    AI & LLM EngineeringAuto-check passed
  • Official

    Migrate Python LangChain, LangGraph, or Deep Agents applications to Pydantic AI and, when the source uses harness features, Pydantic AI Harness.

    21k GitHub stars~2.5k tokensUpdated today
    AI & LLM EngineeringAuto-check passed
  • Official

    Add Pydantic Logfire observability to application code — traces, logs, metrics, and AI/agent spans.

    140 GitHub stars~6.1k tokensUpdated 10 days ago
    AI & LLM EngineeringAuto-check passed
  • Pydantic AI

    davila7/claude-code-templates

    Build production-ready AI agents with PydanticAI — type-safe tool use, structured outputs, dependency injection, and multi-model support.

    33k GitHub starsUsed in 3 repos~2.9k tokens
    AI & LLM EngineeringAuto-check passed
  • Langchain Middleware

    langchain-ai/langchain-skills

    Official

    INVOKE THIS SKILL when you need human-in-the-loop approval, custom middleware, or structured output.

    1.3k GitHub stars~2.7k tokensUpdated 2 days ago
    AI & LLM EngineeringAuto-check passed

More from docling-project/docling

  • Docling Document Conversion

    docling-project/docling

    Converts PDFs, Office files, HTML, images and other documents into a unified DoclingDocument with Markdown or JSON output, through the docling CLI, Python SDK or a remote service.

    69k GitHub stars~1.1k tokensUpdated today
    Auto-check passed
  • Dignified Python Standards

    docling-project/docling

    Applies opinionated production Python conventions chosen by the project's Python version: modern type syntax, pathlib, explicit checks and interface guidance.

    69k GitHub stars~1.5k tokensUpdated today
    Auto-check passed
  • Docling Pull Request Review

    docling-project/docling

    Reviews or re-reviews a Docling pull request in fixed stages, with findings that can be reproduced and an explicit record of every check that was run.

    69k GitHub stars~1k tokensUpdated today
    Auto-check passed

Questions about Building Pydantic AI Agents

What does Building Pydantic AI Agents do?

Patterns and tested examples for building agents with Pydantic AI: tools, capabilities, structured output, dependency injection, hooks, YAML specs, streaming and testing. The skill covers Pydantic AI, a Python agent framework for production generative AI applications. It applies when you mention the framework, when code imports pydantic_ai, or when you ask for an agent with tools, streaming, delegation or tests.

When should I use Building Pydantic AI Agents?

Building Pydantic AI Agents fits situations like: building a new AI agent with Pydantic AI; adding tools, capabilities or structured output to an existing agent; streaming agent events or delegating work between agents; writing tests for agent behavior with TestModel.

How do I install Building Pydantic AI Agents in Claude Code?

Run `npx skills add docling-project/docling --skill building-pydantic-ai-agents -a claude-code`. Or copy the skill folder (.agents/skills/building-pydantic-ai-agents in docling-project/docling) into .claude/skills/building-pydantic-ai-agents in your project. Claude Code loads it when a task matches its description.

How do I install Building Pydantic AI Agents in Codex?

Run `npx skills add docling-project/docling --skill building-pydantic-ai-agents -a codex`. Or copy the skill folder (.agents/skills/building-pydantic-ai-agents in docling-project/docling) into .agents/skills/building-pydantic-ai-agents in your project. Codex loads it when a task matches its description.

Can I use Building Pydantic AI Agents in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add docling-project/docling --skill building-pydantic-ai-agents -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/building-pydantic-ai-agents, .gemini/skills/building-pydantic-ai-agents, .github/skills/building-pydantic-ai-agents and .opencode/skills/building-pydantic-ai-agents in your project.

What does Building Pydantic AI Agents need to run?

SKILL.md names no scripts, command-line tools or credentials: Building Pydantic AI Agents is instructions for the agent only. Our summary lists: Python 3.10 or newer; The pydantic_ai package. Compatibility (from SKILL.md): Requires Python 3.10+.

Does Building Pydantic AI Agents access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Building Pydantic AI Agents safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Building Pydantic AI Agents use?

Building Pydantic AI Agents is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Building Pydantic AI Agents use?

About 2.8k tokens (SKILL.md is roughly 11k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 9.5k tokens, read only when the agent opens those files.

What are the alternatives to Building Pydantic AI Agents?

Skills that share tags, products or a category with Building Pydantic AI Agents: Building Pydantic AI Agents (pydantic/skills, 140 stars), Building Pydantic AI Agents (pydantic/pydantic-ai, 21k stars), Migrating Langchain To Pydantic AI (pydantic/pydantic-ai, 21k stars) and Logfire Instrumentation (pydantic/skills, 140 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Building Pydantic AI Agents?

docling-project (a GitHub organization) maintains it in docling-project/docling, which has 68,662 GitHub stars. The repository holds 4 skills in this directory. The repository was last updated on October 11, 2026.

Source: docling-project/docling on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.