example/README.md

LLM Dart Examples - Redesigned #

A comprehensive collection of examples for the LLM Dart library, reorganized by user needs and learning paths to help you find the functionality and information you need more easily.

🚀 Quick Navigation #

Choose by Skill Level #

Choose by Use Case #

📁 Directory Structure #

🟢 Getting Started #

For: First-time users of LLM Dart

• quick_start.dart - Quick start guide
• provider_comparison.dart - Provider comparison and selection
• basic_configuration.dart - Basic configuration guide

🟡 Core Features #

For: Users who need to understand main functionality

• chat_basics.dart - Basic chat functionality
• streaming_chat.dart - Real-time streaming chat
• tool_calling.dart - Tool calling and function execution
• enhanced_tool_calling.dart - Advanced tool calling patterns
• structured_output.dart - Structured data output
• error_handling.dart - Error handling best practices

🔴 Advanced Features #

For: Users who need deep customization

• reasoning_models.dart - 🧠 Reasoning models and thinking processes
• multi_modal.dart - Multi-modal processing (images/audio)
• custom_providers.dart - Custom provider development
• performance_optimization.dart - Performance optimization techniques

🎯 Provider Specific #

For: Users who need specific provider functionality

🎪 Real-world Use Cases #

For: Users looking for specific application solutions

• chatbot.dart - Complete chatbot implementation
• cli_tool.dart - Command-line AI assistant
• web_service.dart - HTTP API with AI capabilities

🌟 Production Application #

Real-world example built with LLM Dart

• Yumcha - Cross-platform AI chat application actively developed by the creator of LLM Dart, showcasing real-world integration with multiple providers, real-time streaming, and advanced features

🔗 MCP Integration ✅ FULLY TESTED #

For: Users who want to connect LLMs with external tools via Model Context Protocol

• mcp_concept_demo.dart - 🎯 START HERE - Core MCP concepts
• simple_mcp_demo.dart - Working MCP + LLM integration example
• test_all_examples.dart - 🧪 ONE-CLICK TEST - Test all examples
• basic_mcp_client.dart - Basic MCP client connection
• custom_mcp_server.dart - Custom MCP server implementation
• mcp_tool_bridge.dart - Bridge between MCP and llm_dart tools
• mcp_with_llm.dart - Advanced MCP + LLM integration

🎯 Feature Support Matrix #

🚀 Quick Start #

1. Choose Your First Example #

# Complete beginner - quick experience
dart run 01_getting_started/quick_start.dart

# Experienced - jump to core features
dart run 02_core_features/chat_basics.dart

# Specific needs - jump to corresponding scenario
dart run 05_use_cases/chatbot.dart

# MCP integration - connect LLMs with external tools
dart run 06_mcp_integration/mcp_concept_demo.dart

2. Set Environment Variables #

# Set API keys for the providers you want to use
export OPENAI_API_KEY="your-openai-key"
export ANTHROPIC_API_KEY="your-anthropic-key"
export GOOGLE_API_KEY="your-google-key"
export DEEPSEEK_API_KEY="your-deepseek-key"
export GROQ_API_KEY="your-groq-key"
export ELEVENLABS_API_KEY="your-elevenlabs-key"

3. Run Examples #

cd new_example
dart run 01_getting_started/quick_start.dart

💡 Learning Recommendations #

🟢 Beginner Users #

1. Start with quick_start.dart
2. Read provider_comparison.dart to choose the right provider
3. Learn chat_basics.dart to master basic conversations
4. Try streaming_chat.dart to experience real-time responses

🟡 Intermediate Users #

1. Master tool_calling.dart for tool calling
2. Learn structured_output.dart for structured output
3. Explore reasoning_models.dart for reasoning functionality
4. Choose specific use case examples based on your needs

🔴 Advanced Users #

1. Study custom_providers.dart for custom development
2. Optimize performance with performance_optimization.dart
3. Deep dive into specific provider advanced features
4. Explore Yumcha for real-world architecture patterns and active development practices
5. Integrate into production environments with MCP protocol support

🔗 Related Links #

• Main Project README - Complete library documentation
• API Documentation - Detailed API reference
• GitHub Issues - Bug reports and feature requests
• Discussions - Community discussions

💡 Tip: If you can't find the example you need, check GitHub Issues or create a new issue to tell us your requirements!