solace-agent-mesh 1.11.2__py3-none-any.whl

solace_agent_mesh/templates/gateway_config_template.yaml

@@ -0,0 +1,38 @@
+# Solace Agent Mesh: __GATEWAY_NAME_SNAKE_CASE__ Gateway Configuration
+
+log:
+  stdout_log_level: INFO
+  log_file_level: DEBUG
+  log_file: "__GATEWAY_NAME_SNAKE_CASE___gateway.log"
+
+!include ../shared_config.yaml
+
+apps:
+  - name: __GATEWAY_NAME_SNAKE_CASE___gateway_app
+    app_base_path: .
+    app_module: src.__GATEWAY_NAME_SNAKE_CASE__.app
+
+    broker:
+      <<: *broker_connection
+
+    app_config:
+      namespace: __APP_CONFIG_NAMESPACE__
+      gateway_id: __GATEWAY_ID__
+      
+      artifact_service: __ARTIFACT_SERVICE__
+
+      system_purpose: >
+        __SYSTEM_PURPOSE__
+
+      response_format: >
+        __RESPONSE_FORMAT__
+
+      
+      # enable_embed_resolution: true # Default is true
+      # gateway_artifact_content_limit_bytes: 10485760 # 10MB
+      # gateway_recursive_embed_depth: 3
+
+      # --- __GATEWAY_NAME_PASCAL_CASE__ Specific Parameters (Define schema in src/__GATEWAY_NAME_SNAKE_CASE__/app.py) ---
+      # example_parameter: "default_value"
+      # api_key: "${__GATEWAY_NAME_UPPER_CASE__}_API_KEY" 
+      # endpoint_url: "https://api.example.com/__GATEWAY_NAME_SNAKE_CASE__"

solace_agent_mesh/templates/logging_config_template.yaml

@@ -0,0 +1,48 @@
+version: 1
+disable_existing_loggers: false
+
+formatters:
+  simpleFormatter:
+    format: "%(asctime)s | %(levelname)-5s | %(threadName)s | %(name)s | %(message)s"
+
+  coloredFormatter:
+    class: solace_ai_connector.logging.ColoredFormatter
+    format: "%(asctime)s | %(levelname)-5s | %(threadName)s | %(name)s | %(message)s"
+
+  jsonFormatter:
+    "()": pythonjsonlogger.json.JsonFormatter
+    format: "%(timestamp)s %(levelname)s %(threadName)s %(name)s %(message)s"
+    timestamp: "timestamp"
+
+handlers:
+  streamHandler:
+    class: logging.StreamHandler
+    formatter: coloredFormatter
+    stream: ext://sys.stdout
+
+  rotatingFileHandler:
+    class: logging.handlers.RotatingFileHandler
+    formatter: simpleFormatter
+    filename: ${LOGGING_FILE_NAME, sam.log}
+    mode: a
+    maxBytes: 52428800
+    backupCount: 10
+
+loggers:
+  solace_ai_connector:
+    level: ${LOGGING_SAC_LEVEL, INFO}
+    handlers: []
+
+  solace_agent_mesh:
+    level: ${LOGGING_SAM_LEVEL, INFO}
+    handlers: []
+
+  sam_trace:
+    level: ${LOGGING_SAM_TRACE_LEVEL, INFO}
+    handlers: []
+
+root:
+  level: ${LOGGING_ROOT_LEVEL, WARNING}
+  handlers:
+    - streamHandler
+    - rotatingFileHandler

solace_agent_mesh/templates/main_orchestrator.yaml

