Skip to main content
Glama
followupboss-mcp-server

followupboss-mcp-server

listUsers

Read-onlyIdempotent

Retrieve users such as agents, brokers, and lenders, then filter by role, exact full name, or email to find the right CRM person.

Instructions

List users (agents, brokers, lenders). Filter by role, exact name, or email.

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

Input Schema

NameRequiredDescriptionDefault
idNoComma-separated user IDs
nameNoExact full name (no partial match).
nextNoCursor from _metadata.next of the previous page.
roleNoUser role.
sortNoSort field.
emailNoEmail address.
limitNoResults per call. Default 10, max 100.
fieldsNoComma-separated fields, or allFields. Add 'calling' for calling info (allFields,calling).
offsetNoRows to skip. Default 0. Prefer next for deep paging.
includeDeletedNoInclude deleted users. Default false.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed12 schema fields changedv2.0.0
    • addedInput schema / properties / email
      Added value: +{
      +  "description": "Email address.",
      +  "type": "string"
      +}
    • changedInput schema / properties / fields / description
      Previous value: -"Comma-separated list of fields to return"New value: +"Comma-separated fields, or allFields. Add 'calling' for calling info (allFields,calling)."
    • addedInput schema / properties / includeDeleted
      Added value: +{
      +  "description": "Include deleted users. Default false.",
      +  "type": "boolean"
      +}
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of results to return"New value: +"Results per call. Default 10, max 100."
    • changedInput schema / properties / limit / type
      Previous value: -"number"New value: +"integer"
    • addedInput schema / properties / name
      Added value: +{
      +  "description": "Exact full name (no partial match).",
      +  "type": "string"
      +}
    • changedInput schema / properties / next / description
      Previous value: -"Cursor for next page of results"New value: +"Cursor from _metadata.next of the previous page."
    • changedInput schema / properties / offset / description
      Previous value: -"Offset for pagination"New value: +"Rows to skip. Default 0. Prefer next for deep paging."
    • changedInput schema / properties / offset / type
      Previous value: -"number"New value: +"integer"
    • addedInput schema / properties / role
      Added value: +{
      +  "description": "User role.",
      +  "enum": [
      +    "Broker",
      +    "Agent",
      +    "Lender"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / sort / description
      Previous value: -"Sort order"New value: +"Sort field."
    • addedInput schema / properties / sort / enum
      Added value: +[
      +  "id",
      +  "name",
      +  "created"
      +]
  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 readOnlyHint=true, idempotentHint=true, destructiveHint=false and a closed world, so the safety profile is covered. The description adds only that results can be narrowed by role/name/email; it says nothing about default page size, pagination via cursor, or the fact that deleted users are excluded by default unless includeDeleted is set, which are the behaviors an agent most needs to know.

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 operation and immediately followed by the filterable dimensions. Little waste, though the filter list largely restates schema enum/parameter names rather than adding new information.

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 10-parameter, no-output-schema list tool, the definition covers purpose and filters but leaves pagination behavior, default limits, and deleted-record handling unmentioned (they exist only in the schema). Adequate but not complete for the tool's surface area.

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%, so every one of the 10 parameters is already documented, including the notable 'exact full name (no partial match)' and 'prefer next for deep paging' constraints. The description adds no meaning beyond the schema; the baseline 3 applies.

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?

Uses a specific verb+resource ('List users') and disambiguates the ambiguous term 'users' by naming the actual entity types (agents, brokers, lenders). It does not, however, distinguish itself from the sibling getUser or from listPeople, so an agent must still infer which list/get to pick.

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 filtering sentence implies the retrieval use case (browse/filter the user directory), but there is no explicit when-to-use versus getUser or listPeople, and no statement that no results occur when filters are combined restrictively. Usage is inferable but not guided.

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