Skip to main content
Glama
followupboss-mcp-server

followupboss-mcp-server

updateRelationship

DestructiveIdempotent

Update a relationship contact's type, name, emails, phones, or addresses in Follow Up Boss; email, phone, and address arrays overwrite existing values.

Instructions

Update a relationship contact. emails/phones/addresses arrays OVERWRITE existing values (empty array = unchanged). personId cannot be changed.

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

Input Schema

NameRequiredDescriptionDefault
idYesRelationship ID.
typeNoRelationship type, e.g. Spouse.
emailsNoEmails. First entry becomes primary. Each needs value.
phonesNoPhones. First entry becomes primary. Each needs value.
lastNameNoLast name.
addressesNoContact addresses (not property addresses).
firstNameNoFirst name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed14 schema fields changedv2.0.0
    • addedInput schema / properties / addresses / description
      Added value: +"Contact addresses (not property addresses)."
    • addedInput schema / properties / addresses / items / properties
      Added value: +{
      +  "city": {
      +    "description": "City",
      +    "type": "string"
      +  },
      +  "code": {
      +    "description": "ZIP code as string",
      +    "type": "string"
      +  },
      +  "country": {
      +    "description": "Country name",
      +    "type": "string"
      +  },
      +  "state": {
      +    "description": "2-letter state code",
      +    "type": "string"
      +  },
      +  "street": {
      +    "description": "Street",
      +    "type": "string"
      +  },
      +  "type": {
      +    "description": "home (default), work, mailing, investment",
      +    "type": "string"
      +  }
      +}
    • addedInput schema / properties / addresses / items / required
      Added value: +[]
    • addedInput schema / properties / emails / description
      Added value: +"Emails. First entry becomes primary. Each needs value."
    • addedInput schema / properties / emails / items / properties
      Added value: +{
      +  "isPrimary": {
      +    "description": "Not needed; first entry is primary",
      +    "type": "boolean"
      +  },
      +  "type": {
      +    "description": "e.g. work, home",
      +    "type": "string"
      +  },
      +  "value": {
      +    "description": "Email address",
      +    "type": "string"
      +  }
      +}
    • addedInput schema / properties / emails / items / required
      Added value: +[
      +  "value"
      +]
    • addedInput schema / properties / firstName / description
      Added value: +"First name."
    • changedInput schema / properties / id / description
      Previous value: -"Relationship ID"New value: +"Relationship ID."
    • changedInput schema / properties / id / type
      Previous value: -"number"New value: +"integer"
    • addedInput schema / properties / lastName / description
      Added value: +"Last name."
    • addedInput schema / properties / phones / description
      Added value: +"Phones. First entry becomes primary. Each needs value."
    • addedInput schema / properties / phones / items / properties
      Added value: +{
      +  "isPrimary": {
      +    "description": "Not needed; first entry is primary",
      +    "type": "boolean"
      +  },
      +  "type": {
      +    "description": "e.g. mobile, home, fax",
      +    "type": "string"
      +  },
      +  "value": {
      +    "description": "Phone number, e.g. 888-555-1234",
      +    "type": "string"
      +  }
      +}
    • addedInput schema / properties / phones / items / required
      Added value: +[
      +  "value"
      +]
    • changedInput schema / properties / type / description
      Previous value: -"Relationship type (e.g. Spouse)"New value: +"Relationship type, e.g. Spouse."
  2. Changed8 schema fields changedv1.1.3
    • addedInput schema / properties / addresses
      Added value: +{
      +  "items": {
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / emails
      Added value: +{
      +  "items": {
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / firstName
      Added value: +{
      +  "type": "string"
      +}
    • addedInput schema / properties / lastName
      Added value: +{
      +  "type": "string"
      +}
    • removedInput schema / properties / notes
      Removed value: -{
      -  "description": "Notes",
      -  "type": "string"
      -}
    • addedInput schema / properties / phones
      Added value: +{
      +  "items": {
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • removedInput schema / properties / relationshipType
      Removed value: -{
      -  "description": "Type of relationship",
      -  "type": "string"
      -}
    • addedInput schema / properties / type
      Added value: +{
      +  "description": "Relationship type (e.g. Spouse)",
      +  "type": "string"
      +}
  3. First observedv1.1.1

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, and the description earns credit by adding semantics the annotations cannot convey: the emails/phones/addresses arrays are full replacements, an empty array is a no-op, and personId is immutable. It stops short of saying whether omitted scalar fields (firstName, lastName, type) are preserved or cleared, which matters a lot for a destructive update.

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, front-loaded with the purpose and immediately followed by the riskiest behavioral caveats. Nothing is padding and the overwrite warning is capitalized for emphasis.

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?

For a 7-parameter mutation tool with no output schema, the description covers the destructive array-replacement behavior and the immutable field, which is the critical information. The remaining gap is patch-vs-replace semantics for scalar fields and the response shape, which the agent must infer.

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

Parameters4/5

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

Schema description coverage is 100%, so the baseline is 3, but the description adds real meaning beyond the schema by defining overwrite behavior for the three array parameters and the immutability of personId. Those are the two highest-risk semantics and they are stated outright.

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 opens with a specific verb+resource ('Update a relationship contact'), so the agent knows exactly what is mutated. It is distinguishable from createRelationship/getRelationship by the verb alone, but it never names those siblings explicitly.

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?

Usage is only implied: it is obviously the edit path once a relationship exists. There is no statement of prerequisites (does `id` have to come from getRelationship?), nor any explicit routing away from createRelationship when the contact does not yet exist.

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