MCPFerramentas MCP/Campos personalizados/list_custom_field_definitions
list_custom_field_definitions
Readcustom-fields:read
List the agency's custom-field schema for locations or clients — the extra fields an agency has defined beyond the built-in profile fields (e.g. "Franchise ID", "Contract renewal date"). Use this before get_custom_field_values or set_custom_field_value to discover what keys/types exist. Each definition has an id, an immutable key (used with set_custom_field_value), a label, a type (text/number/date/single_select/multi_select), whether it's required, its select options (for select types), and its display order. Archived definitions are excluded. You don't pass an agency — it comes from your credentials.
Parâmetros
entityType"location" | "client"obrigatório
Which entity's custom fields to list (required).
Exemplo de solicitação
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "list_custom_field_definitions",
"arguments": {
"entityType": "location"
}
}
}Exemplo de resposta
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"content": [
{
"type": "text",
"text": "..."
}
]
}
}O formato da resposta é ilustrativo — o conteúdo real depende da ferramenta e dos seus dados.