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

ghl-mcp-server-v2

by zackscriven

ghl_store_update_shipping_carrier

Idempotent

Updates a shipping carrier's details—name, services, callback URL, and multi-service selection—for a store location using its carrier ID and sub-account token.

Instructions

Update Shipping Carrier The "update Shipping Carrier" API allows update a shipping carrier to the system. Endpoint: PUT /store/shipping-carrier/{shippingCarrierId} (Version header: v3; source: v3/store-v3.json) Requires a Sub-Account (location) token.

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

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body (schema carried verbatim from the official OpenAPI spec).
shippingCarrierIdYesID of the shipping carrier that needs to be returned

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv2.1.0
    • addedInput schema / properties / body / properties / services / items / title
      Added value: +"ShippingCarrierServiceDto"
    • addedInput schema / properties / body / title
      Added value: +"UpdateShippingCarrierDto"
  2. First observedv2.0.0

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare readOnly=false, destructive=false, idempotent=true, so the safety profile is covered; the description adds real value beyond them by disclosing the auth scope (Sub-Account/location token), the API version header, and the source spec. It does not state whether omitted fields are cleared or preserved when the services array is replaced, which is the main remaining behavioral gap for a nested-object PUT.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The endpoint and auth lines are front-loaded and earn their place, but the second sentence ('The "update Shipping Carrier" API allows update a shipping carrier to the system') is a tautological restatement of the title with broken grammar and adds nothing.

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?

For a mutation tool with a nested request body and no output schema, the description covers where it goes and what credential it needs, but says nothing about the effect of the update on existing carrier services or what the response contains. Adequate but with clear gaps.

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% and every field, including the nested services array and callbackUrl, is already documented in the schema. The description only contributes the fact that shippingCarrierId is a path parameter, which is marginal; 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 names the verb and resource ('update a shipping carrier') and pins it to the concrete endpoint PUT /store/shipping-carrier/{shippingCarrierId}, which unambiguously distinguishes it from the create/get/delete carrier siblings. It lacks an explicit statement contrasting with those siblings, so it stops short of a 5.

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?

Use is only implied: the PUT endpoint and the required shippingCarrierId signal 'modify an existing carrier', while the presence of ghl_store_create_shipping_carrier as an alternative is never mentioned. The one genuinely useful usage constraint given is the Sub-Account (location) token requirement.

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