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

ghl-mcp-server-v2

by zackscriven

ghl_payment_custom_provider_create_config

Create a new custom payment provider configuration for a location by submitting live and test API keys, enabling payment setup for that sub-account.

Instructions

Create new provider config API to create a new payment config for given location Endpoint: POST /payments/custom-provider/connect (Version header: v3; source: v3/payments-v3.json) Requires a Sub-Account (location) token. OAuth scopes: payments/custom-provider.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": {
      "locationId": "<locationId>",
      "body": "<body>"
    },
    "name": "ghl_payment_custom_provider_create_config"
  }
}

Input Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.1.0
    • changedInput schema / properties / body / properties / live / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "apiKey": {
      -        "description": "Api-key for custom payment provider config",
      -        "example": "y5ZQxryRFXZHvUJZdLeXXXXX",
      -        "type": "string"
      -      },
      -      "publishableKey": {
      -        "description": "Publishable-key for custom payment provider config",
      -        "example": "rzp_test_zPRoVMLOa0XXXX",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "apiKey",
      -      "publishableKey"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "apiKey": {
      +        "description": "Api-key for custom payment provider config",
      +        "example": "y5ZQxryRFXZHvUJZdLeXXXXX",
      +        "type": "string"
      +      },
      +      "publishableKey": {
      +        "description": "Publishable-key for custom payment provider config",
      +        "example": "rzp_test_zPRoVMLOa0XXXX",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "apiKey",
      +      "publishableKey"
      +    ],
      +    "title": "CustomProviderKeys",
      +    "type": "object"
      +  }
      +]
    • changedInput schema / properties / body / properties / test / allOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "apiKey": {
      -        "description": "Api-key for custom payment provider config",
      -        "example": "y5ZQxryRFXZHvUJZdLeXXXXX",
      -        "type": "string"
      -      },
      -      "publishableKey": {
      -        "description": "Publishable-key for custom payment provider config",
      -        "example": "rzp_test_zPRoVMLOa0XXXX",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "apiKey",
      -      "publishableKey"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "apiKey": {
      +        "description": "Api-key for custom payment provider config",
      +        "example": "y5ZQxryRFXZHvUJZdLeXXXXX",
      +        "type": "string"
      +      },
      +      "publishableKey": {
      +        "description": "Publishable-key for custom payment provider config",
      +        "example": "rzp_test_zPRoVMLOa0XXXX",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "apiKey",
      +      "publishableKey"
      +    ],
      +    "title": "CustomProviderKeys",
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / body / title
      Added value: +"ConnectCustomProvidersConfigDto"
  2. First observedv2.0.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, openWorldHint=true, idempotentHint=false, and destructiveHint=false, so the safety profile is largely covered. The description adds useful auth context (Sub-Account token, `payments/custom-provider.write` scope) and identifies the external `POST /payments/custom-provider/connect` endpoint, but it does not explain side effects, overwrite behavior, or what happens if a config already exists.

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 description is short and front-loaded with the core action. It is mostly efficient, though 'Create new provider config' and 'API to create a new payment config for given location' are slightly redundant.

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?

Given the nested request body and mutation semantics, the description covers auth and endpoint details but omits return behavior and post-creation effects. Since no output schema exists, some explanation of the response or resulting config state would improve completeness.

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 `locationId` and the nested `body.live` / `body.test` structures are already documented in the schema. The description only echoes 'for given location' and adds no further meaning about the required live/test key pairs, so baseline 3 is appropriate.

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?

The description states a specific verb and resource: 'Create new provider config' and 'create a new payment config for given location'. It is clear enough to distinguish this from read/update/delete config siblings, but it does not explicitly differentiate it from the similarly named `ghl_payment_custom_provider_create` sibling.

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

Usage Guidelines2/5

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

The description provides prerequisites such as a Sub-Account token and the required OAuth scope, but it never says when to use this tool versus alternatives like `ghl_payment_custom_provider_create` or `ghl_payment_integration_provider_create`. It also gives no exclusions or conditions indicating when this tool should not be used.

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