Skip to main content
Glama
followupboss-mcp-server

followupboss-mcp-server

listCustomFields

Read-onlyIdempotent

Retrieve custom fields from Follow Up Boss CRM to identify available contact and deal data fields. Filter by label, sort, and paginate results as needed.

Instructions

List custom fields. Use limit=100 to get all 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": "listCustomFields"
  }
}

Input Schema

NameRequiredDescriptionDefault
sortNoSort field; '-' prefix = descending. Default -id
labelNoFind a custom field by its label
limitNoResults to return. FUB default 10, max 100.
offsetNoRows to skip before results begin. Default 0.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv2.0.0
    • addedInput schema / properties / label
      Added value: +{
      +  "description": "Find a custom field by its label",
      +  "type": "string"
      +}
    • changedInput schema / properties / limit / description
      Previous value: -"Results per page (FUB default 10, max 100)"New value: +"Results to return. FUB default 10, max 100."
    • changedInput schema / properties / offset / description
      Previous value: -"Pagination offset"New value: +"Rows to skip before results begin. Default 0."
    • addedInput schema / properties / sort
      Added value: +{
      +  "description": "Sort field; '-' prefix = descending. Default -id",
      +  "enum": [
      +    "id",
      +    "name",
      +    "orderWeight",
      +    "-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

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds one useful behavioral note — that limit=100 returns everything in a single call — but says nothing about scoping (account-wide vs. per-user) or what a returned field record looks like.

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?

Two short sentences, front-loaded with the core purpose and followed by an actionable tip; nothing is padded. A small deduction because the limit advice could have been folded into a sentence that also clarifies scope.

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 simple, fully optional four-parameter list tool with no output schema, the description is adequate but thin. It leaves open whether custom fields are account-global or entity-scoped — a distinction that matters given the sibling listDealCustomFields.

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%, so sort, label, limit, and offset are all documented in the schema itself. The description reinforces limit with a concrete recommended value, which is mildly useful but adds no meaning to sort, label, or offset beyond what the schema states.

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?

"List custom fields" gives a specific verb plus resource, so an agent immediately knows this is a read/list operation over the custom-fields collection. It does not distinguish itself from the sibling listDealCustomFields, so it falls short of a 5.

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

Usage Guidelines2/5

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

The description offers no when-to-use guidance and never mentions the alternative listDealCustomFields, which an agent could easily confuse with this tool. The only guidance present is a parameter tip (limit=100), not a usage condition.

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