> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List agents a runtime target can use

> List runtime target agents.

`veryfront__list_channel_agents`

Requires project.channels.read.

## Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

**Call type:** Read-only.

## Arguments

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `project_reference` | `string` | No | Project ID or slug |
| `runtime_target_kind` | `string` | No | Runtime target: `main_branch`, environment or `preview_branch` Values: `"main_branch"`, `"environment"`, `"preview_branch"`. |
| `target_environment_id` | `string or null` | No | Environment ID; required when `runtime_target_kind` is environment |
| `target_branch_id` | `string or null` | No | Branch ID; required when `runtime_target_kind` is `preview_branch` |

## Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See [MCP client setup](/docs/cloud/getting-started/connect-mcp.md).

```json title="request.json" theme={null}
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__list_channel_agents",
    "arguments": {}
  }
}
```

## Result

The published output shape is summarized below. Inspect both the MCP response content and `isError` when handling a call.

| Field | Type | Required | Description and constraints |
| - | - | - | - |
| `data` | `object[]` | Yes | All agents available for the selected runtime target, sorted by name then ID. This complete list is not paginated. |

## Full schemas

```json title="input-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "runtime_target_kind": {
      "type": "string",
      "enum": [
        "main_branch",
        "environment",
        "preview_branch"
      ],
      "description": "Runtime target: main_branch, environment or preview_branch"
    },
    "target_environment_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Provide the target environment id."
        },
        {
          "type": "null",
          "description": "Provide the target environment id."
        }
      ],
      "description": "Environment ID; required when runtime_target_kind is environment"
    },
    "target_branch_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Provide the target branch id."
        },
        {
          "type": "null",
          "description": "Provide the target branch id."
        }
      ],
      "description": "Branch ID; required when runtime_target_kind is preview_branch"
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the list_channel_agents tool."
}
```

```json title="output-schema.json" theme={null}
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the returned record."
          },
          "name": {
            "type": "string",
            "description": "Human-readable name for the returned record."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "Human-readable description returned by the tool."
          },
          "model": {
            "type": [
              "string",
              "null"
            ],
            "description": "AI model id associated with this tool result."
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "model"
        ],
        "additionalProperties": false,
        "description": "One data item returned by the tool."
      },
      "description": "All agents available for the selected runtime target, sorted by name then ID. This complete list is not paginated."
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Structured result returned by the list_channel_agents tool."
}
```

<details>
  <summary>Try this tool</summary>

  Replace sample arguments with values for your project or connected account. Calls run only when you select Run tool.

  MCP tool call

  Call `veryfront__list_channel_agents` against the Veryfront MCP endpoint.

  Bearer token or API key

  Arguments (JSON)

  Run tool

  Output JSON

  <pre />
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.