Skip to main content
Glama
followupboss-mcp-server

followupboss-mcp-server

updateAppointmentType

DestructiveIdempotent

Change an appointment type's name or sort order in Follow Up Boss CRM. Use it to rename types or reorder how they appear; requires account owner access.

Instructions

Update an appointment type (account owner only).

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": "updateAppointmentType"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesType ID
nameNoName
orderWeightNoSort position

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.0.0
    • addedInput schema / properties / orderWeight
      Added value: +{
      +  "description": "Sort position",
      +  "type": "number"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "id",
      -  "name"
      -]New value: +[
      +  "id"
      +]
  2. First observedv1.1.1

TDQS

B3.4/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=false, destructiveHint=true and idempotentHint=true, so the agent knows this mutates and can overwrite data. The description adds the owner-only authorization constraint, which structured data does not convey. It does not explain what makes the update destructive (e.g., whether omitted fields are cleared), leaving a meaningful gap given destructiveHint=true.

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

Conciseness4/5

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

A single short sentence with zero filler, and the permission constraint is placed immediately after the action. It is efficient but so terse that the brevity shades into under-specification rather than economy.

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

Completeness3/5

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

For a destructive, idempotent mutation the description covers the action and the auth prerequisite, and the schema fully documents parameters with no output schema to explain. It nonetheless omits update semantics (partial vs. full replacement) and the practical consequence of the destructive hint, which an agent would need to call this safely.

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 id, name, and orderWeight each documented in the schema itself. The description adds no meaning beyond those fields — notably it never clarifies that id is the sole required selector while the other two are optional changes.

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?

The description names a specific verb and resource ('Update an appointment type'), so the operation is unambiguous. It does not distinguish itself from sibling tools such as createAppointmentType, getAppointmentType, or updateAppointment, though the mutation verb plus resource makes the intent fairly obvious.

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

Usage Guidelines3/5

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

'(account owner only)' supplies a real prerequisite that tells the agent this call may fail for non-owner credentials. However, there is no guidance on when to use this versus createAppointmentType or updateAppointment, nor on whether the call is a full replacement or a partial update.

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