swarms/docs/swarms_cloud/add_agent.md

Publishing an Agent to Agent Marketplace

Requirements

• swarms-cloud package with pip3 install -U swarms-cloud

• Onboarding Process with swarms-cloud onboarding

• A Dockerfile Dockerfile containing the API of your agent code with FastAPI

• A YAML file for configuration agent.yaml

Deployment YAML

# Agent metadata and description
agent_name: "example-agent"  # The name of the agent
description: "This agent performs financial data analysis."  # A brief description of the agent's purpose
version: "v1.0"  # The version number of the agent
author: "Agent Creator Name"  # The name of the person or entity that created the agent
contact_email: "creator@example.com"  # The email address for contacting the agent's creator
tags:
  - "financial"  # Tag indicating the agent is related to finance
  - "data-analysis"  # Tag indicating the agent performs data analysis
  - "agent"  # Tag indicating this is an agent


# Deployment configuration
deployment_config:
  # Dockerfile configuration
  dockerfile_path: "./Dockerfile"  # The path to the Dockerfile for building the agent's image
  dockerfile_port: 8080  # The port number the agent will listen on
  
  # Resource allocation for the agent
  resources:
    cpu: 2  # Number of CPUs allocated to the agent
    memory: "2Gi"  # Memory allocation for the agent in gigabytes
    max_instances: 5  # Maximum number of instances to scale up to
    min_instances: 1  # Minimum number of instances to keep running
    timeout: 300s  # Request timeout setting in seconds

  # Autoscaling configuration
  autoscaling:
    max_concurrency: 80  # Maximum number of requests the agent can handle concurrently
    target_utilization: 0.6  # CPU utilization target for auto-scaling

  # Environment variables for the agent
  environment_variables:
    DATABASE_URL: "postgres://user:password@db-url"  # URL for the database connection
    API_KEY: "your-secret-api-key"  # API key for authentication
    LOG_LEVEL: "info"  # Log level for the agent

  # Secrets configuration
  secrets:
    SECRET_NAME_1: "projects/my-project/secrets/my-secret/versions/latest"  # Path to a secret