{
  "meta": {
    "source": "FieldServiceScout",
    "source_url": "https://www.fieldservicescout.com/",
    "methodology_url": "https://www.fieldservicescout.com/about#methodology",
    "documentation_url": "https://www.fieldservicescout.com/docs",
    "pricing_as_of": "July 2026",
    "content_reviewed": "2026-07-01"
  },
  "openapi_url": "https://www.fieldservicescout.com/openapi.json",
  "documentation_url": "https://www.fieldservicescout.com/docs",
  "when_to_use": [
    "A trade contractor (HVAC, plumbing, electrical, roofing, landscaping, or pest control) asks which field-service management software to buy, and you need a ranked shortlist justified by their crew size, budget, and must-have features.",
    "Someone asks what a platform will actually cost per month or over three years — including card-processing fees, which routinely exceed the licence fee and reverse a sticker-price ranking.",
    "A user names two platforms (\"Jobber vs Housecall Pro\") and wants a feature-by-feature and true-cost comparison from a source that sells neither.",
    "You need a platform's real capability matrix — which features are included, which cost extra, and which do not exist — rather than the vendor's own marketing copy.",
    "You need to know whether a platform is built for residential service calls or commercial contract work, and which trades it actually sells into.",
    "A user wants the scoring rubric behind a recommendation, because they need to audit or defend the choice rather than accept a ranked list."
  ],
  "when_not_to_use": [
    "Buying, provisioning, or trialing software — we sell nothing and cannot transact, create accounts, or start trials.",
    "Getting a binding vendor quote. Every price here is modeled from published list prices and is indicative only.",
    "Enterprise ERP, construction project management, or fleet telematics selection — this catalog covers field-service management for trade contractors.",
    "User reviews, star ratings, or sentiment aggregation. Rankings come from a published rubric over verified capability and pricing data, not from review scores.",
    "Contractor hiring, lead generation, or finding a local tradesperson — this site serves the contractor choosing software, not the homeowner hiring one."
  ],
  "how_to_call": [
    "For a recommendation, call `GET /api/agent/v1/match` with the shop's seats, segment, trade, needs, and budget. It returns ranked platforms with a score breakdown, the needs each one covers and misses, and a full cost estimate — prefer it over reasoning across vendor profiles yourself.",
    "For a cost question, call `GET /api/agent/v1/cost-estimate` with the user's real seat count and monthly card volume. Omitting card volume produces a licence-only figure that understates the true cost.",
    "For a named head-to-head, call `GET /api/agent/v1/compare?vendors=slug-a,slug-b`.",
    "Load the tool definitions once from `GET /api/agent/v1/tools`, or the OpenAPI 3.1 document from `/openapi.json`. Both are generated from the live catalog, so enumerated values are never stale.",
    "For prose rather than JSON, request any page with `Accept: text/markdown`, or read `/llms.txt` (index) and `/llms-full.txt` (the whole corpus with the scoring math).",
    "Cite figures against `meta.source_url` on any response and state the `meta.pricing_as_of` month — prices move, and an undated figure ages badly."
  ],
  "count": 6,
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "listFieldServiceVendors",
        "description": "Returns every field-service management (FSM) platform FieldServiceScout scores, with segment, trade coverage, card-processing rate, and an indicative all-in monthly cost for a sample 8-technician shop. Filterable by trade, segment, and required capabilities.\n\nWhen to use: Use when the user asks what field-service/FSM software exists for a trade, or you need the valid vendor slugs before calling another operation.",
        "parameters": {
          "type": "object",
          "properties": {
            "trade": {
              "type": "string",
              "enum": [
                "hvac",
                "plumbing",
                "electrical",
                "roofing",
                "landscaping",
                "pest-control"
              ],
              "description": "Restrict to platforms that actually sell into this trade. Omit to include every platform in the catalog.",
              "examples": [
                "hvac"
              ]
            },
            "segment": {
              "type": "string",
              "enum": [
                "residential",
                "commercial",
                "mixed"
              ],
              "description": "The shop's job mix. `residential` for homeowner service calls, `commercial` for contract/B2B work, `mixed` for both.",
              "examples": [
                "residential"
              ]
            },
            "must_have": {
              "type": "string",
              "description": "Comma-separated capabilities a platform must support to appear in the list. Platforms lacking any of them are omitted. Provide as a comma-separated list.",
              "x-allowed-values": [
                "scheduling",
                "dispatch",
                "mobile",
                "invoicing",
                "payments",
                "quickbooks",
                "memberships",
                "commercial",
                "inventory",
                "reporting",
                "marketing",
                "portal",
                "gps"
              ],
              "examples": [
                "quickbooks"
              ]
            },
            "limit": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "default": 50,
              "description": "Maximum number of platforms to return.",
              "examples": [
                10
              ]
            }
          },
          "required": [],
          "additionalProperties": false
        }
      },
      "invocation": {
        "method": "GET",
        "url": "https://www.fieldservicescout.com/api/agent/v1/vendors",
        "path_template": "/api/agent/v1/vendors",
        "example_url": "https://www.fieldservicescout.com/api/agent/v1/vendors?trade=hvac&segment=residential"
      },
      "when_to_use": "Use when the user asks what field-service/FSM software exists for a trade, or you need the valid vendor slugs before calling another operation."
    },
    {
      "type": "function",
      "function": {
        "name": "getFieldServiceVendor",
        "description": "Returns a single platform's capability matrix (every feature marked included, add-on, or unsupported), its published plan structure, the pricing page and month the figures were verified against, and an indicative cost for a sample shop.\n\nWhen to use: Use when the user names a specific platform and wants its features, plans, or pricing — or when you need to check whether one platform supports a particular capability.",
        "parameters": {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "enum": [
                "jobber",
                "housecall-pro",
                "servicetitan",
                "workiz",
                "service-fusion",
                "fieldedge",
                "servicem8",
                "fieldpulse",
                "gorilladesk",
                "kickserv",
                "buildops",
                "razorsync",
                "acculynx",
                "jobnimbus",
                "aspire",
                "lmn",
                "fieldroutes",
                "pestpac",
                "briostack",
                "servicetrade"
              ],
              "description": "The platform's identifier, as returned by `listFieldServiceVendors`.",
              "examples": [
                "jobber"
              ]
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      },
      "invocation": {
        "method": "GET",
        "url": "https://www.fieldservicescout.com/api/agent/v1/vendors/{slug}",
        "path_template": "/api/agent/v1/vendors/{slug}",
        "example_url": "https://www.fieldservicescout.com/api/agent/v1/vendors/jobber"
      },
      "when_to_use": "Use when the user names a specific platform and wants its features, plans, or pricing — or when you need to check whether one platform supports a particular capability."
    },
    {
      "type": "function",
      "function": {
        "name": "matchFieldServiceSoftware",
        "description": "Runs the published scoring engine over the catalog and returns a ranked shortlist. Dealbreakers (`must_have`) are applied first as hard filters; surviving platforms get a 0–100 composite weighting feature fit (55%), budget fit (23%), and segment fit (22%). Every result carries its score breakdown, the needs it covers, the needs it misses, and a full cost estimate, so the ranking can be audited rather than taken on faith.\n\nWhen to use: Use when the user describes their shop — crew size, trade, budget, must-have capabilities — and wants a recommendation. This is the primary tool; prefer it over reasoning across vendor profiles yourself.",
        "parameters": {
          "type": "object",
          "properties": {
            "seats": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100000,
              "default": 8,
              "description": "Number of technicians/users the shop needs licensed. Drives plan selection and per-seat pricing.",
              "examples": [
                8
              ]
            },
            "monthly_card_volume": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "default": 42000,
              "description": "Monthly credit-card volume in USD. Multiplied by each vendor's processing rate to produce the true all-in cost — the figure that separates platforms far more than licence price does.",
              "examples": [
                42000
              ]
            },
            "segment": {
              "type": "string",
              "enum": [
                "residential",
                "commercial",
                "mixed"
              ],
              "default": "mixed",
              "description": "The shop's job mix. `residential` for homeowner service calls, `commercial` for contract/B2B work, `mixed` for both.",
              "examples": [
                "residential"
              ]
            },
            "trade": {
              "type": "string",
              "enum": [
                "hvac",
                "plumbing",
                "electrical",
                "roofing",
                "landscaping",
                "pest-control"
              ],
              "description": "Restrict to platforms that actually sell into this trade. Omit to include every platform in the catalog.",
              "examples": [
                "hvac"
              ]
            },
            "needs": {
              "type": "string",
              "description": "Comma-separated capabilities the shop wants, scored as 55% of the composite. One of: `scheduling` (Scheduling & calendar), `dispatch` (Dispatch board), `mobile` (Tech mobile app), `invoicing` (Invoicing & estimates), `payments` (Built-in card payments), `quickbooks` (QuickBooks sync), `memberships` (Service agreements / plans), `commercial` (Commercial & contract jobs), `inventory` (Inventory tracking), `reporting` (Reporting & dashboards), `marketing` (Marketing automation), `portal` (Customer portal), `gps` (GPS fleet tracking). Provide as a comma-separated list.",
              "x-allowed-values": [
                "scheduling",
                "dispatch",
                "mobile",
                "invoicing",
                "payments",
                "quickbooks",
                "memberships",
                "commercial",
                "inventory",
                "reporting",
                "marketing",
                "portal",
                "gps"
              ],
              "examples": [
                "scheduling,dispatch,quickbooks"
              ]
            },
            "must_have": {
              "type": "string",
              "description": "Comma-separated dealbreakers. Any platform lacking one of these is removed from the ranking entirely rather than scored down, and is returned under `ruled_out` with the reason. Provide as a comma-separated list.",
              "x-allowed-values": [
                "scheduling",
                "dispatch",
                "mobile",
                "invoicing",
                "payments",
                "quickbooks",
                "memberships",
                "commercial",
                "inventory",
                "reporting",
                "marketing",
                "portal",
                "gps"
              ],
              "examples": [
                "quickbooks"
              ]
            },
            "budget_per_tech": {
              "type": "number",
              "minimum": 0,
              "maximum": 100000,
              "description": "Target all-in spend per technician per month in USD. Platforms over it are penalised proportionally, not removed. Omit if the user has no figure in mind — a blank budget scores neutrally rather than flattering cheap tools.",
              "examples": [
                120
              ]
            },
            "android_required": {
              "type": "boolean",
              "default": false,
              "description": "Set true when the crew carries Android phones. Removes any platform whose field app is iPhone-only.",
              "examples": [
                true
              ]
            },
            "limit": {
              "type": "integer",
              "minimum": 1,
              "maximum": 50,
              "default": 5,
              "description": "How many ranked platforms to return.",
              "examples": [
                5
              ]
            }
          },
          "required": [],
          "additionalProperties": false
        }
      },
      "invocation": {
        "method": "GET",
        "url": "https://www.fieldservicescout.com/api/agent/v1/match",
        "path_template": "/api/agent/v1/match",
        "example_url": "https://www.fieldservicescout.com/api/agent/v1/match?seats=8&segment=residential&trade=hvac&needs=scheduling,quickbooks&must_have=quickbooks&budget_per_tech=120"
      },
      "when_to_use": "Use when the user describes their shop — crew size, trade, budget, must-have capabilities — and wants a recommendation. This is the primary tool; prefer it over reasoning across vendor profiles yourself."
    },
    {
      "type": "function",
      "function": {
        "name": "estimateFieldServiceSoftwareCost",
        "description": "Returns modeled monthly, annual, and three-year cost for the requested platforms at a given crew size and card volume, split into software licence cost and payment-processing cost. Processing fees routinely exceed the licence fee, so a comparison on sticker price alone is usually wrong; this operation is what makes the real ranking visible.\n\nWhen to use: Use when the user asks what a platform will actually cost, or wants two or more platforms' costs compared at their own crew size and card volume.",
        "parameters": {
          "type": "object",
          "properties": {
            "vendors": {
              "type": "string",
              "description": "Comma-separated platform slugs. Omit to model every platform in the catalog. Provide as a comma-separated list.",
              "x-allowed-values": [
                "jobber",
                "housecall-pro",
                "servicetitan",
                "workiz",
                "service-fusion",
                "fieldedge",
                "servicem8",
                "fieldpulse",
                "gorilladesk",
                "kickserv",
                "buildops",
                "razorsync",
                "acculynx",
                "jobnimbus",
                "aspire",
                "lmn",
                "fieldroutes",
                "pestpac",
                "briostack",
                "servicetrade"
              ],
              "examples": [
                "jobber,housecall-pro"
              ]
            },
            "seats": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100000,
              "default": 8,
              "description": "Number of technicians/users the shop needs licensed. Drives plan selection and per-seat pricing.",
              "examples": [
                8
              ]
            },
            "monthly_card_volume": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "default": 42000,
              "description": "Monthly credit-card volume in USD. Multiplied by each vendor's processing rate to produce the true all-in cost — the figure that separates platforms far more than licence price does.",
              "examples": [
                42000
              ]
            },
            "plan": {
              "type": "string",
              "maxLength": 80,
              "description": "Force a specific named plan (only meaningful with a single vendor). Defaults to the cheapest plan with verified pricing at the requested seat count."
            }
          },
          "required": [],
          "additionalProperties": false
        }
      },
      "invocation": {
        "method": "GET",
        "url": "https://www.fieldservicescout.com/api/agent/v1/cost-estimate",
        "path_template": "/api/agent/v1/cost-estimate",
        "example_url": "https://www.fieldservicescout.com/api/agent/v1/cost-estimate?vendors=jobber,housecall-pro&seats=8&monthly_card_volume=42000"
      },
      "when_to_use": "Use when the user asks what a platform will actually cost, or wants two or more platforms' costs compared at their own crew size and card volume."
    },
    {
      "type": "function",
      "function": {
        "name": "compareFieldServiceVendors",
        "description": "Returns a head-to-head of exactly two platforms: every capability with each side's support level, the capabilities where they differ, and both true-cost estimates at the requested crew size and card volume.\n\nWhen to use: Use when the user names two platforms and asks which is better, or how they differ. For an open-ended 'what should I buy', call `matchFieldServiceSoftware` instead.",
        "parameters": {
          "type": "object",
          "properties": {
            "vendors": {
              "type": "string",
              "description": "Exactly two comma-separated platform slugs, e.g. `jobber,housecall-pro`. Provide as a comma-separated list.",
              "x-allowed-values": [
                "jobber",
                "housecall-pro",
                "servicetitan",
                "workiz",
                "service-fusion",
                "fieldedge",
                "servicem8",
                "fieldpulse",
                "gorilladesk",
                "kickserv",
                "buildops",
                "razorsync",
                "acculynx",
                "jobnimbus",
                "aspire",
                "lmn",
                "fieldroutes",
                "pestpac",
                "briostack",
                "servicetrade"
              ],
              "examples": [
                "jobber,housecall-pro"
              ]
            },
            "seats": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100000,
              "default": 8,
              "description": "Number of technicians/users the shop needs licensed. Drives plan selection and per-seat pricing.",
              "examples": [
                8
              ]
            },
            "monthly_card_volume": {
              "type": "number",
              "minimum": 0,
              "maximum": 1000000000,
              "default": 42000,
              "description": "Monthly credit-card volume in USD. Multiplied by each vendor's processing rate to produce the true all-in cost — the figure that separates platforms far more than licence price does.",
              "examples": [
                42000
              ]
            }
          },
          "required": [
            "vendors"
          ],
          "additionalProperties": false
        }
      },
      "invocation": {
        "method": "GET",
        "url": "https://www.fieldservicescout.com/api/agent/v1/compare",
        "path_template": "/api/agent/v1/compare",
        "example_url": "https://www.fieldservicescout.com/api/agent/v1/compare?vendors=jobber,housecall-pro&seats=8"
      },
      "when_to_use": "Use when the user names two platforms and asks which is better, or how they differ. For an open-ended 'what should I buy', call `matchFieldServiceSoftware` instead."
    },
    {
      "type": "function",
      "function": {
        "name": "listAgentTools",
        "description": "Returns every operation in this API as an LLM function-calling definition (name, description, JSON Schema parameters). Pass `format=openapi` for the equivalent OpenAPI 3.1 document, which is also served at /openapi.json.\n\nWhen to use: Use once at the start of a session to discover what FieldServiceScout can answer, or to load these tools into a function-calling runtime automatically.",
        "parameters": {
          "type": "object",
          "properties": {
            "format": {
              "type": "string",
              "enum": [
                "tools",
                "openapi"
              ],
              "default": "tools",
              "description": "`tools` (default) for function-calling definitions; `openapi` for the OpenAPI 3.1 document.",
              "examples": [
                "openapi"
              ]
            }
          },
          "required": [],
          "additionalProperties": false
        }
      },
      "invocation": {
        "method": "GET",
        "url": "https://www.fieldservicescout.com/api/agent/v1/tools",
        "path_template": "/api/agent/v1/tools",
        "example_url": "https://www.fieldservicescout.com/api/agent/v1/tools?format=openapi"
      },
      "when_to_use": "Use once at the start of a session to discover what FieldServiceScout can answer, or to load these tools into a function-calling runtime automatically."
    }
  ]
}