# Agent99 Framework Documentation

Welcome to the Agent99 Framework documentation! Below is a table of contents and brief summaries of each markdown file available in this directory.  Explore each document for more detailed information on the Agent99 Framework and how to effectively utilize it in your projects!

## Table of Contents

1. **[Agent Discovery](agent_discovery.md)**
      - This document explains how agents within the Agent99 framework discover each other based on their declared capabilities, including the registration and querying processes involved.

2. **[Agent Lifecycle](agent_lifecycle.md)**
      - Learn about the various stages an agent undergoes during its lifetime, from creation and initialization to running and graceful shutdown.

3. **[Agent Registry Processes](agent_registry_processes.md)**
      - This file details the processes handled by the Agent registry, including registration, discovery, and withdrawal of agents, along with example code to illustrate these concepts.

4. **[API Reference](api_reference.md)**
      - The API Reference provides comprehensive details about public methods and classes within Agent99, ensuring developers can leverage its full capabilities.

5. **[Architecture Overview](architecture_overview.md)**
      - An overview of the architecture of Agent99, describing its microservices-oriented structure, communication workflows, and how agents operate within the system.

6. **[Configuration](configuration.md)**
      - Discover how to configure agents using environment variables, including important settings such as the registry base URL.

7. **[Control Actions](control_actions.md)**
      - This document lists the control actions available to agents, such as shutdown, pause, and resume, along with instructions on how to create custom actions.

8. **[Custom Agent Implementation](custom_agent_implementation.md)**
      - Guidelines on creating custom agents, including subclassing, defining schemas, and implementing request and response handling.

9. **[Error Handling and Logging](error_handling_and_logging.md)**
      - Understanding the error handling mechanisms in Agent99, as well as how to configure logging for better monitoring and debugging.

10. **[Extending the Framework](extending_the_framework.md)**
      - Instructions on how to extend Agent99 by implementing custom modules, defining new message types, and using hooks for additional functionality.

11. **[Message Processing](message_processing.md)**
      - This document outlines the different message types supported by Agent99, how they are processed, and the importance of schema validation.

12. **[Messaging Systems](messaging_systems.md)**
      - Overview of the messaging protocols supported by Agent99, including AMQP and NATS, and guidance on how to switch between them.

13. **[Advanced Features](advanced_features.md)**
      - Learn about dynamic agent loading, multi-agent processing, and best practices for running multiple agents within the same process.

14. **[Performance Considerations](performance_considerations.md)**
      - Best practices for ensuring optimal performance within the framework, including optimization techniques and profiling performance.

15. **[Schema Definition](schema_definition.md)**
      - Detailed instructions on how to define schemas using `SimpleJsonSchemaBuilder`, with examples to guide you through the process.

16. **[Security](security.md)**
      - Recommendations on implementing security measures within Agent99, focusing on message encryption and access control.

17. **[Troubleshooting](troubleshooting.md)**
      - Common issues encountered while using Agent99 and suggested steps for debugging, including examining logs and configuration settings.