@@ -0,0 +1,66 @@
+# Solace Agent Mesh Orchestrator Agent Configurations
+
+log:
+  stdout_log_level: INFO
+  log_file_level: INFO
+  log_file: __LOG_FILE_NAME__
+
+# Shared SAM config
+!include ../shared_config.yaml
+
+apps:
+  - name: __APP_NAME__
+    app_base_path: .
+    app_module: solace_agent_mesh.agent.sac.app
+    broker:
+      <<: *broker_connection
+
+    app_config:
+      namespace: __NAMESPACE__ 
+      supports_streaming: __SUPPORTS_STREAMING__
+      agent_name: "__AGENT_NAME__"
+      display_name: "__AGENT_NAME__"
+      model: *planning_model 
+
+      instruction: |
+        __INSTRUCTION__
+      inject_system_purpose: true
+      inject_response_format: true
+      inject_user_profile: true
+      session_service: __SESSION_SERVICE__
+      artifact_service: __ARTIFACT_SERVICE__
+      artifact_handling_mode: "__ARTIFACT_HANDLING_MODE__" 
+      enable_embed_resolution: __ENABLE_EMBED_RESOLUTION__ 
+      enable_artifact_content_instruction: __ENABLE_ARTIFACT_CONTENT_INSTRUCTION__ 
+      data_tools_config: *default_data_tools_config
+      tools: 
+        - group_name: artifact_management
+          tool_type: builtin-group
+        - tool_type: builtin-group
+          group_name: "data_analysis"
+
+      agent_card:
+        description: "__AGENT_CARD_DESCRIPTION__"
+        defaultInputModes: __DEFAULT_INPUT_MODES__
+        defaultOutputModes: __DEFAULT_OUTPUT_MODES__
+        skills:
+        - id: strategic_planning
+          name: Strategic Planning
+          description: Analyzes complex requests and creates structured execution plans, breaking down multi-step goals into logical sequences with clear checkpoints and progress tracking.
+
+        - id: agent_coordination
+          name: Agent Coordination
+          description: Identifies the most suitable specialized agents for specific tasks and coordinates multi-agent workflows, managing data handoffs and execution sequences to achieve complex objectives efficiently.
+
+        - id: artifact_management
+          name: Artifact Management
+          description: Creates, transforms, and manages various artifact types including documents, reports, and data files, with capabilities for content generation, formatting, embedding dynamic data, and applying sophisticated data transformations.
+
+      agent_card_publishing: 
+        interval_seconds: __AGENT_CARD_PUBLISHING_INTERVAL__
+      agent_discovery: 
+        enabled: __AGENT_DISCOVERY_ENABLED__
+      inter_agent_communication:
+        allow_list: __INTER_AGENT_COMMUNICATION_ALLOW_LIST__
+        __INTER_AGENT_COMMUNICATION_DENY_LIST_LINE__
+        request_timeout_seconds: __INTER_AGENT_COMMUNICATION_TIMEOUT__

solace_agent_mesh/templates/plugin_agent_config_template.yaml

