Skip to main content
Glama

How to connect a system

get_connection_guide
Read-onlyIdempotent

CRM Connector: Use when someone asks how to connect a system to CRM Connector or what they need for it (a key, a token, an account id) and where to find it. Returns the steps, each field with where to find it, and a setup link. No sign in needed. Not for what travels between two systems (use get_integration_options).

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": {
      "system": "<system>"
    },
    "name": "get_connection_guide"
  }
}

Input Schema

NameRequiredDescriptionDefault
systemYesThe system to connect. Its name or key, such as hubspot.
other_systemNoOptional: for a spreadsheet, the system it feeds, to get our template for it. Its name or key, such as hubspot.

Output Schema

NameRequiredDescriptionDefault
sendsYes
sheetYes
stepsYes
fieldsYes
methodYes
noticeYes
systemYes
outcomeYes
summaryYes
receivesYes
setUpUrlYes
connectUrlNo
requestIntegrationUrlYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • changedInput schema / properties / other_system / description
      Previous value: -"Optional: for a spreadsheet (googlesheets or spreadsheetfile), the system it should feed; the answer then carries our template made for that system, the recommended way to start."New value: +"Optional: for a spreadsheet, the system it feeds, to get our template for it. Its name or key, such as hubspot."
    • removedInput schema / properties / other_system / enum
      Removed value: -[
      -  "activecampaign",
      -  "companycam",
      -  "freeagent",
      -  "freshbooks",
      -  "gohighlevel",
      -  "googlesheets",
      -  "housecallpro",
      -  "hubspot",
      -  "jobber",
      -  "keap",
      -  "pipedrive",
      -  "quickbooks",
      -  "servicem8",
      -  "spreadsheetfile",
      -  "square",
      -  "stripe",
      -  "woocommerce",
      -  "xero",
      -  "zohobooks",
      -  "zohocrm"
      -]
    • addedInput schema / properties / other_system / maxLength
      Added value: +100
    • changedInput schema / properties / system / description
      Previous value: -"The system to connect, by its key."New value: +"The system to connect. Its name or key, such as hubspot."
    • removedInput schema / properties / system / enum
      Removed value: -[
      -  "activecampaign",
      -  "companycam",
      -  "freeagent",
      -  "freshbooks",
      -  "gohighlevel",
      -  "googlesheets",
      -  "housecallpro",
      -  "hubspot",
      -  "jobber",
      -  "keap",
      -  "pipedrive",
      -  "quickbooks",
      -  "servicem8",
      -  "spreadsheetfile",
      -  "square",
      -  "stripe",
      -  "woocommerce",
      -  "xero",
      -  "zohobooks",
      -  "zohocrm"
      -]
    • addedInput schema / properties / system / maxLength
      Added value: +100
  2. Changed2 schema fields changed
    • changedInput schema / properties / other_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",
      +  "pipedrive",
      +  "quickbooks",
      +  "servicem8",
      +  "spreadsheetfile",
      +  "square",
      +  "stripe",
      +  "woocommerce",
      +  "xero",
      +  "zohobooks",
      +  "zohocrm"
      +]
    • changedInput schema / properties / 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",
      +  "pipedrive",
      +  "quickbooks",
      +  "servicem8",
      +  "spreadsheetfile",
      +  "square",
      +  "stripe",
      +  "woocommerce",
      +  "xero",
      +  "zohobooks",
      +  "zohocrm"
      +]
  3. Changed2 schema fields changed
    • changedInput schema / properties / other_system / enum
      Previous 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"
      -]New value: +[
      +  "activecampaign",
      +  "companycam",
      +  "freeagent",
      +  "freshbooks",
      +  "gohighlevel",
      +  "googlesheets",
      +  "housecallpro",
      +  "hubspot",
      +  "jobber",
      +  "keap",
      +  "pipedrive",
      +  "quickbooks",
      +  "salesforce",
      +  "servicem8",
      +  "spreadsheetfile",
      +  "square",
      +  "stripe",
      +  "woocommerce",
      +  "xero",
      +  "zohobooks",
      +  "zohocrm"
      +]
    • changedInput schema / properties / system / enum
      Previous 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"
      -]New value: +[
      +  "activecampaign",
      +  "companycam",
      +  "freeagent",
      +  "freshbooks",
      +  "gohighlevel",
      +  "googlesheets",
      +  "housecallpro",
      +  "hubspot",
      +  "jobber",
      +  "keap",
      +  "pipedrive",
      +  "quickbooks",
      +  "salesforce",
      +  "servicem8",
      +  "spreadsheetfile",
      +  "square",
      +  "stripe",
      +  "woocommerce",
      +  "xero",
      +  "zohobooks",
      +  "zohocrm"
      +]
  4. Changed2 schema fields changed
    • changedInput schema / properties / other_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 / 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"
      +]
  5. Changed2 schema fields changed
    • changedInput schema / properties / other_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 / 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"
      +]
  6. Changed2 schema fields changed
    • changedInput schema / properties / other_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 / 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"
      +]
  7. Changed2 schema fields changed
    • changedInput schema / properties / other_system / enum
      Previous value: -[
      -  "activecampaign",
      -  "companycam",
      -  "freeagent",
      -  "freshbooks",
      -  "gohighlevel",
      -  "googlesheets",
      -  "housecallpro",
      -  "hubspot",
      -  "jobber",
      -  "keap",
      -  "pipedrive",
      -  "quickbooks",
      -  "salesforce",
      -  "servicem8",
      -  "simpro",
      -  "spreadsheetfile",
      -  "square",
      -  "stripe",
      -  "woocommerce",
      -  "xero",
      -  "zohobooks",
      -  "zohocrm"
      -]New value: +[
      +  "activecampaign",
      +  "companycam",
      +  "freeagent",
      +  "freshbooks",
      +  "gohighlevel",
      +  "googlesheets",
      +  "housecallpro",
      +  "hubspot",
      +  "jobber",
      +  "keap",
      +  "pipedrive",
      +  "quickbooks",
      +  "salesforce",
      +  "servicem8",
      +  "spreadsheetfile",
      +  "square",
      +  "stripe",
      +  "woocommerce",
      +  "xero",
      +  "zohobooks",
      +  "zohocrm"
      +]
    • changedInput schema / properties / system / enum
      Previous value: -[
      -  "activecampaign",
      -  "companycam",
      -  "freeagent",
      -  "freshbooks",
      -  "gohighlevel",
      -  "googlesheets",
      -  "housecallpro",
      -  "hubspot",
      -  "jobber",
      -  "keap",
      -  "pipedrive",
      -  "quickbooks",
      -  "salesforce",
      -  "servicem8",
      -  "simpro",
      -  "spreadsheetfile",
      -  "square",
      -  "stripe",
      -  "woocommerce",
      -  "xero",
      -  "zohobooks",
      -  "zohocrm"
      -]New value: +[
      +  "activecampaign",
      +  "companycam",
      +  "freeagent",
      +  "freshbooks",
      +  "gohighlevel",
      +  "googlesheets",
      +  "housecallpro",
      +  "hubspot",
      +  "jobber",
      +  "keap",
      +  "pipedrive",
      +  "quickbooks",
      +  "salesforce",
      +  "servicem8",
      +  "spreadsheetfile",
      +  "square",
      +  "stripe",
      +  "woocommerce",
      +  "xero",
      +  "zohobooks",
      +  "zohocrm"
      +]
  8. Changed2 schema fields changed
    • changedInput schema / properties / other_system / enum
      Previous value: -[
      -  "activecampaign",
      -  "acuityscheduling",
      -  "airtable",
      -  "bluepark",
      -  "booker",
      -  "booqable",
      -  "calendly",
      -  "cleancloud",
      -  "cliniko",
      -  "clio",
      -  "companycam",
      -  "dentally",
      -  "fieldroutes",
      -  "formitable",
      -  "freeagent",
      -  "freshbooks",
      -  "freshsales",
      -  "gingr",
      -  "gohighlevel",
      -  "googlecalendar",
      -  "googlecontacts",
      -  "googlesheets",
      -  "gorilladesk",
      -  "housecallpro",
      -  "hubspot",
      -  "instantly",
      -  "jobber",
      -  "jobnimbus",
      -  "jobprogress",
      -  "keap",
      -  "klaviyo",
      -  "leadmailbox",
      -  "mindbody",
      -  "moego",
      -  "moxie",
      -  "noona",
      -  "pabau",
      -  "phorest",
      -  "pipedrive",
      -  "quickbooks",
      -  "retailedge",
      -  "rompslomp",
      -  "rooflink",
      -  "sage",
      -  "salesforce",
      -  "servicem8",
      -  "servicemonster",
      -  "shopify",
      -  "shore",
      -  "simpro",
      -  "splose",
      -  "spreadsheetfile",
      -  "square",
      -  "stripe",
      -  "sweepandgo",
      -  "thryv",
      -  "vagaro",
      -  "woocommerce",
      -  "workiz",
      -  "xero",
      -  "youcanbookme",
      -  "zohobooks",
      -  "zohocrm"
      -]New value: +[
      +  "activecampaign",
      +  "companycam",
      +  "freeagent",
      +  "freshbooks",
      +  "gohighlevel",
      +  "googlesheets",
      +  "housecallpro",
      +  "hubspot",
      +  "jobber",
      +  "keap",
      +  "pipedrive",
      +  "quickbooks",
      +  "salesforce",
      +  "servicem8",
      +  "simpro",
      +  "spreadsheetfile",
      +  "square",
      +  "stripe",
      +  "woocommerce",
      +  "xero",
      +  "zohobooks",
      +  "zohocrm"
      +]
    • changedInput schema / properties / system / enum
      Previous value: -[
      -  "activecampaign",
      -  "acuityscheduling",
      -  "airtable",
      -  "bluepark",
      -  "booker",
      -  "booqable",
      -  "calendly",
      -  "cleancloud",
      -  "cliniko",
      -  "clio",
      -  "companycam",
      -  "dentally",
      -  "fieldroutes",
      -  "formitable",
      -  "freeagent",
      -  "freshbooks",
      -  "freshsales",
      -  "gingr",
      -  "gohighlevel",
      -  "googlecalendar",
      -  "googlecontacts",
      -  "googlesheets",
      -  "gorilladesk",
      -  "housecallpro",
      -  "hubspot",
      -  "instantly",
      -  "jobber",
      -  "jobnimbus",
      -  "jobprogress",
      -  "keap",
      -  "klaviyo",
      -  "leadmailbox",
      -  "mindbody",
      -  "moego",
      -  "moxie",
      -  "noona",
      -  "pabau",
      -  "phorest",
      -  "pipedrive",
      -  "quickbooks",
      -  "retailedge",
      -  "rompslomp",
      -  "rooflink",
      -  "sage",
      -  "salesforce",
      -  "servicem8",
      -  "servicemonster",
      -  "shopify",
      -  "shore",
      -  "simpro",
      -  "splose",
      -  "spreadsheetfile",
      -  "square",
      -  "stripe",
      -  "sweepandgo",
      -  "thryv",
      -  "vagaro",
      -  "woocommerce",
      -  "workiz",
      -  "xero",
      -  "youcanbookme",
      -  "zohobooks",
      -  "zohocrm"
      -]New value: +[
      +  "activecampaign",
      +  "companycam",
      +  "freeagent",
      +  "freshbooks",
      +  "gohighlevel",
      +  "googlesheets",
      +  "housecallpro",
      +  "hubspot",
      +  "jobber",
      +  "keap",
      +  "pipedrive",
      +  "quickbooks",
      +  "salesforce",
      +  "servicem8",
      +  "simpro",
      +  "spreadsheetfile",
      +  "square",
      +  "stripe",
      +  "woocommerce",
      +  "xero",
      +  "zohobooks",
      +  "zohocrm"
      +]
  9. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already cover read-only, non-destructive, idempotent, closed-world, so the description's added value is the "No sign in needed" auth note and the shape of the returned steps — both beyond the structured fields. It stops short of saying whether results are cached or system-specific to this tenant, so it earns a 4 rather than a 5.

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?

The purpose leads, the return contents follow, and the exclusion closes — a logical order with no filler sentences. The first sentence is a long run-on stacking purpose, prerequisites, and locations, which costs a little readability.

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?

With an output schema present, the description does not need to enumerate return values and correctly stops at a summary. Annotations, full schema coverage, and the explicit sibling exclusion together leave nothing an agent needs missing before calling it.

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 both `system` and `other_system` are fully documented in the schema itself. The description hints at credential types (key, token, account id) but that describes returned content, not parameter semantics, so the baseline 3 applies.

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?

"Use when someone asks how to connect a system to CRM Connector or what they need for it" states a specific resource and task, and the return contents (steps, per-field locations, setup link) are spelled out. It is clearly distinguishable from the integration-options sibling without opening any 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?

Both directions are explicit: use it for connection prerequisites and where to find them, and the negative case is named with an alternative — "Not for what travels between two systems (use get_integration_options)." The agent has a routing rule, not an inference.

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