Skip to main content
Glama
followupboss-mcp-server

followupboss-mcp-server

updateAppointmentOutcome

DestructiveIdempotent

Update an appointment outcome for account owners by specifying the outcome ID, with optional name and sort position changes. Use it to correct or reorganize outcome details in Follow Up Boss.

Instructions

Update an appointment outcome (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": "updateAppointmentOutcome"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesOutcome 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?

Annotations already declare destructiveHint=true and idempotentHint=true, so the safety profile is covered structurally; the description adds the valuable auth constraint that only the account owner may call it. What is not disclosed is what makes the update destructive - whether overwriting an outcome affects appointments already referencing it - which is the main behavioral question an agent would have.

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 front-loaded sentence with zero filler, and the permission qualifier is placed immediately after the action rather than buried. It is efficient, though its brevity borders on under-specification for a destructive mutation.

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?

With a fully documented three-parameter schema and annotations carrying the destructive/idempotent profile, the description covers the essentials. It is still thin for a destructive write: nothing explains the effect on related appointments or what a partial update (only id plus name) does.

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 all documented in the schema, so the baseline of 3 applies. The description adds no meaning about which fields are optional or what happens if only id is supplied, so it neither compensates nor detracts.

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?

"Update an appointment outcome" gives a specific verb and a resource that is clearly distinct from the sibling updateAppointment, and the read-only siblings (getAppointmentOutcome, listAppointmentOutcomes, createAppointmentOutcome) are implicitly disambiguated by the verb. It falls short of 5 only because it doesn't explicitly contrast with updateAppointment, whose name is close enough to invite confusion.

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?

The parenthetical "(account owner only)" is a real usage constraint and prerequisite, which is more than most definitions offer. However, there is no guidance on when to choose this over updateAppointment or the create/get outcome siblings, so usage is implied rather than stated.

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