Skip to main content
Glama
followupboss-mcp-server

followupboss-mcp-server

updateCustomField

DestructiveIdempotent

Modify an existing Follow Up Boss custom field's label, dropdown choices, visibility, recurrence, or sort order. Field type cannot be changed; delete and recreate to change it.

Instructions

Update a custom field (account owners only). The type cannot be changed; delete and recreate instead.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>"
    },
    "name": "updateCustomField"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesCustom field ID
labelNoUser-facing field name
choicesNoOptions for a dropdown field
hideIfEmptyNoHide on the person view when empty
isRecurringNoDate fields only: recurs yearly
orderWeightNoSort weight

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv2.0.0
    • addedInput schema / properties / choices
      Added value: +{
      +  "description": "Options for a dropdown field",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / hideIfEmpty
      Added value: +{
      +  "description": "Hide on the person view when empty",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / isRecurring
      Added value: +{
      +  "description": "Date fields only: recurs yearly",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / label
      Added value: +{
      +  "description": "User-facing field name",
      +  "type": "string"
      +}
    • removedInput schema / properties / name
      Removed value: -{
      -  "description": "Name",
      -  "type": "string"
      -}
    • removedInput schema / properties / options
      Removed value: -{
      -  "description": "Options",
      -  "items": {
      -    "type": "string"
      -  },
      -  "type": "array"
      -}
    • addedInput schema / properties / orderWeight
      Added value: +{
      +  "description": "Sort weight",
      +  "type": "number"
      +}
    • removedInput schema / properties / type
      Removed value: -{
      -  "description": "Type",
      -  "type": "string"
      -}
  2. First observedv1.1.1

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true, idempotentHint=true and readOnlyHint=false, so the safety profile is covered. The description adds meaningful context beyond that: an authorization requirement and an immutability rule that changes how an agent must plan the operation. It never explains what the destructive aspect actually destroys (e.g. whether existing choices are replaced), which is the remaining gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences with zero filler, and the authorization constraint plus the key immutability rule are front-loaded before any operational detail.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With full schema coverage and annotations carrying the destructive/idempotent profile, the description covers what an agent minimally needs: who may call it and what cannot change. It leaves open the replace-vs-merge semantics of choices on update and has no output schema to fall back on for return expectations.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with each of the six parameters already documented including the type-specific notes on choices and isRecurring. The description adds no parameter-level meaning beyond the schema, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Update a custom field") that clearly separates it from createCustomField and getCustomField in the sibling list. It does not explicitly distinguish itself from the parallel updateDealCustomField, but the resource scope is unambiguous enough to act on.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides a concrete prerequisite ("account owners only") and an explicit when-not with an alternative action: the field type cannot be changed, so an agent must delete and recreate instead. It stops short of routing between this and sibling update tools, but the constraint that most affects invocation is spelled out.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools