agent99 0.0.4 → 0.0.5

data/CHANGELOG.md

@@ -2,8 +2,39 @@
 
 ## [Unreleased]
 
+
 ## Released
 
+### [0.0.5] 2025-09-03
+
+#### Added
+- Comprehensive demo runner (`examples/run_demo.rb`) for Agent99 framework with multiple scenarios
+- Agent2Agent (A2A) protocol specification and documentation
+- Model Context Protocol (MCP) documentation
+- Hierarchical Temporal Memory (HTM) simulation and documentation
+- GitHub Actions workflow for documentation deployment
+- SQLite-based registry implementation
+- Bad agent example for testing and security demonstrations
+- HTM simulation script using SQLite database
+
+#### Changed
+- Updated README.md for improved clarity and structural improvements
+- Improved control command handling in Control agent example
+- Enhanced examples with better error handling and user experience
+- Updated Gemfile.lock to reflect dependency upgrades
+
+#### Fixed
+- **[BREAKING FIX]** Disabled broken JsonSchema validation to prevent runtime crashes
+  - Schema validation now returns empty array instead of crashing with `NameError: uninitialized constant Agent99::MessageProcessing::JsonSchema`
+  - Added TODO comment for future proper schema validation implementation
+- Fixed RabbitMQ dependency check hanging in demo runner
+  - Changed from `rabbitmq-server --help` to `which rabbitmq-server` for faster, non-blocking check
+- Demo runner now properly handles infrastructure startup and cleanup
+
+#### Removed
+- Removed SQLite registry implementation (replaced with improved Sinatra-based registry)
+- Removed debug statements from various components
+
 ### [0.0.4] 2024-12-14
 
 - This is a [breaking change](docs/breaking_change_v0.0.4.md)

data/COMMITS.md

@@ -0,0 +1,196 @@
+---
+url: https://www.conventionalcommits.org/en/v1.0.0/
+title: Conventional Commits
+description: A specification for adding human and machine readable meaning to commit messages
+access_date: 2025-07-31T20:51:29.000Z
+current_date: 2025-07-31T20:51:29.601Z
+---
+
+# Conventional Commits
+
+A specification for adding human and machine readable meaning to commit messages
+
+ Quick Summary Full Specification Contribute
+
+# Conventional Commits 1.0.0
+
+## Summary
+
+The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.
+
+The commit message should be structured as follows:
+
+---
+
+```
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+
+```
+
+---
+
+The commit contains the following structural elements, to communicate intent to the consumers of your library:
+
+1. **fix:** a commit of the _type_ `fix` patches a bug in your codebase (this correlates with `PATCH` in Semantic Versioning).
+2. **feat:** a commit of the _type_ `feat` introduces a new feature to the codebase (this correlates with `MINOR` in Semantic Versioning).
+3. **BREAKING CHANGE:** a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with `MAJOR` in Semantic Versioning). A BREAKING CHANGE can be part of commits of any _type_.
+4. _types_ other than `fix:` and `feat:` are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends `build:`, `chore:`,`ci:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others.
+5. _footers_ other than `BREAKING CHANGE: <description>` may be provided and follow a convention similar to git trailer format.
+
+Additional types are not mandated by the Conventional Commits specification, and have no implicit effect in Semantic Versioning (unless they include a BREAKING CHANGE). A scope may be provided to a commit’s type, to provide additional contextual information and is contained within parenthesis, e.g., `feat(parser): add ability to parse arrays`.
+
+## Examples
+
+### Commit message with description and breaking change footer
+
+```
+feat: allow provided config object to extend other configs
+
+BREAKING CHANGE: `extends` key in config file is now used for extending other config files
+
+```
+
+### Commit message with `!` to draw attention to breaking change
+
+```
+feat!: send an email to the customer when a product is shipped
+
+```
+
+### Commit message with scope and `!` to draw attention to breaking change
+
+```
+feat(api)!: send an email to the customer when a product is shipped
+
+```
+
+### Commit message with both `!` and BREAKING CHANGE footer
+
+```
+chore!: drop support for Node 6
+
+BREAKING CHANGE: use JavaScript features not available in Node 6.
+
+```
+
+### Commit message with no body
+
+```
+docs: correct spelling of CHANGELOG
+
+```
+
+### Commit message with scope
+
+```
+feat(lang): add Polish language
+
+```
+
+### Commit message with multi-paragraph body and multiple footers
+
+```
+fix: prevent racing of requests
+
+Introduce a request id and a reference to latest request. Dismiss
+incoming responses other than from latest request.
+
+Remove timeouts which were used to mitigate the racing issue but are
+obsolete now.
+
+Reviewed-by: Z
+Refs: #123
+
+```
+
+## Specification
+
+The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.
+
+1. Commits MUST be prefixed with a type, which consists of a noun, `feat`, `fix`, etc., followed by the OPTIONAL scope, OPTIONAL `!`, and REQUIRED terminal colon and space.
+2. The type `feat` MUST be used when a commit adds a new feature to your application or library.
+3. The type `fix` MUST be used when a commit represents a bug fix for your application.
+4. A scope MAY be provided after a type. A scope MUST consist of a noun describing a section of the codebase surrounded by parenthesis, e.g., `fix(parser):`
+5. A description MUST immediately follow the colon and space after the type/scope prefix. The description is a short summary of the code changes, e.g., _fix: array parsing issue when multiple spaces were contained in string_.
+6. A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description.
+7. A commit body is free-form and MAY consist of any number of newline separated paragraphs.
+8. One or more footers MAY be provided one blank line after the body. Each footer MUST consist of a word token, followed by either a `:<space>` or `<space>#` separator, followed by a string value (this is inspired by the git trailer convention).
+9. A footer’s token MUST use `-` in place of whitespace characters, e.g., `Acked-by` (this helps differentiate the footer section from a multi-paragraph body). An exception is made for `BREAKING CHANGE`, which MAY also be used as a token.
+10. A footer’s value MAY contain spaces and newlines, and parsing MUST terminate when the next valid footer token/separator pair is observed.
+11. Breaking changes MUST be indicated in the type/scope prefix of a commit, or as an entry in the footer.
+12. If included as a footer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g.,_BREAKING CHANGE: environment variables now take precedence over config files_.
+13. If included in the type/scope prefix, breaking changes MUST be indicated by a`!` immediately before the `:`. If `!` is used, `BREAKING CHANGE:` MAY be omitted from the footer section, and the commit description SHALL be used to describe the breaking change.
+14. Types other than `feat` and `fix` MAY be used in your commit messages, e.g., _docs: update ref docs._
+15. The units of information that make up Conventional Commits MUST NOT be treated as case sensitive by implementors, with the exception of BREAKING CHANGE which MUST be uppercase.
+16. BREAKING-CHANGE MUST be synonymous with BREAKING CHANGE, when used as a token in a footer.
+
+## Why Use Conventional Commits
+
+* Automatically generating CHANGELOGs.
+* Automatically determining a semantic version bump (based on the types of commits landed).
+* Communicating the nature of changes to teammates, the public, and other stakeholders.
+* Triggering build and publish processes.
+* Making it easier for people to contribute to your projects, by allowing them to explore a more structured commit history.
+
+## FAQ
+
+### How should I deal with commit messages in the initial development phase?
+
+We recommend that you proceed as if you’ve already released the product. Typically _somebody_, even if it’s your fellow software developers, is using your software. They’ll want to know what’s fixed, what breaks etc.
+
+### Are the types in the commit title uppercase or lowercase?
+
+Any casing may be used, but it’s best to be consistent.
+
+### What do I do if the commit conforms to more than one of the commit types?
+
+Go back and make multiple commits whenever possible. Part of the benefit of Conventional Commits is its ability to drive us to make more organized commits and PRs.
+
+### Doesn’t this discourage rapid development and fast iteration?
+
+It discourages moving fast in a disorganized way. It helps you be able to move fast long term across multiple projects with varied contributors.
+
+### Might Conventional Commits lead developers to limit the type of commits they make because they’ll be thinking in the types provided?
+
+Conventional Commits encourages us to make more of certain types of commits such as fixes. Other than that, the flexibility of Conventional Commits allows your team to come up with their own types and change those types over time.
+
+### How does this relate to SemVer?
+
+`fix` type commits should be translated to `PATCH` releases. `feat` type commits should be translated to `MINOR` releases. Commits with `BREAKING CHANGE` in the commits, regardless of type, should be translated to `MAJOR` releases.
+
+### How should I version my extensions to the Conventional Commits Specification, e.g. `@jameswomack/conventional-commit-spec`?
+
+We recommend using SemVer to release your own extensions to this specification (and encourage you to make these extensions!)
+
+### What do I do if I accidentally use the wrong commit type?
+
+#### When you used a type that’s of the spec but not the correct type, e.g. `fix` instead of `feat`
+
+Prior to merging or releasing the mistake, we recommend using `git rebase -i` to edit the commit history. After release, the cleanup will be different according to what tools and processes you use.
+
+#### When you used a type _not_ of the spec, e.g. `feet` instead of `feat`
+
+In a worst case scenario, it’s not the end of the world if a commit lands that does not meet the Conventional Commits specification. It simply means that commit will be missed by tools that are based on the spec.
+
+### Do all my contributors need to use the Conventional Commits specification?
+
+No! If you use a squash based workflow on Git lead maintainers can clean up the commit messages as they’re merged—adding no workload to casual committers. A common workflow for this is to have your git system automatically squash commits from a pull request and present a form for the lead maintainer to enter the proper git commit message for the merge.
+
+### How does Conventional Commits handle revert commits?
+
+Reverting code can be complicated: are you reverting multiple commits? if you revert a feature, should the next release instead be a patch?
+
+Conventional Commits does not make an explicit effort to define revert behavior. Instead we leave it to tooling authors to use the flexibility of _types_ and _footers_ to develop their logic for handling reverts.
+
+One recommendation is to use the `revert` type, and a footer that references the commit SHAs that are being reverted:
+
+```
+revert: let us never again speak of the noodle incident
+
+Refs: 676104e, a215868
+
+```

