List agent labels

veryfront__list_agent_labels

Requires project.agents.read.

Access

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

Call type: Read-only.

Arguments

FieldTypeRequiredDescription and constraints
agent_idstringYesProvide the agent id. Minimum length: 1.
source_target_kindstring or nullNoSource target: project, main_branch, or preview_branch. Null and omission select project.
target_branch_idstring or nullNoProvide the target branch id.
project_referencestringNoProject identifier or slug that scopes the tool call. Minimum length: 1.

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.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__list_agent_labels",
    "arguments": {
      "agent_id": "example"
    }
  }
}

Result

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

FieldTypeRequiredDescription and constraints
labelsobject[]YesList of labels returned by the tool.

Full schemas

json
{
  "type": "object",
  "properties": {
    "agent_id": {
      "type": "string",
      "minLength": 1,
      "description": "Provide the agent id."
    },
    "source_target_kind": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "project",
            "main_branch",
            "preview_branch"
          ],
          "description": "Provide the source target kind."
        },
        {
          "type": "null",
          "description": "Provide the source target kind."
        }
      ],
      "description": "Source target: project, main_branch, or preview_branch. Null and omission select project."
    },
    "target_branch_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Provide the target branch id."
        },
        {
          "type": "null",
          "description": "Provide the target branch id."
        }
      ],
      "description": "Provide the target branch id."
    },
    "project_reference": {
      "type": "string",
      "minLength": 1,
      "description": "Project identifier or slug that scopes the tool call."
    }
  },
  "required": [
    "agent_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the list_agent_labels tool."
}
json
{
  "type": "object",
  "properties": {
    "labels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Label UUID."
          },
          "resource_kind": {
            "type": "string",
            "enum": [
              "project",
              "project_agent"
            ],
            "description": "Resource to which the label is assigned."
          },
          "project_id": {
            "type": "string",
            "format": "uuid",
            "description": "Project UUID containing the labeled resource."
          },
          "source_target_kind": {
            "type": [
              "string",
              "null"
            ],
            "description": "The source target kind returned by the tool."
          },
          "source_agent_id": {
            "type": [
              "string",
              "null"
            ],
            "description": "The source agent id returned by the tool."
          },
          "namespace": {
            "type": "string",
            "description": "Normalized label namespace. API-created labels use user."
          },
          "key": {
            "type": "string",
            "description": "Normalized lowercase label key."
          },
          "value": {
            "type": [
              "string",
              "null"
            ],
            "description": "Trimmed label value, or null for a key-only label."
          },
          "color": {
            "type": [
              "string",
              "null"
            ],
            "description": "Trimmed display color, or null when unset."
          },
          "created_at": {
            "type": "string",
            "description": "Creation time as an ISO 8601 timestamp."
          },
          "updated_at": {
            "type": "string",
            "description": "Last update time as an ISO 8601 timestamp."
          }
        },
        "required": [
          "id",
          "resource_kind",
          "project_id",
          "namespace",
          "key",
          "value",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false,
        "description": "One label item returned by the tool."
      },
      "description": "List of labels returned by the tool."
    }
  },
  "required": [
    "labels"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Structured result returned by the list_agent_labels tool."
}