list-agents

List the agents in this project — the same set the console's Agents page shows, one row per agent. Multi-agent process flows are excluded (list them with get-process-flow). Each row's agent_id is accepted unchanged by get-agent, update-agent, delete-agent and run-agent. 'page' is 1-based.

What it is called on each surface

The wire name is list-agents everywhere: it is what the Wexa MCP server advertises, the REST path is POST /v1/list-agents, and each SDK exposes it under its own language's naming convention.

Arguments

Every argument is optional: list-agents answers a bare call.

project_id, projectID, organization_id and executed_by are not arguments you pass: the platform binds all four from the credential you authenticated with, and both SDKs refuse them before the request leaves your process — see server-bound arguments.

What it returns

The three surfaces wrap this differently, and code written against one will not read another correctly — see return shape.

A real response, captured from a live call to list-agents:

{
  "content": [
    {
      "type": "text",
      "text": "{\"lifecycle_id\":\"qlc_000174\",\"result\":{\"agents\":[{\"agent_id\":\"6ab1945e7566f41b5c28e303.6ab1945e83ff5845d7db96bc\",\"description\":\"A stable agent the documentation cites.\",\"is_promoted\":false,\"model\":\"system_model\",\"name\":\"docs-fixture-agent\",\"role\":\"tester\"}],\"limit\":5,\"page\":1}}"
    }
  ],
  "isError": false
}

{
  "lifecycle_id": "qlc_000174",
  "result": {
    "agents": [
      {
        "agent_id": "6ab1945e7566f41b5c28e303.6ab1945e83ff5845d7db96bc",
        "description": "A stable agent the documentation cites.",
        "is_promoted": false,
        "model": "system_model",
        "name": "docs-fixture-agent",
        "role": "tester"
      }
    ],
    "limit": 5,
    "page": 1
  }
}

// the object you get back IS the result — there is no `.result` to read
{
  agents: [
    {
      agent_id: '6ab1945e7566f41b5c28e303.6ab1945e83ff5845d7db96bc',
      description: 'A stable agent the documentation cites.',
      is_promoted: false,
      model: 'system_model',
      name: 'docs-fixture-agent',
      role: 'tester'
    }
  ],
  limit: 5,
  page: 1
}

// The TS SDK names these camelCase — lifecycleId, traceId — where Python uses
// lifecycle_id and trace_id. Both are non-enumerable: readable, but omitted by
// Object.keys() and JSON.stringify(). `result.lifecycleId` here is undefined.
result.lifecycleId // 'qlc_000174'

# a dict subclass; `result` is already unwrapped
{
 "agents": [
  {
   "agent_id": "6ab1945e7566f41b5c28e303.6ab1945e83ff5845d7db96bc",
   "description": "A stable agent the documentation cites.",
   "is_promoted": False,
   "model": "system_model",
   "name": "docs-fixture-agent",
   "role": "tester"
  }
 ],
 "limit": 5,
 "page": 1
}

out.lifecycle_id  # 'qlc_000174' — an attribute, not a key

Keeping the lifecycle_id is what lets you ask later why a call was allowed, refused or held.

Calling it

The same call on all four surfaces. Pick a tab once and every code block in the documentation follows it.

The ids in this example are real: they resolve against the project the documentation is written against, so the call runs as written once you point it at your own deployment. Swap them for the ids of your own objects.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list-agents",
    "arguments": {
      "limit": 10
    }
  }
}

curl -sS https://fabric.wexa.ai/v1/list-agents \
  -H "authorization: Bearer $FABRIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"limit":10}'

import { Fabric } from '@wexa-fabric/sdk'

const fabric = new Fabric()
const { result } = await fabric.listAgents({
  limit: 10
})

from wexa import Fabric

fabric = Fabric()
out = fabric.list_agents(limit=10)

Errors

Both SDKs raise the same typed errors, chosen from the gateway's own error string first and its HTTP status second. list-agents checks the fabric:orchestrate.read grant, and reaches the seven classes every tool reaches — listed under the common set. These are the ones specific to it:

Governance

Every call to list-agents runs through the same ten-stage lifecycle as every other Wexa tool: the credential is resolved to a scope, the fabric:orchestrate.read grant is checked, quota is drawn down, the arguments are validated, policy rules are evaluated, the call is executed, the result is shaped and redacted, and an audit record is written. The lifecycle_id in the response is the handle to that record.

list-agents only reads, so it is not marked consequential: it is audited lightly and is never held for approval. It still consumes quota and is still refused by policy like anything else.

See also

The tool index, errors, and which identifier goes where.