Adiciona um CAMPO custom a um objeto (sem migração; registros antigos ficam sem a key). Tipos: string text integer float boolean date datetime singleselect multiselect email phone url currency relation user_ref json group.
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | ||
| type | Yes | ||
| label | No | ||
| object | Yes | ||
| unique | No | ||
| account | No | ||
| indexed | No | ||
| options | No | ||
| relation | No | ||
| required | No |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
As anotações já indicam readOnlyHint=false e destructiveHint=false, mas a descrição além disso revela o side-effect de que registros antigos não receberão a nova key, e enumera os tipos permitidos. Isso agrega contexto comportamental para além das anotações.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A descrição é curta, começa com a ação principal e traz exatamente as informações centrais: propósito, a ressalva de migração e os tipos disponíveis. Não contém palavras desnecessárias nem repetições.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Para uma ferramenta sem output schema e com 10 parâmetros, a descrição apenas cobre o comportamento principal e tipos. Faltam detalhes sobre vazio de parametros opcionais, relação com objetos e possíveis validações ou erros, o que impede a descrição de ser plenamente completa.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
A cobertura de params no schema é 0%, mas a descrição compensa parcialmente ao listar os tipos válidos do campo `type` e ao evidenciar `key` e `object` no texto. Parâmetros opcionais como `unique`, `indexed`, `required`, `options`, `relation` e `account` não são explicados na descrição.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
A descrição define claramente o propósito: 'Adiciona um CAMPO custom a um objeto', com verbo específico e recurso, diferenciando de ferramentas irmãs como crm_remove_field, crm_update_field e crm_define_object. A frase sobre migração também adiciona especificidade.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
A descrição deixa claro em que contexto usar (adicionar um campo custom) e expressa uma condição importante: 'sem migração; registros antigos ficam sem a key'. Porém, não cita explicitamente alternativas como crm_update_field ou crm_remove_field, então não chega a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.