Updating INITIAL.md for Pydantic AI use case

This commit is contained in:
Cole Medin 2025-07-20 19:55:18 -05:00
parent 669e30d871
commit 2b8bac6393

View File

@ -1,17 +1,37 @@
## FEATURE:
Build a simple customer support chatbot using PydanticAI that can answer basic questions and escalate complex issues to human agents.
[REPLACE EVERYTHING IN BRACKETS WITH YOUR OWN CONTEXT]
[Provide an overview of the agent you want to build. The more detail the better!]
[Overly simple example: Build a simple research agent using Pydantic AI that can research topics with the Brave API and draft emails with Gmail to share insights.]
## TOOLS:
[Describe the tools you want for your agent(s) - functionality, arguments, what they return, etc. Be as specific as you like - the more specific the better.]
## DEPENDENCIES
[Describe the dependencies needed for the agent tools (for the Pydantic AI RunContext) - things like API keys, DB connections, an HTTP client, etc.]
## SYSTEM PROMPT(S)
[Describe the instructions for the agent(s) here - you can create the entire system prompt here or give a general description to guide the coding assistant]
## EXAMPLES:
- Basic chat agent with conversation memory
- Tool-enabled agent with web search capabilities
- Structured output agent for data validation
- Testing examples with TestModel and FunctionModel
[Add any additional example agents/tool implementations from past projects or online resources to the examples/ folder and reference them here.]
[The template contains the following already for Pydantic AI:]
- examples/basic_chat_agent - Basic chat agent with conversation memory
- examples/tool_enabled_agent - Tool-enabled agent with web search capabilities
- examples/structured_output_agent - Structured output agent for data validation
- examples/testing_examples - Testing examples with TestModel and FunctionModel
- examples/main_agent_reference - Best practices for building Pydantic AI agents
## DOCUMENTATION:
- PydanticAI Official Documentation: https://ai.pydantic.dev/
[Add any additional documentation you want it to reference - this can be curated docs you put in PRPs/ai_docs, URLs, etc.]
- Pydantic AI Official Documentation: https://ai.pydantic.dev/
- Agent Creation Guide: https://ai.pydantic.dev/agents/
- Tool Integration: https://ai.pydantic.dev/tools/
- Testing Patterns: https://ai.pydantic.dev/testing/
@ -22,4 +42,6 @@ Build a simple customer support chatbot using PydanticAI that can answer basic q
- Use environment variables for API key configuration instead of hardcoded model strings
- Keep agents simple - default to string output unless structured output is specifically needed
- Follow the main_agent_reference patterns for configuration and providers
- Always include comprehensive testing with TestModel for development
- Always include comprehensive testing with TestModel for development
[Add any additional considerations for the coding assistant, especially "gotchas" you want it to keep in mind.]