@@ -0,0 +1,122 @@
+# Plugin Metadata:
+# Name: __PLUGIN_KEBAB_CASE_NAME__
+# Version: __PLUGIN_VERSION__
+# Description: __PLUGIN_DESCRIPTION__
+# Author: __PLUGIN_AUTHOR_NAME__ <__PLUGIN_AUTHOR_EMAIL__>
+# 
+# --- Start of Agent Configuration Template ---
+# Solace Agent Mesh: Plugin Configuration Template
+#
+# This file serves as a template for creating new agent configurations from this plugin.
+# Use placeholders like __COMPONENT_KEBAB_CASE_NAME__, __COMPONENT_PASCAL_CASE_NAME__,
+# and __COMPONENT_UPPER_SNAKE_CASE_NAME__ where the specific component name should be inserted.
+
+log:
+  stdout_log_level: INFO
+  log_file_level: DEBUG
+  log_file: __COMPONENT_KEBAB_CASE_NAME__.log
+
+# To use the `shared_config.yaml` file, uncomment the following line and remove the `shared_config` section below.
+# !include ../shared_config.yaml
+shared_config:
+  - broker_connection: &broker_connection
+      dev_mode: ${SOLACE_DEV_MODE, false}
+      broker_url: ${SOLACE_BROKER_URL, ws://localhost:8008}
+      broker_username: ${SOLACE_BROKER_USERNAME, default}
+      broker_password: ${SOLACE_BROKER_PASSWORD, default}
+      broker_vpn: ${SOLACE_BROKER_VPN, default}
+      temporary_queue: ${USE_TEMPORARY_QUEUES, true}
+
+  - models:
+    general: &general_model
+      # This dictionary structure tells ADK to use the LiteLlm wrapper.
+      # 'model' uses the specific model identifier your endpoint expects.
+      model: ${LLM_SERVICE_GENERAL_MODEL_NAME} # Use env var for model name
+      # 'api_base' tells LiteLLM where to send the request.
+      api_base: ${LLM_SERVICE_ENDPOINT} # Use env var for endpoint URL
+      # 'api_key' provides authentication.
+      api_key: ${LLM_SERVICE_API_KEY} # Use env var for API key
+
+  - services:
+    # Default session service configuration
+    session_service: &default_session_service
+      type: "memory"
+      default_behavior: "PERSISTENT"
+    
+    # Default artifact service configuration
+    artifact_service: &default_artifact_service
+      type: "filesystem"
+      base_path: "/tmp/samv2"
+      artifact_scope: namespace # Or "namespace", "app", "custom"
+
+apps:
+  - name: __COMPONENT_KEBAB_CASE_NAME__-app
+    app_base_path: . 
+    app_module: solace_agent_mesh.agent.sac.app 
+    broker:
+      <<: *broker_connection
+
+    # App Level Config
+    app_config:
+      namespace: ${NAMESPACE} 
+      supports_streaming: true 
+      agent_name: "__COMPONENT_PASCAL_CASE_NAME__" 
+      display_name: "__COMPONENT_SPACED_CAPITALIZED_NAME__ Agent"
+      model: *general_model 
+
+      instruction: |
+        You're __COMPONENT_SPACED_CAPITALIZED_NAME__ agent.
+        Configure its specific instructions here.
+
+      tools:
+        - group_name: artifact_management
+          tool_type: builtin-group
+
+        # Example: Plugin creator should define their tools.
+        # - tool_type: mcp
+        #   connection_params:
+        #     type: stdio
+        #     command: "my-mcp-server-command"
+        #     args: ["--arg1", "value1"]
+        #     timeout: 30
+
+        # --- Example Python Tools (defined in tools.py) ---
+        # - tool_type: python
+        #   component_module: __PLUGIN_SNAKE_CASE_NAME__.tools
+        #   component_base_path: . # Relative to where the agent runs
+        #   function_name: example_text_processor_tool
+        #   tool_config:
+        #     prefix: "PluginProcessed: "
+        
+        # - tool_type: python
+        #   component_module: __PLUGIN_SNAKE_CASE_NAME__.tools
+        #   component_base_path: .
+        #   function_name: example_file_creator_tool
+        #   tool_config: {} # Add specific config if needed by the tool
+
+        # --- Example Builtin Tools ---
+        # - tool_type: builtin-group
+        #   group_name: "text_to_speech"
+        #   tool_config: {}
+
+      session_service: *default_session_service
+      artifact_service: *default_artifact_service
+
+      artifact_handling_mode: "reference"
+      enable_embed_resolution: true
+      enable_artifact_content_instruction: true
+
+      agent_card:
+        description: "__PLUGIN_DESCRIPTION__"
+        defaultInputModes: ["text"]
+        defaultOutputModes: ["text"]
+        skills: [] # Remove brackets after adding entries
+          # - id: "example_tool"
+          #   name: "Example Tool"
+          #   description: "An example tool provided by the __PLUGIN_PASCAL_CASE_NAME__ plugin."
+
+      agent_card_publishing: { interval_seconds: 10 }
+      agent_discovery: { enabled: false }
+      inter_agent_communication:
+        allow_list: []
+        request_timeout_seconds: 30

solace_agent_mesh/templates/plugin_custom_config_template.yaml

@@ -0,0 +1,27 @@
+# Plugin Metadata:
+# Name: __PLUGIN_KEBAB_CASE_NAME__
+# Version: __PLUGIN_VERSION__
+# Description: __PLUGIN_DESCRIPTION__
+# Author: __PLUGIN_AUTHOR_NAME__ <__PLUGIN_AUTHOR_EMAIL__>
+# 
+# --- Start of Custom Configuration Template ---
+# Solace Agent Mesh: Custom Configuration Template
+#
+# This file serves as a template for creating new custom configurations from this plugin.
+# Use placeholders like __COMPONENT_KEBAB_CASE_NAME__, __COMPONENT_PASCAL_CASE_NAME__,
+# and __COMPONENT_UPPER_SNAKE_CASE_NAME__ where the specific component name should be inserted.
+
+# To use the `shared_config.yaml` file, uncomment the following line and remove the `shared_config` section below.
+# !include ../shared_config.yaml
+
+shared_config:
+  - broker_connection: &broker_connection
+      dev_mode: ${SOLACE_DEV_MODE, false}
+      broker_url: ${SOLACE_BROKER_URL, ws://localhost:8008}
+      broker_username: ${SOLACE_BROKER_USERNAME, default}
+      broker_password: ${SOLACE_BROKER_PASSWORD, default}
+      broker_vpn: ${SOLACE_BROKER_VPN, default}
+      temporary_queue: ${USE_TEMPORARY_QUEUES, true}
+
+
+__PLUGIN_SNAKE_CASE_NAME__: {}

solace_agent_mesh/templates/plugin_custom_template.py

@@ -0,0 +1,10 @@
+# Solace Agent Mesh Custom Plugin
+
+class __COMPONENT_PASCAL_CASE_NAME__:
+    def template_function(self):
+        """
+        This function serves as a placeholder for custom template logic.
+        It can be modified to include specific functionality as needed.
+        """
+        # Custom logic goes here
+        print("This is a custom template function.")

solace_agent_mesh/templates/plugin_gateway_config_template.yaml

@@ -0,0 +1,60 @@
+# Plugin Metadata:
+# Name: __PLUGIN_KEBAB_CASE_NAME__
+# Version: __PLUGIN_VERSION__
+# Description: __PLUGIN_DESCRIPTION__
+# Author: __PLUGIN_AUTHOR_NAME__ <__PLUGIN_AUTHOR_EMAIL__>
+# 
+# --- Start of Gateway Configuration Template ---
+# Solace Agent Mesh: Gateway Configuration Template
+#
+# This file serves as a template for creating new gateway configurations from this plugin.
+# Use placeholders like __COMPONENT_KEBAB_CASE_NAME__, __COMPONENT_PASCAL_CASE_NAME__,
+# and __COMPONENT_UPPER_SNAKE_CASE_NAME__ where the specific component name should be inserted.
+
+log:
+  stdout_log_level: INFO
+  log_file_level: DEBUG
+  log_file: __COMPONENT_KEBAB_CASE_NAME__.log
+
+# To use the `shared_config.yaml` file, uncomment the following line and remove the `shared_config` section below.
+# !include ../shared_config.yaml
+
+shared_config:
+  - broker_connection: &broker_connection
+      dev_mode: ${SOLACE_DEV_MODE, false}
+      broker_url: ${SOLACE_BROKER_URL, ws://localhost:8008}
+      broker_username: ${SOLACE_BROKER_USERNAME, default}
+      broker_password: ${SOLACE_BROKER_PASSWORD, default}
+      broker_vpn: ${SOLACE_BROKER_VPN, default}
+      temporary_queue: ${USE_TEMPORARY_QUEUES, true}
+
+  - services:
+    # Default artifact service configuration
+    artifact_service: &default_artifact_service
+      type: "filesystem"
+      base_path: "/tmp/samv2"
+      artifact_scope: namespace # Or "namespace", "app", "custom"
+
+apps:
+  # --- App Definition ---
+  - name: __COMPONENT_PASCAL_CASE_NAME____app # Unique name for this gateway app instance
+    app_module: __PLUGIN_SNAKE_CASE_NAME__.app # Points to the plugin's App class
+    broker:
+      <<: *broker_connection
+
+    app_config:
+      namespace: "${NAMESPACE}" 
+      gateway_id: __COMPONENT_KEBAB_CASE_NAME__-gw-01
+      artifact_service: *default_artifact_service
+
+      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.

solace_agent_mesh/templates/plugin_pyproject_template.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.__PLUGIN_SNAKE_CASE_NAME__.metadata]
+type = "__PLUGIN_META_DATA_TYPE__"
+
+[project]
+name = "__PLUGIN_SNAKE_CASE_NAME__"
+version = "__PLUGIN_VERSION__"
+authors = [
+  { name="__PLUGIN_AUTHOR_NAME__", email="__PLUGIN_AUTHOR_EMAIL__" },
+]
+description = "__PLUGIN_DESCRIPTION__"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    # Add plugin-specific dependencies here
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/__PLUGIN_SNAKE_CASE_NAME__"]
+src-path = "src"
+
+[tool.hatch.build.targets.wheel.force-include]
+"src/__PLUGIN_SNAKE_CASE_NAME__" = "__PLUGIN_SNAKE_CASE_NAME__/"
+"config.yaml" = "__PLUGIN_SNAKE_CASE_NAME__/config.yaml"
+"README.md" = "__PLUGIN_SNAKE_CASE_NAME__/README.md"
+"pyproject.toml" = "__PLUGIN_SNAKE_CASE_NAME__/pyproject.toml"

solace_agent_mesh/templates/plugin_readme_template.md

@@ -0,0 +1,12 @@
+# __PLUGIN_PASCAL_CASE_NAME__ SAM Plugin
+
+__PLUGIN_DESCRIPTION__
+
+This is a plugin for Solace Agent Mesh (SAM).
+
+## Installation
+
+Once the plugin is installed (e.g., from PyPI or a local wheel file):
+```bash
+sam plugin add <your-new-component-name> --plugin __PLUGIN_KEBAB_CASE_NAME__
+```

solace_agent_mesh/templates/plugin_tool_config_template.yaml

@@ -0,0 +1,109 @@
+# Plugin Metadata:
+# Name: __PLUGIN_KEBAB_CASE_NAME__
+# Version: __PLUGIN_VERSION__
+# Description: __PLUGIN_DESCRIPTION__
+# Author: __PLUGIN_AUTHOR_NAME__ <__PLUGIN_AUTHOR_EMAIL__>
+# 
+# --- Start of Agent Configuration Template ---
+# Solace Agent Mesh: Plugin Configuration Template
+#
+# This file serves as a template for creating new agent configurations from this plugin.
+# Use placeholders like __COMPONENT_KEBAB_CASE_NAME__, __COMPONENT_PASCAL_CASE_NAME__,
+# and __COMPONENT_UPPER_SNAKE_CASE_NAME__ where the specific component name should be inserted.
+
+log:
+  stdout_log_level: INFO
+  log_file_level: DEBUG
+  log_file: __COMPONENT_KEBAB_CASE_NAME__.log
+
+# To use the `shared_config.yaml` file, uncomment the following line and remove the `shared_config` section below.
+# !include ../shared_config.yaml
+shared_config:
+  - broker_connection: &broker_connection
+      dev_mode: ${SOLACE_DEV_MODE, false}
+      broker_url: ${SOLACE_BROKER_URL, ws://localhost:8008}
+      broker_username: ${SOLACE_BROKER_USERNAME, default}
+      broker_password: ${SOLACE_BROKER_PASSWORD, default}
+      broker_vpn: ${SOLACE_BROKER_VPN, default}
+      temporary_queue: ${USE_TEMPORARY_QUEUES, true}
+
+  - models:
+    general: &general_model
+      # This dictionary structure tells ADK to use the LiteLlm wrapper.
+      # 'model' uses the specific model identifier your endpoint expects.
+      model: ${LLM_SERVICE_GENERAL_MODEL_NAME} # Use env var for model name
+      # 'api_base' tells LiteLLM where to send the request.
+      api_base: ${LLM_SERVICE_ENDPOINT} # Use env var for endpoint URL
+      # 'api_key' provides authentication.
+      api_key: ${LLM_SERVICE_API_KEY} # Use env var for API key
+
+  - services:
+    # Default session service configuration
+    session_service: &default_session_service
+      type: "memory"
+      default_behavior: "PERSISTENT"
+    
+    # Default artifact service configuration
+    artifact_service: &default_artifact_service
+      type: "filesystem"
+      base_path: "/tmp/samv2"
+      artifact_scope: namespace # Or "namespace", "app", "custom"
+
+apps:
+  - name: __COMPONENT_KEBAB_CASE_NAME__-app
+    app_base_path: . 
+    app_module: solace_agent_mesh.agent.sac.app 
+    broker:
+      <<: *broker_connection
+
+    # App Level Config
+    app_config:
+      namespace: ${NAMESPACE} 
+      supports_streaming: true 
+      agent_name: "__COMPONENT_PASCAL_CASE_NAME__" 
+      display_name: "__COMPONENT_SPACED_CAPITALIZED_NAME__ Agent"
+      model: *general_model 
+
+      instruction: |
+        You're __COMPONENT_SPACED_CAPITALIZED_NAME__ agent.
+        Configure its specific instructions here.
+
+      tools:
+        - group_name: artifact_management
+          tool_type: builtin-group
+
+        # --- Example Python Tools (defined in tools.py) ---
+        # - tool_type: python
+        #   component_module: __PLUGIN_SNAKE_CASE_NAME__.tools
+        #   component_base_path: . # Relative to where the agent runs
+        #   function_name: example_text_processor_tool
+        #   tool_config:
+        #     prefix: "PluginProcessed: "
+        
+        # - tool_type: python
+        #   component_module: __PLUGIN_SNAKE_CASE_NAME__.tools
+        #   component_base_path: .
+        #   function_name: example_file_creator_tool
+        #   tool_config: {} # Add specific config if needed by the tool
+
+      session_service: *default_session_service
+      artifact_service: *default_artifact_service
+
+      artifact_handling_mode: "reference"
+      enable_embed_resolution: true
+      enable_artifact_content_instruction: true
+
+      agent_card:
+        description: "__PLUGIN_DESCRIPTION__"
+        defaultInputModes: ["text"]
+        defaultOutputModes: ["text"]
+        skills: [] # Remove brackets after adding entries
+          # - id: "example_tool"
+          #   name: "Example Tool"
+          #   description: "An example tool provided by the __PLUGIN_PASCAL_CASE_NAME__ plugin."
+
+      agent_card_publishing: { interval_seconds: 10 }
+      agent_discovery: { enabled: false }
+      inter_agent_communication:
+        allow_list: []
+        request_timeout_seconds: 30