data/DOCS.md

@@ -0,0 +1,96 @@
+# Agent99 Documentation
+
+This repository uses [MkDocs](https://www.mkdocs.org/) with the [Material theme](https://squidfunk.github.io/mkdocs-material/) to generate comprehensive documentation for the Agent99 framework.
+
+## 📚 Documentation Structure
+
+```
+docs/
+├── index.md                    # Homepage
+├── getting-started/           # Installation and quick start guides
+├── core-concepts/            # Fundamental concepts and architecture
+├── framework-components/     # Deep dive into system components
+├── agent-development/       # Guide to building agents
+├── advanced-topics/        # Advanced features and protocols
+├── api-reference/          # API documentation
+├── operations/             # Configuration, security, troubleshooting
+├── examples/              # Code examples and tutorials
+└── assets/               # Images, diagrams, and other assets
+```
+
+## 🚀 Building the Documentation
+
+### Prerequisites
+
+Install MkDocs and required dependencies:
+
+```bash
+pip install mkdocs mkdocs-material
+```
+
+### Build and Serve Locally
+
+```bash
+# Serve the documentation locally (auto-reloads on changes)
+mkdocs serve
+
+# Build static documentation
+mkdocs build
+
+# Deploy to GitHub Pages (if configured)
+mkdocs gh-deploy
+```
+
+The documentation will be available at `http://localhost:8000` when serving locally.
+
+## 📖 Key Documentation Sections
+
+- **[Getting Started](docs/getting-started/overview.md)** - New to Agent99? Start here!
+- **[Core Concepts](docs/core-concepts/what-is-an-agent.md)** - Understand agents and architecture
+- **[Framework Components](docs/framework-components/agent-registry.md)** - How the system works
+- **[Agent Development](docs/agent-development/custom-agent-implementation.md)** - Build your own agents
+- **[Examples](docs/examples/basic-examples.md)** - Working code examples
+
+## 🎨 Documentation Features
+
+The documentation includes:
+
+- **Navigation tabs** for easy browsing
+- **Search functionality** with instant results
+- **Code syntax highlighting** for Ruby and other languages
+- **Mermaid diagram support** for architecture diagrams
+- **Dark/light theme toggle** for comfortable reading
+- **Mobile-responsive design** for all devices
+- **Direct GitHub integration** for easy editing
+
+## 📝 Contributing to Documentation
+
+1. **Edit existing pages**: Navigate to the appropriate markdown file in the `docs/` directory
+2. **Add new pages**: Create new markdown files and update the navigation in `mkdocs.yml`
+3. **Add images**: Place images in `docs/assets/` and reference them with relative paths
+4. **Test changes**: Run `mkdocs serve` to preview your changes locally
+
+## 🔗 Links
+
+- **Live Documentation**: [https://madbomber.github.io/agent99](https://madbomber.github.io/agent99) (when deployed)
+- **Repository**: [https://github.com/MadBomber/agent99](https://github.com/MadBomber/agent99)
+- **RubyGems**: [https://rubygems.org/gems/agent99](https://rubygems.org/gems/agent99)
+
+## 📋 Documentation TODO
+
+Missing documentation files that should be created:
+
+- `docs/getting-started/quick-start.md` - Quick setup guide
+- `docs/getting-started/basic-example.md` - Step-by-step first agent
+- `docs/core-concepts/agent-types.md` - Server, Client, Hybrid agents
+- `docs/agent-development/request-response-handling.md` - Message handling patterns
+- `docs/advanced-topics/multi-agent-processing.md` - Running multiple agents
+- `docs/api-reference/agent99-base.md` - Core API documentation
+- `docs/api-reference/registry-client.md` - Registry API docs
+- `docs/api-reference/message-clients.md` - Messaging API docs
+- `docs/api-reference/schemas.md` - Schema definitions
+- `docs/examples/advanced-examples.md` - Complex examples
+
+---
+
+*The documentation is organized to provide a clear learning path from basic concepts to advanced topics, making Agent99 accessible to developers at all levels.*

data/README.md

@@ -1,64 +1,102 @@
 # Agent99
+<br/>
+
+> [!CAUTION]
+> ## ⚠️ Under Development ⚠️
+> Initial release has no AI components - it's a generic client-server / request-response micro-services system using peer-to-peer messaging and centralized agent registry. Review [The Changelog](./CHANGELOG.md) for version changes.
+<br /><br />
+
+<div align="center">
+  <table>
+    <tr>
+      <td width="40%" align="center" valign="top">
+        <img src="docs/assets/images/agent99_logo.png" alt="Agent99 - Ruby Framework for Intelligent Software Agents" width="1200">
+        <br /><br />
+        [Comprehensive Documentation Website](https://madbomber.github.io/agent99/)
+      </td>
+      <td width="60%" align="left" valign="top">
+        Agent99 is a Ruby-based framework for building and managing intelligent software agents in a distributed system. Like the clever Agent 99 from Get Smart, your agents will be smart, adaptable, and ready to tackle any challenge through seamless peer-to-peer communication and centralized discovery.
+        <br/><br/>
+        <h3>Key Features</h3>
+        <ul>
+            <li><strong>🌐 <a href="#agent-discovery">Agent Discovery</a></strong> - Find agents by capabilities</li>
+            <li><strong>📡 <a href="#flexible-communication">Peer-to-Peer Messaging</a></strong> - AMQP & NATS support</li>
+            <li><strong>🔄 <a href="#message-processing">Message Processing</a></strong> - Requests, responses & control</li>
+            <li><strong>📋 <a href="#registry-integration">Registry Integration</a></strong> - Centralized agent registry</li>
+            <li><strong>⚡ <a href="#control-actions">Control Actions</a></strong> - Pause, resume, update agents</li>
+            <li><strong>🔧 <a href="#agent-lifecycle-management">Lifecycle Management</a></strong> - Easy setup & teardown</li>
+            <li><strong>🚀 <a href="#multi-agent-processing">Multi-Agent Processing</a></strong> - Thread isolation support</li>
+            <li><strong>📊 <a href="#error-handling-and-logging">Error Handling & Logging</a></strong> - Built-in management</li>
+        </ul>
+      </td>
+    </tr>
+  </table>
+</div>
+
+## Table of Contents
+
+* [Quick Start](#quick-start)
+* [Prerequisites](#prerequisites)
+* [Architecture Overview](#architecture-overview)
+* [Installation](#installation)
+* [Usage](#usage)
+* [Configuration](#configuration)
+* [Agent Lifecycle](#agent-lifecycle)
+* [Message Processing](#message-processing)
+* [Registry Integration](#registry-integration)
+* [Examples](#examples)
+* [Evolving Standards](#evolving-standards)
+* [Contributing](#contributing)
+* [Roadmap](#roadmap)
+* [License](#license)
+
+## Quick Start
+
+Jump right in with our step-by-step guide:
+
+1. **Prerequisites**: [Install message broker](#prerequisites) (NATS or RabbitMQ)
+2. **Install Agent99**: Add to Gemfile and bundle install
+3. **Start Registry**: Launch the central agent registry
+4. **Create Your First Agent**: Build a simple greeter agent
+5. **Test Communication**: Verify agents can discover and communicate
+
+📖 **Detailed walkthrough**: [Getting Started Guide](docs/getting-started/quick-start.md)
+
+## Prerequisites
+
+Agent99 requires a message broker for inter-agent communication. Choose one:
+
+### NATS (Recommended)
+```bash
+# macOS
+brew install nats-server
+
+# Start NATS
+nats-server
+```
 
-**Under Development**  Initial release has no AI components - its just a generic client-server / request-response micro-services system using a peer-to-peer messaging broker and a centralized agent registry.  To keep up with the version changes review [The Changelog](./CHANGELOG.md) file.
-
-v0.0.4 has a [breaking_change.](docs/breaking_change_v0.0.4.md)
-
-Agent99 is a Ruby-based framework for building and managing AI agents in a distributed system. It provides a robust foundation for creating intelligent agents that can communicate, discover each other, and perform various tasks.
-
-## Hype!
-
-🌟 **Introducing Agent99**: Your Friendly Ruby Sidekick for Building Intelligent Software Agents! 🌟
-
-Do you ever miss the charm and wit of Barbara Feldon's iconic character from *Get Smart*? Just as Agent 99 was always ready to tackle mischief and save the day, **Agent99** is here to help you create your very own software agents that can communicate, collaborate, and conquer tasks in a smart and efficient way!
-
-### Why Choose Agent99?
-
-🔍 **Independent Agents, Unified Communication**: Say goodbye to complex service orchestration! Agent99 empowers you to build micro-services that communicate seamlessly through a robust peer-to-peer messaging network. Each agent operates independently while working together like a well-oiled machine!
-
-🤖 **Smart Automation for the Modern Age**: In the era of AI, why settle for less? With Agent99, you can develop software agents that respond intelligently to incoming requests—just like a secret agent reacting to their next mission! Deploy your own digital spies to gather data, complete tasks, and more.
-
-📦 **Quick Setup & Easy Integration**: Just like Agent 99’s quick thinking, our library is designed for rapid development. Get up and running in no time, whether you’re building a small project or an enterprise-level solution!
-
-
-### Features that Make Agent99 a Must-Have:
-
-- 🌐 **Peer-to-Peer Messaging**: Ensure that your agents can communicate effortlessly, just like Agent 99 and Max.
-- 🚀 **Agile Development**: Design and deploy agents at lightning speed, giving you the freedom to innovate.
-- 🔒 **Secure Communication**: Built with security in mind, because even our agents deserve to keep their secrets safe.
-- 📊 **Scalability**: Expand your network of agents as your needs grow—no mission is too big!
-
-### Get Smart! Join the Revolution!
-
-Whether you’re a seasoned Ruby developer or just getting started, Agent99 provides the tools you need to build your very own quirky, intelligent agents. Just like Agent 99, your agents will be clever, adaptable, and ready to tackle any challenge!
-
-### How to Get Started:
-
-1. **Install**: Simply add Agent99 to your Gemfile and run `bundle install`.
-2. **Create an Agent**: Use our simple API to define and deploy your first agent.
-3. **Watch Them Work**: Sit back and relax as your agents spring into action, communicating with one another to accomplish tasks that would impress even the chief of CONTROL!
+### RabbitMQ  
+```bash
+# macOS
+brew install rabbitmq
 
-### Spread the Word!
+# Start RabbitMQ
+brew services start rabbitmq
+```
 
-**Join the Agent99 community** on GitHub and share your experiences, tips, and feedback. Let’s build a world of smart agents together! And remember, just like Agent 99 always had Max’s back, we’ve got yours during your development journey.
+📋 **More installation options**: [Installation Guide](docs/getting-started/installation.md)
 
-🕵️‍♂️ **Become an Agent!** Dive into the world of Agent99 today: [GitHub Repository](#) 📖
+## Architecture Overview
 
-**Agent99** – Because when it comes to building software agents, it's all about being smart!
+![Agent99 Architecture](docs/assets/images/agent99-architecture.svg)
 
-... end of the Hype; now back to normal.
+Agent99 follows a distributed architecture with three core components:
 
-## Features
+- **🏛️ Central Registry**: Service discovery and agent registration
+- **📡 Message Broker**: Peer-to-peer communication backbone (NATS/AMQP)
+- **🤖 Agents**: Independent services with specific capabilities
 
-- Agent Lifecycle Management: Easy setup and teardown of agents
-- Message Processing: Handle requests, responses, and control messages
-- Agent Discovery: Find other agents based on capabilities
-- Flexible Communication: Support for both AMQP and NATS messaging systems
-- Registry Integration: Register and discover agents through a central registry
-- Error Handling and Logging: Built-in error management and logging capabilities
-- Control Actions: Pause, resume, update configuration, and request status of agents
-- Dynamic Agent Loading: Support for runtime loading and deployment of new agents
-- Multi-Agent Processing: Run multiple agents within the same process using thread isolation
+📚 **Deep dive**: [Architecture Documentation](docs/core-concepts/architecture.md)
 
 ## Installation
 
@@ -82,67 +120,151 @@ $ gem install agent99
 
 ## Usage
 
-Here's a basic example of how to create an AI agent:
+Create your first agent in three simple steps:
 
+### 1. Define Request Schema
 ```ruby
-require 'agent99'
-
 class GreeterRequest < SimpleJsonSchemaBuilder::Base
   object do
     object :header, schema: Agent99::HeaderSchema
     string :name, required: true, examples: ["World"]
   end
 end
+```
 
+### 2. Implement Agent Class
+```ruby
 class GreeterAgent < Agent99::Base
   def info
     {
-      name:             self.class.to_s,
-      type:             :server,
-      capabilities:     ['greeter', 'hello_world'],
-      request_schema:   GreeterRequest.schema,
-      # Uncomment and define these schemas as needed:
-      # response_schema:  {}, # Agent99::RESPONSE.schema
-      # control_schema:   {}, # Agent99::CONTROL.schema
-      # error_schema:     {}, # Agent99::ERROR.schema
+      name: self.class.to_s,
+      type: :server,
+      capabilities: ['greeter', 'hello_world'],
+      request_schema: GreeterRequest.schema
     }
   end
 
   def process_request(payload)
-    name      = payload.dig(:name)
-    response  = { result: "Hello, #{name}!" }
-    send_response(response)
+    name = payload.dig(:name)
+    send_response(result: "Hello, #{name}!")
   end
 end
+```
 
-# Create and run the agent
+### 3. Run Your Agent
+```ruby
+require 'agent99'
 agent = GreeterAgent.new
 agent.run
 ```
 
+🎯 **More examples**: [Usage Examples](docs/examples/)
+
 ## Configuration
 
-The framework can be configured through environment variables:
+Configure Agent99 through environment variables:
+
+### Core Settings
+- `AGENT99_REGISTRY_URL`: Registry service URL (default: `http://localhost:4567`)
+- `AGENT99_LOG_LEVEL`: Logging verbosity (default: `INFO`)
 
-- `AGENT99_REGISTRY_URL`: URL of the agent registry service (default: 'http://localhost:4567')
+### NATS Configuration
+- `NATS_URL`: NATS server URL (default: `nats://localhost:4222`)
+- `NATS_USER`: Username for authentication
+- `NATS_PASS`: Password for authentication
 
-Depending on which messaging client you are using, additional environment variables may be used.
+### AMQP/RabbitMQ Configuration
+- `RABBITMQ_URL`: RabbitMQ server URL (default: `amqp://localhost:5672`)
+- `RABBITMQ_USER`: Username (default: `guest`)
+- `RABBITMQ_PASS`: Password (default: `guest`)
 
-TODO: show envars for AMQP via Bunny
-TODO: show envars for NATS via nats0server
+📚 **Complete configuration guide**: [Configuration Documentation](docs/configuration/)
+
+## Agent Lifecycle
+
+![Agent Lifecycle](docs/assets/images/agent-lifecycle.svg)
+
+Agent99 manages the complete lifecycle of your agents:
+
+- **🎬 Initialization**: Agent registers with the central registry
+- **⚡ Running**: Agent processes requests and sends responses
+- **⏸️ Paused**: Agent temporarily stops processing (control action)
+- **🔄 Updated**: Agent receives new configuration or capabilities
+- **🛑 Shutdown**: Agent gracefully disconnects and cleans up
+
+🔄 **Detailed lifecycle management**: [Agent Lifecycle Guide](docs/core-concepts/agent-lifecycle.md)
+
+## Message Processing
+
+![Message Processing Flow](docs/assets/images/message-processing-flow.svg)
+
+Agent99 handles three types of messages:
+
+- **📨 Requests**: Incoming work for agents to process
+- **📤 Responses**: Results sent back to requesters
+- **🎛️ Control**: Management commands (pause, resume, update)
+
+Each message is validated, routed, and processed with full error handling and logging.
+
+⚙️ **Message processing details**: [Message Processing Guide](docs/framework-components/message-processing.md)
+
+## Registry Integration
+
+![Agent Registry Process](docs/assets/images/agent-registry-processes.svg)
+
+The central registry enables dynamic service discovery:
+
+1. **📝 Registration**: Agents announce their capabilities
+2. **🔍 Discovery**: Find agents by capability or name
+3. **📋 Management**: Monitor and control registered agents
+4. **🚪 Withdrawal**: Clean removal from registry
+
+The registry supports both HTTP REST API and direct client integration.
+
+🏛️ **Registry implementation**: [Registry Documentation](docs/framework-components/agent-registry.md)
+
+## Examples
+
+Explore real-world implementations:
+
+- **🚀 [Demo Runner](examples/run_demo.rb)**: Complete working system
+- **👋 [Greeter Agent](examples/greeter_agent.rb)**: Simple request-response
+- **🔄 [Multi-Agent System](examples/multi_agent/)**: Coordinated agents
+- **📊 [Monitoring Dashboard](examples/dashboard/)**: Agent status monitoring
+
+💡 **All examples**: [Examples Directory](docs/examples/)
+
+## Evolving Standards
+
+- [agntcy.org](https://agntcy.org) - Agency protocol initiative
+- [Agent2Agent](https://a2a-protocol.org/latest/) - Linux Foundation protocol
 
-See the examples folder for a default registry service implementation.
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/MadBomber/agent99.
 
-## Short-term Roadmap
+## Roadmap
+
+### Short-term (v0.1.x)
+- **🔍 Enhanced Discovery**: Semantic search with vector database (SQLite + embeddings)
+- **📋 Schema Validation**: Complete request/response schema definitions
+- **🤖 AI Integration**: RAG-enabled agents using prompts as tools
+- **📊 Monitoring**: Built-in metrics and health checks
+
+### Medium-term (v0.2.x)
+- **🔐 Security**: Authentication and authorization framework
+- **⚡ Performance**: Connection pooling and message batching
+- **🌍 Multi-broker**: Support for multiple message brokers simultaneously
+- **📈 Scaling**: Load balancing and auto-scaling capabilities
+
+### Long-term (v1.0+)
+- **🧠 Intelligence**: Built-in ML/AI capabilities
+- **🔗 Interoperability**: Full Agent2Agent protocol compliance
+- **☁️ Cloud-native**: Kubernetes operators and cloud integrations
+
+⚠️ **Breaking changes**: [Migration Guide v0.0.4](docs/breaking_change_v0.0.4.md)
 
-- In the example registry, replace the Array(Hash) datastore with sqlite3 with a vector table to support discovery using semantic search.
-- Treat the agent like a Tool w/r/t RAG for prompts.
-- Add AgentRequest schema to agent's info in the registry.
-- Add AgentResponse schema to define the `result` element in the response JSON payload
 
 ## License