Skip to main content
Glama
followupboss-mcp-server

followupboss-mcp-server

listDealCustomFields

Read-onlyIdempotent

Retrieve and paginate deal custom fields from Follow Up Boss, with options to filter by label and sort by ID, name, or order weight.

Instructions

List deal custom fields. Paginated: FUB returns 10 per page unless limit is set; pass limit=100 to get more in one call.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

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

Input Schema

NameRequiredDescriptionDefault
nextNoCursor from _metadata.next of the previous call for the next page.
sortNoSort field; prefix with - for descending. FUB default is id descending.
labelNoFind the custom field by label.
limitNoResults per call, max 100. Not set by server; FUB default is 10 when omitted.
offsetNoRows to skip before returning results.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv2.0.0
    • addedInput schema / properties / label
      Added value: +{
      +  "description": "Find the custom field by label.",
      +  "type": "string"
      +}
    • changedInput schema / properties / limit / description
      Previous value: -"Results per page (FUB default 10, max 100)"New value: +"Results per call, max 100. Not set by server; FUB default is 10 when omitted."
    • changedInput schema / properties / limit / type
      Previous value: -"number"New value: +"integer"
    • addedInput schema / properties / next
      Added value: +{
      +  "description": "Cursor from _metadata.next of the previous call for the next page.",
      +  "type": "string"
      +}
    • changedInput schema / properties / offset / description
      Previous value: -"Pagination offset"New value: +"Rows to skip before returning results."
    • changedInput schema / properties / offset / type
      Previous value: -"number"New value: +"integer"
    • addedInput schema / properties / sort
      Added value: +{
      +  "description": "Sort field; prefix with - for descending. FUB default is id descending.",
      +  "enum": [
      +    "id",
      +    "name",
      +    "orderWeight"
      +  ],
      +  "type": "string"
      +}
  2. Changed2 schema fields changedv1.5.1
    • addedInput schema / properties / limit
      Added value: +{
      +  "description": "Results per page (FUB default 10, max 100)",
      +  "type": "number"
      +}
    • addedInput schema / properties / offset
      Added value: +{
      +  "description": "Pagination offset",
      +  "type": "number"
      +}
  3. First observedv1.1.1

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so safety is covered. The description goes beyond that by disclosing a concrete pagination behavior that annotations cannot express: FUB returns 10 records per page unless a limit is supplied. It does not describe the shape of returned items, but that is a modest gap for a pure list tool.

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, purpose first and the operational caveat second, with no filler or repetition. Every clause carries information an agent can act on.

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?

The tool is simple, annotations cover the safety profile fully, and the schema documents every parameter, so the description only needs to add operational nuance, which it does via pagination. The one missing piece is scoping versus listCustomFields and listDeals, which would matter for correct tool selection.

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 coverage is 100%, and the schema already documents limit's default of 10 and max of 100, so the description's pagination sentence largely restates structured data. It adds a little practical framing ("pass limit=100 to get more in one call") but says nothing about next, offset, sort, or label beyond what the schema provides.

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 ("List deal custom fields"), which is clearly distinct from the sibling mutation tools like createDealCustomField and updateDealCustomField. It stops short of distinguishing itself from the adjacent listCustomFields tool, so an agent must infer whether the difference is deal-scoped fields versus person-scoped fields.

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: the pagination sentence hints that you should set limit=100 when you want more than the default page. There is no explicit when-to-use/when-not guidance and no named alternative such as listCustomFields or listDeals, which is a real ambiguity given the sibling set.

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