Skip to main content
Glama
ghl-mcp-server-v2

ghl-mcp-server-v2

by zackscriven

ghl_marketplace_migrate_connection

Migrates external authentication credentials (basic or OAuth2) for a specific app and location into the CRM's encrypted storage, enabling the CRM to manage token lifecycle.

Instructions

Migrate external authentication connection Migrates an external authentication connection credentials (basic or oauth2) for a specific app and location. This endpoint validates the app configuration, stores credentials safely in CRM's native encrypted storage. With this the lifecycle of the token is managed by CRM. Endpoint: POST /marketplace/external-auth/migration (Version header: v3; source: v3/marketplace-v3.json) Requires a Sub-Account (location) token. OAuth access token only — Private Integration Tokens are rejected. OAuth scopes: marketplace-external-auth-migration.write

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": {
      "body": "<body>"
    },
    "name": "ghl_marketplace_migrate_connection"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv2.1.0
    • addedInput schema / properties / body / properties / email
      Added value: +{
      +  "description": "Account email metadata for the migrated connection",
      +  "example": "user@example.com",
      +  "type": "string"
      +}
    • addedInput schema / properties / body / properties / identitySource
      Added value: +{
      +  "description": "Source of the account identity metadata",
      +  "enum": [
      +    "provider",
      +    "manual"
      +  ],
      +  "example": "manual",
      +  "type": "string"
      +}
    • changedInput schema / properties / body / properties / refreshToken / description
      Previous value: -"Refresh token (required when type is oauth2)"New value: +"Refresh token. Omit only when the provider issues long-lived, non-refreshable tokens (e.g. TikTok Marketing API, ClickUp) and therefore never returns one. Callers are responsible for supplying it whenever their app has a refresh endpoint configured: the migration stores exactly what it is given and replaces any previously stored secret, so omitting a refresh token the connection needs will leave it unable to refresh once the access token expires. Must be a non-empty string when supplied — null is rejected."
    • addedInput schema / properties / body / title
      Added value: +"MigrateConnectionDto"
  2. First observedv2.0.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations declare a non-read-only, non-idempotent, non-destructive write, and the description adds real value on top: app configuration validation, encrypted native credential storage, and transfer of token lifecycle to CRM. It stops short of disclosing the most consequential behavior for a non-idempotent tool — that a repeat migration overwrites previously stored secrets — which is only hinted at inside the schema.

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 action and its effect in the first two sentences, then auth prerequisites. The trailing 'Endpoint: POST ... (Version header: v3; source: v3/marketplace-v3.json)' line is spec metadata that adds little for tool selection, a minor but real tax.

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

Completeness4/5

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

For a single nested-body, no-output-schema tool with annotations present, the description covers action, storage semantics, auth requirements, and required scope. It does not say what comes back on success (a connection record? an id?) or how overwrite behaves, which would round it out.

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% and the body schema documents each field (including the detailed refreshToken caveat), so the schema carries the load. The description adds only the 'basic or oauth2' type split, matching the baseline 3 when structured data already covers parameters.

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?

The description names a specific verb and resource ('Migrate external authentication connection credentials') and immediately scopes it to a specific app and location, distinguishing it from the surrounding calendar/contact/marketplace siblings, none of which handle credential migration.

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?

It gives useful preconditions (Sub-Account/location token required, OAuth access token only, Private Integration Tokens rejected, required scope) but never states when to use this versus any alternative or when not to call it. No sibling or non-migration path is named, so the agent must infer the situation.

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