Skip to content

Latest commit

Β 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

README.md

Documentation

Welcome to the Claude PHP Agent Framework documentation!

πŸ“š Table of Contents

Getting Started

Loop Strategies

Agent Patterns

Basic Agents

Advanced Reasoning

Specialized Agents

Multi-Agent Systems

Production Agents

Meta-Agents

Core Systems

πŸ†• New Features (v0.7.0 - v0.8.0)

Design Patterns

Tools & Execution

Memory & Context

Chain Composition

  • Chains - Sequential, parallel, and router chains

Output Processing

  • Parsers - Structured output extraction (includes Strategy pattern)
  • Prompts - Prompt engineering and templates (includes Template pattern)

Observability

Advanced Features

πŸŽ“ Tutorials

πŸ“š Complete Tutorial Index - Browse all 36+ tutorials with learning paths

Agent Patterns Tutorials

  1. Adaptive Agent Service
  2. Alert Agent
  3. Autonomous Agent
  4. Chain of Thought
  5. Chains
  6. Coordinator Agent
  7. Debate System
  8. Dialog Agent
  9. Environment Simulator
  10. Hierarchical Agent
  11. Intent Classifier
  12. Learning Agent
  13. MAKER Agent
  14. Memory Manager
  15. Micro Agent
  16. Model-Based Agent
  17. Monitoring Agent
  18. Multi-Agent Systems
  19. Plan-Execute Agent
  20. Prompts
  21. RAG Agent
  22. ReAct Agent
  23. Reflection Agent
  24. Reflex Agent
  25. Scheduler Agent
  26. Solution Discriminator
  27. Task Prioritization
  28. Tree of Thoughts
  29. Utility-Based Agent
  30. Worker Agent

πŸ†• New Features Tutorials (v0.7.0 - v0.8.0)

  1. Component Validation - Runtime validation by instantiation (45min)
  2. Services System - Enterprise service management (50min)
  3. MCP Server Integration - Claude Desktop connectivity (55min)
  4. Code Generation - AI-powered code generation (50min)
  5. Production Patterns - Production deployment (60min)
  6. Testing Strategies - Comprehensive testing (55min)

πŸ’‘ 42 runnable examples included in examples/tutorials/ - Each new tutorial comes with 7 working code samples!

πŸ“– Examples

Check the examples directory for 110+ complete working examples:

Core Examples (70+ files):

  • Basic agent usage
  • Multi-tool agents
  • Hierarchical systems
  • Production setups
  • Async/parallel execution
  • Output parsing
  • Chain composition
  • MAKER agent demonstrations
  • Adaptive agent service

πŸ†• Tutorial Examples (42 files in examples/tutorials/):

  • Component validation patterns (7 examples)
  • Services system usage (7 examples)
  • MCP server integration (7 examples)
  • Code generation workflows (7 examples)
  • Production deployment (7 examples)
  • Testing strategies (7 examples)

Run any example: php examples/tutorials/component-validation/01-basic-validation.php

πŸ” Quick Navigation

By Use Case

Building a Chatbot? β†’ Start with Dialog Agent

Need to Search & Answer? β†’ Check out RAG Agent

Complex Multi-Step Tasks? β†’ Use Plan-Execute Agent or Hierarchical Agent

High-Quality Output? β†’ Try Reflection Agent

System Monitoring? β†’ Use Monitoring Agent or Alert Agent

Million-Step Tasks? β†’ Use MAKER Agent

Don't Know Which Agent? β†’ Use Adaptive Agent Service

Component Validation? β†’ Check Component Validation Service

Enterprise Services? β†’ See Services System

Claude Desktop Integration? β†’ Use MCP Server

AI Code Generation? β†’ Read Code Generation Guide

Production Deployment? β†’ Follow Production Patterns Tutorial

Testing Strategies? β†’ Learn from Testing Strategies Tutorial

By Complexity

  • Beginner: ReAct, Reflex, Dialog
  • Intermediate: Plan-Execute, Reflection, Hierarchical, Component Validation, Services
  • Advanced: Multi-Agent, MAKER, Coordinator, Adaptive Service, MCP Server, Code Generation

🀝 Contributing

Want to improve the documentation?

  1. Check CONTRIBUTING.md
  2. Documentation is in Markdown format
  3. Include code examples where helpful
  4. Test all code examples before submitting

πŸ“ Documentation Conventions

Code Examples

All code examples should:

  • Be complete and runnable
  • Include necessary imports
  • Follow PSR-12 coding standards
  • Include comments for clarity

Structure

Documentation should include:

  • Clear title and description
  • Table of contents for long docs
  • Code examples with explanations
  • Best practices and tips
  • Related documentation links

πŸ†˜ Getting Help

  • Documentation Issues: Open an issue on GitHub
  • Questions: Use GitHub Discussions
  • Bugs: Report in the issue tracker
  • Security: See SECURITY.md

🎁 What's New

v0.8.0 (Latest)

  • ✨ Component Validation Service - Runtime validation by instantiation
  • ✨ Code Generation Agent - AI-powered code generation with validation pipelines
  • πŸ“š New tutorials: Component Validation, Code Generation, Production Patterns, Testing Strategies
  • πŸ“ 42 new tutorial examples in examples/tutorials/
  • πŸ“– Enhanced documentation with step-by-step guides

v0.7.0

  • ✨ Services System - Enterprise service management with dependency injection
  • ✨ MCP Server - Model Context Protocol integration for Claude Desktop and IDEs
  • πŸ“š New tutorials: Services System, MCP Server Integration
  • πŸ”§ Enhanced observability and monitoring capabilities
  • πŸ“– Comprehensive service layer documentation

See CHANGELOG.md for complete version history.

πŸ“œ License

The documentation is part of the Claude PHP Agent Framework and is licensed under the MIT License.


Tip: Use the search function (Ctrl/Cmd + F) to quickly find what you're looking for!

New to the framework? Start with the Tutorial Index to find the perfect learning path!