Skip to main content
Glama

Get integration fields

get_integration_fields
Read-onlyIdempotent

Integrations (between two systems): Use when someone asks whether a particular field travels between two systems for one record type, for example the phone number, the address, the due date, the line items or the tax of an invoice. Returns every field that travels with the name it has in each system and how it travels ("always": no switch; "needed": locked on, the note says why; "switchable": on unless switched off in the wizard), notes such as fields that only travel when the record is created, the fields of that record type that do not travel, and a link that opens the setup. Record type keys come from get_integration_options. It needs no sign in. Not for which record types a pair offers (use get_integration_options) or for a person's own field mapping.

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": {
      "source_system": "<source_system>",
      "target_system": "<target_system>",
      "record_type": "<record_type>"
    },
    "name": "get_integration_fields"
  }
}

Input Schema

NameRequiredDescriptionDefault
record_typeYesThe record type, by the key get_integration_options returns, for example "contact", "invoice" or "deal_to_invoice".
source_systemYesThe system records come from, by its key.
target_systemYesThe system records go into, by its key.

Output Schema

NameRequiredDescriptionDefault
fieldsYes
sourceYes
targetYes
outcomeYes
summaryYes
setUpUrlYes
notCarriedYes
recordTypeYes
recordTypeLabelYes
offeredRecordTypesYes
requestIntegrationUrlYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / source_system / enum
      Previous value: -[
      -  "activecampaign",
      -  "companycam",
      -  "freeagent",
      -  "freshbooks",
      -  "gohighlevel",
      -  "googlesheets",
      -  "housecallpro",
      -  "hubspot",
      -  "jobber",
      -  "keap",
      -  "monday",
      -  "pipedrive",
      -  "quickbooks",
      -  "salesforce",
      -  "servicem8",
      -  "spreadsheetfile",
      -  "square",
      -  "stripe",
      -  "woocommerce",
      -  "xero",
      -  "zohobooks",
      -  "zohocrm",
      -  "zohoinvoice"
      -]New value: +[
      +  "activecampaign",
      +  "companycam",
      +  "dynamics365",
      +  "freeagent",
      +  "freshbooks",
      +  "gohighlevel",
      +  "googlesheets",
      +  "housecallpro",
      +  "hubspot",
      +  "jobber",
      +  "keap",
      +  "monday",
      +  "pipedrive",
      +  "quickbooks",
      +  "salesforce",
      +  "servicem8",
      +  "spreadsheetfile",
      +  "square",
      +  "stripe",
      +  "teamleader",
      +  "woocommerce",
      +  "xero",
      +  "zohobooks",
      +  "zohocrm",
      +  "zohoinvoice"
      +]
    • changedInput schema / properties / target_system / enum
      Previous value: -[
      -  "activecampaign",
      -  "companycam",
      -  "freeagent",
      -  "freshbooks",
      -  "gohighlevel",
      -  "googlesheets",
      -  "housecallpro",
      -  "hubspot",
      -  "jobber",
      -  "keap",
      -  "monday",
      -  "pipedrive",
      -  "quickbooks",
      -  "salesforce",
      -  "servicem8",
      -  "spreadsheetfile",
      -  "square",
      -  "stripe",
      -  "woocommerce",
      -  "xero",
      -  "zohobooks",
      -  "zohocrm",
      -  "zohoinvoice"
      -]New value: +[
      +  "activecampaign",
      +  "companycam",
      +  "dynamics365",
      +  "freeagent",
      +  "freshbooks",
      +  "gohighlevel",
      +  "googlesheets",
      +  "housecallpro",
      +  "hubspot",
      +  "jobber",
      +  "keap",
      +  "monday",
      +  "pipedrive",
      +  "quickbooks",
      +  "salesforce",
      +  "servicem8",
      +  "spreadsheetfile",
      +  "square",
      +  "stripe",
      +  "teamleader",
      +  "woocommerce",
      +  "xero",
      +  "zohobooks",
      +  "zohocrm",
      +  "zohoinvoice"
      +]
  2. Changed1 schema field changed
    • changedInput schema / properties / record_type / enum
      Previous value: -[
      -  "contact",
      -  "appointment",
      -  "job",
      -  "estimate",
      -  "invoice",
      -  "opportunity",
      -  "deal",
      -  "job_to_appointment",
      -  "job_to_estimate",
      -  "job_to_invoice",
      -  "estimate_to_job",
      -  "deal_to_job",
      -  "deal_to_invoice"
      -]New value: +[
      +  "contact",
      +  "appointment",
      +  "job",
      +  "estimate",
      +  "invoice",
      +  "opportunity",
      +  "deal",
      +  "ticket",
      +  "job_to_appointment",
      +  "job_to_estimate",
      +  "job_to_invoice",
      +  "estimate_to_job",
      +  "deal_to_job",
      +  "deal_to_invoice"
      +]
  3. Changed2 schema fields changed
    • changedInput schema / properties / source_system / enum
      Previous value: -[
      -  "activecampaign",
      -  "companycam",
      -  "freeagent",
      -  "freshbooks",
      -  "gohighlevel",
      -  "googlesheets",
      -  "housecallpro",
      -  "hubspot",
      -  "jobber",
      -  "keap",
      -  "monday",
      -  "pipedrive",
      -  "quickbooks",
      -  "salesforce",
      -  "servicem8",
      -  "spreadsheetfile",
      -  "square",
      -  "stripe",
      -  "woocommerce",
      -  "xero",
      -  "zohobooks",
      -  "zohocrm"
      -]New value: +[
      +  "activecampaign",
      +  "companycam",
      +  "freeagent",
      +  "freshbooks",
      +  "gohighlevel",
      +  "googlesheets",
      +  "housecallpro",
      +  "hubspot",
      +  "jobber",
      +  "keap",
      +  "monday",
      +  "pipedrive",
      +  "quickbooks",
      +  "salesforce",
      +  "servicem8",
      +  "spreadsheetfile",
      +  "square",
      +  "stripe",
      +  "woocommerce",
      +  "xero",
      +  "zohobooks",
      +  "zohocrm",
      +  "zohoinvoice"
      +]
    • changedInput schema / properties / target_system / enum
      Previous value: -[
      -  "activecampaign",
      -  "companycam",
      -  "freeagent",
      -  "freshbooks",
      -  "gohighlevel",
      -  "googlesheets",
      -  "housecallpro",
      -  "hubspot",
      -  "jobber",
      -  "keap",
      -  "monday",
      -  "pipedrive",
      -  "quickbooks",
      -  "salesforce",
      -  "servicem8",
      -  "spreadsheetfile",
      -  "square",
      -  "stripe",
      -  "woocommerce",
      -  "xero",
      -  "zohobooks",
      -  "zohocrm"
      -]New value: +[
      +  "activecampaign",
      +  "companycam",
      +  "freeagent",
      +  "freshbooks",
      +  "gohighlevel",
      +  "googlesheets",
      +  "housecallpro",
      +  "hubspot",
      +  "jobber",
      +  "keap",
      +  "monday",
      +  "pipedrive",
      +  "quickbooks",
      +  "salesforce",
      +  "servicem8",
      +  "spreadsheetfile",
      +  "square",
      +  "stripe",
      +  "woocommerce",
      +  "xero",
      +  "zohobooks",
      +  "zohocrm",
      +  "zohoinvoice"
      +]
  4. Changed2 schema fields changed
    • changedInput schema / properties / source_system / enum
      Previous value: -[
      -  "activecampaign",
      -  "companycam",
      -  "freeagent",
      -  "freshbooks",
      -  "gohighlevel",
      -  "googlesheets",
      -  "housecallpro",
      -  "hubspot",
      -  "jobber",
      -  "keap",
      -  "pipedrive",
      -  "quickbooks",
      -  "salesforce",
      -  "servicem8",
      -  "spreadsheetfile",
      -  "square",
      -  "stripe",
      -  "woocommerce",
      -  "xero",
      -  "zohobooks",
      -  "zohocrm"
      -]New value: +[
      +  "activecampaign",
      +  "companycam",
      +  "freeagent",
      +  "freshbooks",
      +  "gohighlevel",
      +  "googlesheets",
      +  "housecallpro",
      +  "hubspot",
      +  "jobber",
      +  "keap",
      +  "monday",
      +  "pipedrive",
      +  "quickbooks",
      +  "salesforce",
      +  "servicem8",
      +  "spreadsheetfile",
      +  "square",
      +  "stripe",
      +  "woocommerce",
      +  "xero",
      +  "zohobooks",
      +  "zohocrm"
      +]
    • changedInput schema / properties / target_system / enum
      Previous value: -[
      -  "activecampaign",
      -  "companycam",
      -  "freeagent",
      -  "freshbooks",
      -  "gohighlevel",
      -  "googlesheets",
      -  "housecallpro",
      -  "hubspot",
      -  "jobber",
      -  "keap",
      -  "pipedrive",
      -  "quickbooks",
      -  "salesforce",
      -  "servicem8",
      -  "spreadsheetfile",
      -  "square",
      -  "stripe",
      -  "woocommerce",
      -  "xero",
      -  "zohobooks",
      -  "zohocrm"
      -]New value: +[
      +  "activecampaign",
      +  "companycam",
      +  "freeagent",
      +  "freshbooks",
      +  "gohighlevel",
      +  "googlesheets",
      +  "housecallpro",
      +  "hubspot",
      +  "jobber",
      +  "keap",
      +  "monday",
      +  "pipedrive",
      +  "quickbooks",
      +  "salesforce",
      +  "servicem8",
      +  "spreadsheetfile",
      +  "square",
      +  "stripe",
      +  "woocommerce",
      +  "xero",
      +  "zohobooks",
      +  "zohocrm"
      +]
  5. Added

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description goes well beyond that: it enumerates the return payload (per-system field names, travel mode, notes, non-travelling fields, setup link), defines the three travel modes including why 'needed' is locked, and states no sign-in is required. That is substantive behavioral context an agent could not infer from annotations.

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?

Front-loaded with the tool's identity and the triggering question before the payload detail, and the mode definitions are compact. The example list ('the phone number, the address, the due date, the line items or the tax') is slightly padded, but it aids matching against user phrasing, so it largely earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a three-required-enum read tool with a full schema, annotations and an output schema, the description covers trigger, exclusions, auth, payload shape and semantics of the returned modes. Nothing an agent needs in order to call it or interpret the result is missing.

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% with enums on all three parameters, so the schema already documents source_system, target_system and record_type fully. The description adds only the cross-reference that record type keys come from get_integration_options, which the schema itself already states. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('get integration fields') and immediately scopes it: fields that travel between two systems for one record type, with the name each field has per system and how it travels. This is concrete enough that an agent can distinguish it from get_integration_options or propose_update_fields without opening a schema.

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

Usage Guidelines5/5

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

Gives an explicit triggering question ('whether a particular field travels between two systems for one record type') and two explicit exclusions: not for which record types a pair offers (route to get_integration_options) and not for a person's own field mapping. Both when-to-use and when-not-to-use are covered with named alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources