List Available Agents

Query all agents accessible to the current user. Returns each agent's code (agentId), name, description and type.

Core Capabilities

• Get all available agents for the user (including built-in, custom, and public)
• Support fuzzy filtering by name
• The returned code field is the agentId, usable directly in createTopicAndSend and similar APIs

Quick Start

Typical Workflow

1. Query all agents (list.py)
   ↓ Get code / name / type
2. Use code directly as agentId in code generation

Available Scripts

list.py - List Agents

Query all agents available to the current user.

SYNOPSIS

python scripts/list.py [OPTIONS]

OPTIONS

OUTPUT

On success, returns JSON:

{
  "total": 5,
  "agents": [
    {
      "code": "SMA-xxxx",
      "name": "Data Analyst",
      "description": "Professional data analysis assistant",
      "type": "custom"
    }
  ]
}

• code is the agentId, pass directly to window.Magic.project.createTopicAndSend(msg, {agentId: code})
• type values: official (built-in), custom (user-created), public (team/public shared)

EXAMPLES

# 查询全部员工
python scripts/list.py

# 按名称过滤
python scripts/list.py --name-filter "数据分析"

# 按类型过滤
python scripts/list.py --type-filter custom

Use Cases

1. Get real agentId for micro-app code generation

Before generating micro-app code that dispatches tasks to agents, run the script to get the agent list, then use the real code in generated code:

python scripts/list.py --name-filter "researcher"

Use the returned code directly:

const { topicId } = await window.Magic.project.createTopicAndSend(
  message,
  { agentId: "SMA-xxxx" }  // real code from list.py
);

2. User asks about available agents

When user asks "what agents do I have" or "show me available agents", run the script to get the full list.