Skip to content

AI-Protocol v0.4.0 Release Notes

Choose a tag to compare

View all tags
@hiddenpath hiddenpath released this 05 Feb 13:44
· 43 commits to main since this release
v0.4.0
0f58502

AI-Protocol v0.4.0 Release Notes

Release Date: February 5, 2026
Tag: v0.4.0
Status: 📦 Ready for Release

Overview

AI-Protocol v0.4.0 is a documentation and examples focused release that significantly improves the developer experience for both users and contributors. This release adds extensive documentation, practical examples, and integration guides to help developers get started with AI-Protocol quickly.

What's New

📚 Documentation Expansion

Three new comprehensive documentation files:

  1. GETTING_STARTED.md (18,000+ words)

    • Complete user guide for beginners
    • Installation instructions for all platforms
    • Core concepts explained (providers, manifests, standard schema)
    • Quick start examples (Python and Rust)
    • Configuration guide
    • Advanced topics and troubleshooting

  2. CONTRIBUTING_PROVIDER.md (12,000+ words)

    • Step-by-step provider contribution tutorial
    • Provider manifest reference
    • Validation and testing procedures
    • Common patterns and best practices
    • Detailed examples (SSE, NDJSON, tools, vision)
    • Git workflow for submitting contributions

  3. RUNTIME_INTEGRATION.md (10,000+ words)

    • Architecture overview for runtime implementers
    • Core components (loader, validator, pipeline, transport)
    • Implementation steps (with code examples)
    • Protocol loading strategies
    • Stream processing pipeline
    • Error handling patterns
    • Reference implementation guidance

🎯 New Example Configurations

Four new practical examples in examples/:

  1. simple_streaming.yaml

    • Minimal streaming setup with OpenAI
    • Demonstrates basic event mapping
    • Perfect learning example for beginners

  2. batch_processing.yaml

    • Batch operations with Anthropic
    • Performance optimization for bulk requests
    • Concurrency and rate limiting configuration
    • Use patterns for bulk content generation, translation

  3. multimodal_vision.yaml

    • Vision capabilities with Gemini
    • Image input handling (URL and base64)
    • Content block structure for multimodal messages
    • Examples: OCR, chart analysis, multi-image comparison

  4. function_calling.yaml

    • Function/tool calling with OpenAI
    • Streaming tool call support
    • Tool accumulation patterns
    • Examples: weather, calculation tools
    • Best practices and error handling

Summary of Changes

Documentation

  • ✅ 3 new comprehensive documentation files (40,000+ words total)
  • ✅ Enhanced README with documentation links
  • ✅ Detailed code examples (Python and Rust)
  • ✅ Troubleshooting guides

Examples

  • ✅ 4 new example configurations (27,000+ lines total)
  • ✅ Detailed inline comments explaining each configuration
  • ✅ Real-world usage patterns
  • ✅ Best practices and tips

Schema

  • No schema changes (compatible with v0.3.5)
  • All existing providers unchanged
  • JSON Schema validation continues to work

Developer Experience Improvements

This release is designed to:

  1. Lower Onboarding Barrier: New users can now easily:

    • Understand AI-Protocol concepts
    • Install and get started quickly
    • Learn from working examples
    • Troubleshoot common issues

  2. Enable Provider Contributions: Contributors can now:

    • Follow step-by-step provider addition guide
    • Understand schema requirements
    • Test their configurations
    • Submit well-formed PRs

  3. Facilitate Runtime Integration: Runtime developers can now:

    • Understand the core architecture
    • Follow proven implementation patterns
    • Reference actual code from ai-lib-rust and ai-lib-python
    • Implement validation correctly

Usage

Installation

# Clone the repository
git clone https://github.com/hiddenpath/ai-protocol.git
cd ai-protocol

Reading Documentation

# Read user guide
cat docs/GETTING_STARTED.md

# Read contribution guide
cat docs/CONTRIBUTING_PROVIDER.md

# Read integration guide
cat docs/RUNTIME_INTEGRATION.md

Running Examples

# See all example configurations
ls examples/

# Validate examples
npm run validate:examples

Compatibility

Backward Compatibility

✅ Fully compatible with v0.3.5

  • No breaking changes to schema
  • All existing provider configurations unchanged
  • Runtime behavior identical

Provider Coverage

  • Total Providers: 30 (unchanged)
  • Models Registered: 28 (unchanged)
  • Validation Files: 68 + 4 new examples = 72

Testing

Validation

All configurations validated successfully:

npm run validate

Expected output:

✅ All providers validated (30 files)
✅ All models validated (28 files)
✅ All examples validated (5 files)
✅ All specs validated (2 files)

Documentation Verification

  • All code examples reviewed for accuracy
  • Links verified to be valid
  • YAML syntax validated for all examples
  • JSON Schema compatibility confirmed

Migration Notes

For Users

No migration needed. Simply enjoy the new documentation and examples!

For Runtime Maintainers

No API changes. If you're implementing a runtime:

  • Review docs/RUNTIME_INTEGRATION.md for best practices
  • Check examples in examples/ for edge cases
  • Consider adding your runtime to the integration guide

For Contributors

The contribution workflow remains the same. See docs/CONTRIBUTING_PROVIDER.md for:

  • Improved step-by-step guidance
  • Better examples of provider manifests
  • Clearer validation procedures

Statistics

Documentation Growth

Metric v0.3.5 v0.4.0 Change
Documentation files 4 8 +100%
Example files 1 5 +400%
Total documentation words ~8,000 ~48,000 +500%

Code Statistics

  • Lines of YAML added: ~27,000
  • Lines of Markdown added: ~40,000
  • Example configurations: 4 new patterns
  • Code snippets: 10+ working examples

Acknowledgments

This release was driven by community feedback requesting:

  • Better onboarding documentation
  • More practical examples
  • Clearer contribution guidelines
  • Runtime implementation guidance

Thank you to all testers and reviewers!

Next Steps

Looking ahead to v0.5.0 and beyond:

  1. v2-alpha Development: Continue experimental features (multimodal streams, real-time)
  2. Provider Expansion: Add 2-3 new providers based on community requests
  3. CLI Tool: Begin work on ai-protocol-cli for protocol validation and management
  4. Integration Examples: Add framework integration examples (LangChain, LlamaIndex)

Support

Documentation

Issues

Release prepared by: Technical Team
Version: 0.4.0
Release Type: Documentation & Examples

Download

Assets 2
Loading