solace-agent-mesh 0.2.4__py3-none-any.whl → 1.0.1__py3-none-any.whl

solace_agent_mesh/templates/templates_llm.txt

@@ -0,0 +1,147 @@
+Here is the DEVELOPER GUIDE for the `templates` directory.
+
+## Quick Summary
+
+The `templates` directory contains boilerplate files for creating various components within the Solace Agent Mesh (SAM) ecosystem. These templates are used by the `sam` command-line interface (CLI) and developers to bootstrap new agents, gateways, and plugins. They provide a standardized starting point, ensuring new components adhere to the required structure and include necessary configurations.
+
+## Files Overview
+
+*   `agent_template.yaml`: A template for a standard agent configuration file.
+*   `eval_backend_template.yaml`: Configuration template for the A2A Evaluation Backend service.
+*   `gateway_app_template.py`: Python template for a custom gateway's main `App` class, which handles configuration.
+*   `gateway_component_template.py`: Python template for a custom gateway's `Component` class, which implements the core logic.
+*   `gateway_config_template.yaml`: YAML configuration template for a custom gateway.
+*   `main_orchestrator.yaml`: Configuration template for the primary Orchestrator agent.
+*   `plugin_agent_config_template.yaml`: Template for an agent configuration generated from a plugin.
+*   `plugin_custom_config_template.yaml`: Template for a custom configuration file generated from a plugin.
+*   `plugin_custom_template.py`: Python template for a custom class within a plugin.
+*   `plugin_gateway_config_template.yaml`: Template for a gateway configuration generated from a plugin.
+*   `plugin_pyproject_template.toml`: Template for a plugin's `pyproject.toml` file, defining its packaging and dependencies.
+*   `plugin_readme_template.md`: Template for a plugin's `README.md` file.
+*   `plugin_tools_template.py`: Python template demonstrating how to create custom tools for a plugin.
+*   `shared_config.yaml`: A template for shared configuration settings (e.g., broker, models, services) used across multiple components.
+*   `webui.yaml`: Configuration template for the WebUI Gateway.
+
+## Developer API Reference
+
+### agent_template.yaml
+
+**Purpose:** A generic template for creating a new agent configuration. It includes placeholders that are typically filled in by a developer or a script to define a new agent's behavior, model, tools, and communication settings.
+
+**Key Placeholders:**
+*   `__AGENT_NAME__`: The unique name of the agent.
+*   `__NAMESPACE__`: The namespace the agent operates in.
+*   `__SUPPORTS_STREAMING__`: `true` or `false` to indicate if the agent supports streaming responses.
+*   `__MODEL_ALIAS__`: The alias of the language model to use (e.g., `*planning_model`).
+*   `__INSTRUCTION__`: The system prompt or instruction for the agent.
+*   `__TOOLS_CONFIG__`: A YAML list defining the tools available to the agent.
+*   `__SESSION_SERVICE__`, `__ARTIFACT_SERVICE__`: Configuration for session and artifact services.
+*   `__AGENT_CARD_...__`: Fields defining the agent's metadata for discovery.
+*   `__INTER_AGENT_COMMUNICATION_...__`: Rules for how this agent can communicate with other agents.
+
+---
+### eval_backend_template.yaml
+
+**Purpose:** A configuration template for the evaluation backend, a specialized REST gateway used for testing and evaluation purposes. It defines the broker connection, API settings, and system prompts.
+
+**Key Configuration:**
+*   `app_module`: Set to `solace_agent_mesh.gateway.rest.app` to use the standard REST gateway implementation.
+*   `namespace`: The operational namespace, often set via an environment variable `${NAMESPACE}`.
+*   `fastapi_host`, `fastapi_port`: The host and port for the backend's REST API.
+*   `cors_allowed_origins`: A list of origins allowed to make cross-origin requests to the API.
+*   `system_purpose`, `response_format`: Default prompts for the gateway.
+
+---
+### gateway_app_template.py
+
+**Purpose:** This template defines the main application class for a custom gateway. Its primary role is to extend `BaseGatewayApp` and define the gateway-specific configuration schema.
+
+**Import:** `from my_gateway.app import MyGatewayApp` (where `__GATEWAY_NAME_PASCAL_CASE__` is replaced, e.g., `MyGatewayApp`)
+
+**Classes:**
+- `__GATEWAY_NAME_PASCAL_CASE__GatewayApp(BaseGatewayApp)` - The main app class for the custom gateway.
+  - `SPECIFIC_APP_SCHEMA_PARAMS: List[Dict[str, Any]]` - A class attribute where you define the custom configuration parameters for your gateway. Each dictionary in the list defines a parameter's name, type, requirement, and description.
+  - `_get_gateway_component_class() -> Type[BaseGatewayComponent]` - An abstract method that must be implemented to return the type of your custom gateway component class.
+
+**Usage Examples:**
+```python
+# In your gateway's app.py (e.g., src/my_slack_gateway/app.py)
+
+from typing import Any, Dict, List, Type
+
+from solace_agent_mesh.gateway.base.app import BaseGatewayApp
+from solace_agent_mesh.gateway.base.component import BaseGatewayComponent
+
+# Import your component class
+from .component import MySlackGatewayComponent
+
+class MySlackGatewayApp(BaseGatewayApp):
+    """
+    App class for the My Slack Gateway.
+    """
+
+    # Define custom configuration parameters that will be available
+    # in the gateway's YAML config file.
+    SPECIFIC_APP_SCHEMA_PARAMS: List[Dict[str, Any]] = [
+        {
+            "name": "slack_bot_token",
+            "required": True,
+            "type": "string",
+            "description": "The Slack Bot User OAuth Token (starts with xoxb-).",
+        },
+        {
+            "name": "slack_app_token",
+            "required": True,
+            "type": "string",
+            "description": "The Slack App-Level Token for Socket Mode (starts with xapp-).",
+        },
+        {
+            "name": "default_target_agent",
+            "required": False,
+            "type": "string",
+            "default": "OrchestratorAgent",
+            "description": "The default agent to send messages to.",
+        },
+    ]
+
+    def _get_gateway_component_class(self) -> Type[BaseGatewayComponent]:
+        """
+        Returns the specific gateway component class for this app.
+        """
+        return MySlackGatewayComponent
+```
+
+---
+### gateway_component_template.py
+
+**Purpose:** This template implements the core logic of a custom gateway. It handles the lifecycle of the gateway, communication with the external system, and translation between the external system's data format and the A2A (Agent-to-Agent) protocol.
+
+**Import:** `from my_gateway.component import MyGatewayComponent` (where `__GATEWAY_NAME_PASCAL_CASE__` is replaced)
+
+**Classes:**
+- `__GATEWAY_NAME_PASCAL_CASE__GatewayComponent(BaseGatewayComponent)` - The main component class implementing the gateway's logic.
+  - `_start_listener() -> None` - **GDK Hook:** Implement this to start listening for events from the external system (e.g., start a polling loop, connect a client). Called by the framework.
+  - `_stop_listener() -> None` - **GDK Hook:** Implement this to stop listening and clean up connections to the external system. Called by the framework.
+  - `_authenticate_external_user(external_event_data: Any) -> Optional[str]` - **GDK Hook:** Implement this to authenticate an incoming request from the external system. Return a unique user ID string on success, `None` on failure.
+  - `_translate_external_input(external_event_data: Any, authenticated_user_identity: str) -> Tuple[Optional[str], List[A2APart], Dict[str, Any]]` - **GDK Hook:** Implement this to convert an event from the external system into an A2A task. Returns the target agent name, a list of A2A parts (Text, File, etc.), and a context dictionary to be used for sending the response back.
+  - `_send_final_response_to_external(external_request_context: Dict[str, Any], task_data: Task) -> None` - **GDK Hook:** Implement this to send the final result of an A2A task back to the external system.
+  - `_send_error_to_external(external_request_context: Dict[str, Any], error_data: JSONRPCError) -> None` - **GDK Hook:** Implement this to send an error notification back to the external system.
+  - `_send_update_to_external(external_request_context: Dict[str, Any], event_data: Union[TaskStatusUpdateEvent, TaskArtifactUpdateEvent], is_final_chunk_of_update: bool) -> None` - **GDK Hook:** (Optional) Implement this to handle streaming intermediate updates (e.g., "Agent is thinking...") back to the external system.
+  - `cleanup() -> None` - **GDK Hook:** Perform any final cleanup before the component is destroyed. Always call `super().cleanup()`.
+
+**Usage Examples:**
+```python
+# In your gateway's component.py (e.g., src/my_slack_gateway/component.py)
+# This is a conceptual example of the implementation flow.
+
+from typing import Any, Dict, List, Optional, Tuple
+from solace_agent_mesh.gateway.base.component import BaseGatewayComponent
+from solace_agent_mesh.common.types import Part as A2APart, TextPart, Task
+
+class MySlackGatewayComponent(BaseGatewayComponent):
+    def __init__(self, **kwargs: Any):
+        super().__init__(**kwargs)
+        # Retrieve config defined in the App class
+        self.slack_token = self.get_config("slack_bot_token")
+        self.default_agent = self.get_config("default_target_agent")
+        # self.slack_client = SlackClient(token=self.slack_token)

solace_agent_mesh/templates/webui.yaml

@@ -0,0 +1,53 @@
+# Solace Agent Mesh WebUI Gateway Configuration
+
+log:
+  stdout_log_level: INFO
+  log_file_level: DEBUG
+  log_file: webui_app.log
+
+# Shared SAM config
+!include ../shared_config.yaml
+
+apps:
+  - name: a2a_webui_app
+    app_base_path: .
+    app_module: solace_agent_mesh.gateway.http_sse.app
+
+    broker:
+      <<: *broker_connection
+
+    app_config:
+      namespace: ${NAMESPACE}
+      session_secret_key: ${SESSION_SECRET_KEY}
+
+      artifact_service: *default_artifact_service
+
+      gateway_id: ${WEBUI_GATEWAY_ID}
+      fastapi_host: ${FASTAPI_HOST}
+      fastapi_port: ${FASTAPI_PORT}
+      cors_allowed_origins: # List of allowed origins for CORS
+        - "http://localhost:3000" # Example: Allow local React dev server
+        - "http://127.0.0.1:3000"
+        # Add other origins as needed, or use ["*"] for wide open (less secure)
+
+      enable_embed_resolution: ${ENABLE_EMBED_RESOLUTION} # Enable late-stage resolution
+      gateway_artifact_content_limit_bytes: ${GATEWAY_ARTIFACT_LIMIT_BYTES, 10000000} # Max size for late-stage embeds
+      sse_max_queue_size: ${SSE_MAX_QUEUE_SIZE, 200} # Max size of SSE connection queues
+
+      system_purpose: >
+            The system is an AI Chatbot with agentic capabilities.
+            It will use the agents available to provide information,
+            reasoning and general assistance for the users in this system.
+            **Always return useful artifacts and files that you create to the user.**
+            Provide a status update before each tool call.
+            Your external name is Agent Mesh.
+
+      response_format: >
+            Responses should be clear, concise, and professionally toned.
+            Format responses to the user in Markdown using appropriate formatting.
+
+      # --- Frontend Config Passthrough ---
+      frontend_welcome_message: >
+            __FRONTEND_WELCOME_MESSAGE__
+      frontend_bot_name: __FRONTEND_BOT_NAME__
+      frontend_collect_feedback: __FRONTEND_COLLECT_FEEDBACK__

solace_agent_mesh-1.0.1.dist-info/METADATA

@@ -0,0 +1,432 @@
+Metadata-Version: 2.4
+Name: solace-agent-mesh
+Version: 1.0.1
+Summary: Solace Agent Mesh is an open-source framework for building event-driven, multi-agent AI systems where specialized agents collaborate on complex tasks.
+Project-URL: Homepage, https://github.com/SolaceLabs/solace-agent-mesh
+Project-URL: Repository, https://github.com/SolaceLabs/solace-agent-mesh
+Author-email: SolaceLabs <solacelabs@solace.com>
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright [yyyy] [name of copyright owner]
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+License-File: LICENSE
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.10.16
+Requires-Dist: asteval>=1.0.6
+Requires-Dist: asteval~=1.0.0
+Requires-Dist: beautifulsoup4>=4.12.0
+Requires-Dist: click~=8.1.7
+Requires-Dist: fastapi>=0.100
+Requires-Dist: flask-cors>=5.0.0
+Requires-Dist: flask==3.0.3
+Requires-Dist: gitpython~=3.1.44
+Requires-Dist: google-adk==1.7.0
+Requires-Dist: google-genai>=1.16.0
+Requires-Dist: holidays>=0.24
+Requires-Dist: httpx>=0.25
+Requires-Dist: itsdangerous>=2.0
+Requires-Dist: jmespath>=1.0.1
+Requires-Dist: jsonpath-ng>=1.7.0
+Requires-Dist: jwcrypto>=1.5
+Requires-Dist: kaleido==0.2.1
+Requires-Dist: litellm>=1.19.0
+Requires-Dist: markdownify>=1.1.0
+Requires-Dist: markitdown[all]==0.1.1
+Requires-Dist: mermaid-cli
+Requires-Dist: numpy>=2.2.5
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: playwright>=1.54.0
+Requires-Dist: plotly>=6.0.1
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pydub>=0.25.1
+Requires-Dist: pystache>=0.6.8
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: python-jwt>=3.3
+Requires-Dist: python-multipart>=0.0.7
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rouge~=1.0.1
+Requires-Dist: solace-ai-connector~=1.1.7
+Requires-Dist: sse-starlette>=1.6
+Requires-Dist: toml~=0.10.2
+Requires-Dist: uvicorn[standard]>=0.20
+Provides-Extra: cli
+Requires-Dist: click>=8.0; extra == 'cli'
+Requires-Dist: prompt-toolkit>=3.0; extra == 'cli'
+Requires-Dist: rich>=13.0; extra == 'cli'
+Provides-Extra: database
+Requires-Dist: sqlalchemy>=2.0; extra == 'database'
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.20; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: employee-tools
+Requires-Dist: holidays>=0.24; extra == 'employee-tools'
+Provides-Extra: gcs
+Requires-Dist: google-cloud-storage>=2.0; extra == 'gcs'
+Provides-Extra: vertex
+Requires-Dist: google-cloud-aiplatform>=1.38; extra == 'vertex'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="./docs/static/img/logo.png" alt="Solace Agent Mesh Logo" width="100"/>
+</p>
+<h2 align="center">
+  Solace Agent Mesh
+</h2>
+<h3 align="center">Open-source framework for building event driven multi-agent AI systems</h3>
+<h5 align="center">Star ⭐️ this repo to stay updated as we ship new features and improvements.</h5>
+
+<p align="center">
+  <a href="https://github.com/SolaceLabs/solace-agent-mesh/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/SolaceLabs/solace-agent-mesh" alt="License">
+  </a>
+  <a href="https://pypi.org/project/solace-agent-mesh">
+    <img src="https://img.shields.io/pypi/v/solace-agent-mesh.svg" alt="PyPI - Version">
+  </a>
+  <a href="https://pypi.org/project/solace-agent-mesh">
+    <img src="https://img.shields.io/pypi/pyversions/solace-agent-mesh.svg" alt="PyPI - Python Version">
+  </a>
+  <a href="https://pypi.org/project/solace-agent-mesh">
+      <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/solace-agent-mesh?color=00C895">
+  </a>
+</p>
+<p align="center">
+  <a href="#-key-features">Key Features</a> •
+  <a href="#-quick-start-5-minutes">Quickstart</a> •
+  <a href="#️-next-steps">Next Steps</a>
+</p>
+
+---
+
+The Solace Agent Mesh transforms how AI agents work together, creating a dynamic ecosystem where specialized agents communicate seamlessly, share information, and collaborate on complex tasks.
+
+Built on Solace PubSub+ Event Broker, this framework provides a robust foundation for enterprise-grade AI solutions that scale effortlessly. The mesh creates a standardized communication layer where AI agents can:
+
+* Delegate specialized tasks to peer agents
+* Share artifacts and data across the network
+* Connect with diverse user interfaces and external systems
+* Execute complex, multi-step workflows with minimal coupling
+
+Under the hood, the framework combines the Solace AI Connector (SAC) for runtime orchestration with Google's Agent Development Kit (ADK) for agent logic, LLM interaction, and tool execution—all communicating via the A2A protocol over Solace's event mesh. The result? A fully asynchronous, event-driven, and decoupled AI agent architecture ready for enterprise deployment.
+
+---
+
+## ✨ Key Features 
+- ⚙️ **[Modular, Event-Driven Architecture](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/getting-started/component-overview)** – All components communicate via events through a central event mesh, enabling loose coupling and high scalability.
+- 🤖 **[Composable Agents](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/concepts/agents)** – Combine specialized AI agents to solve complex, multi-step workflows.
+- 🌐 **[Flexible Interfaces](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/concepts/gateways)** – Interact with SAM via the REST API, browser UI, [Slack](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/tutorials/slack-integration), etc.
+- 🧠 **[Orchestration Agent](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/concepts/orchestrator)** – Tasks are automatically broken down and delegated across agents by the orchestrator agent.
+- 🧩 **[Plugin-Extensible](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/concepts/plugins)** – Add your own agents, gateways, or services with minimal boilerplate.
+- 🏢 **[Production-Ready](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/deployment/deploy)** – Backed by [Solace's enterprise-grade event broker](https://solace.com/products/event-broker/) for reliability and performance.
+- 📁 **[File Management](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/user-guide/builtin-tools/artifact-management)** – Built-in tools for managing file artifacts with automatic metadata injection and artifact handling.
+- 📊 **[Data Analysis Tools](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/user-guide/builtin-tools/data-analysis-tools)** – Built-in tools for SQL queries, JQ transformations, and Plotly chart generation.
+- 🔗 **[Dynamic Embeds](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/user-guide/builtin-tools/embeds)** – Include dynamic placeholders in responses that are resolved by the framework with support for modifier chains.
+- 🤝 **[Agent-to-Agent Communication](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/concepts/architecture)** – Agents can discover and delegate tasks to peer agents using the A2A protocol over Solace.
+
+---
+
+## 🚀 Quick Start (5 minutes)
+
+Set up Solace Agent Mesh in just a few steps.
+
+### ⚙️ System Requirements
+
+To run Solace Agent Mesh locally, you'll need:
+
+- **Python 3.10.16+**
+- **pip** (comes with Python)
+- **OS**: MacOS, Linux, or Windows (with [WSL](https://learn.microsoft.com/en-us/windows/wsl/))
+- **LLM API key** (any major provider or custom endpoint)
+
+### 💻 Setup Steps
+
+```bash
+# 1. (Optional) Create and activate a Python virtual environment
+python3 -m venv .venv
+source .venv/bin/activate
+
+# 2. Install the Solace Agent Mesh
+pip install solace-agent-mesh
+
+# 3. Initialize a new project with web-based setup
+mkdir my-agent-mesh && cd my-agent-mesh
+sam init --gui
+
+# 4. Run the project
+sam run
+```
+
+### 🔧 Adding Agents
+
+```bash
+# Add a new agent with GUI interface
+sam add agent --gui
+```
+
+Or install an existing plugin:
+
+```bash
+sam plugin add <your-component-name> --plugin <plugin-name>
+```
+
+#### Once running:
+
+Open the Web UI at [http://localhost:8000](http://localhost:8000) to talk with a chat interface.
+
+---
+
+## 🏗️ Architecture Overview
+
+Solace Agent Mesh provides a "Universal A2A Agent Host," a flexible and configurable runtime environment built by integrating Google's Agent Development Kit (ADK) with the Solace AI Connector (SAC) framework.
+
+The system allows you to:
+
+- Host AI agents developed with Google ADK within the SAC framework
+- Define agent capabilities (LLM model, instructions, tools) primarily through SAC YAML configuration
+- Utilize Solace PubSub+ as the transport for standard Agent-to-Agent (A2A) protocol communication
+- Enable dynamic discovery of peer agents running within the same ecosystem
+- Allow agents to delegate tasks to discovered peers via the A2A protocol over Solace
+- Manage file artifacts using built-in tools with automatic metadata injection
+- Perform data analysis using built-in SQL, JQ, and visualization tools
+- Use dynamic embeds for context-dependent information resolution
+
+### Key Components
+
+- **SAC** handles broker connections, configuration loading, and component lifecycle
+- **ADK** provides the agent runtime, LLM interaction, tool execution, and state management
+- **A2A Protocol** enables communication between clients and agents, and between peer agents
+- **Dynamic Embeds** allow placeholders in responses that are resolved with context-dependent information
+- **File Management** provides built-in tools for artifact creation, listing, loading, and metadata handling
+
+---
+
+## ➡️ Next Steps
+
+Want to go further? Here are some hands-on tutorials to help you get started:
+
+| 🔧 Integration | ⏱️ Est. Time | 📘 Tutorial |
+|----------------|--------------|-------------|
+| 🌤️ **Weather Agent**<br>Learn how to build an agent that gives Solace Agent Mesh  the ability to access real-time weather information.  | **~15 min** | [Weather Agent Plugin](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/tutorials/custom-agent) |
+| 🗃️ **SQL Database Integration**<br>Enable Solace Agent Mesh to answer company-specific questions using a sample coffee company database.| **~10–15 min** | [SQL Database Tutorial](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/tutorials/sql-database) |
+| 🧠 **MCP Integration**<br>Integrating a Model Context Protocol (MCP) Servers into Solace Agent Mesh. | **~10–15 min** | [MCP Integration Tutorial](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/tutorials/mcp-integration) |
+| 💬 **Slack Integration**<br>Chat with Solace Agent Mesh directly from Slack. | **~20–30 min** | [Slack Integration Tutorial](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/tutorials/slack-integration) |
+
+📚 Want to explore more? Check out the full [Solace Agent Mesh documentation](https://solacelabs.github.io/solace-agent-mesh/docs/documentation/getting-started/introduction/).
+
+---
+
+## 👥 Contributors
+
+Solace Agent Mesh is built with the help of our amazing community.  
+Thanks to everyone who has contributed ideas, code, and time to make this project better.  
+👀 View the full list of contributors → [GitHub Contributors](https://github.com/SolaceLabs/solace-agent-mesh/graphs/contributors)
+🤝 **Looking to contribute?** Check out [CONTRIBUTING.md](CONTRIBUTING.md) to get started and see how you can help.
+
+---
+
+## 📄 License
+
+This project is licensed under the **Apache 2.0 License**.  
+See the full license text in the [LICENSE](LICENSE) file.