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

ghl-mcp-server-v2

by zackscriven

ghl_payment_order_list_notes

Read-onlyIdempotent

List all notes for a specific payment order using its order ID and location token, so you can review order-related comments and history.

Instructions

List Order Notes List all notes of an order Endpoint: GET /payments/orders/{orderId}/notes (Version header: v3; source: v3/payments-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": {
      "altId": "<altId>",
      "altType": "<altType>",
      "orderId": "<orderId>"
    },
    "name": "ghl_payment_order_list_notes"
  }
}

Input Schema

NameRequiredDescriptionDefault
altIdYesLocation Id or Agency Id
altTypeYes
orderIdYesID of the order that needs to be returned

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds useful context about the endpoint version and the required Sub-Account token, but it does not mention pagination, rate limits, or return behavior.

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 action stated immediately. The first line duplicates the second line slightly, but the endpoint and token requirement are useful and efficiently presented.

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 read-only list tool with annotations covering safety, the description gives the endpoint, version, and auth requirement. However, it omits pagination and return-shape details, which would be helpful since there is no output schema.

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 67%, with altId and orderId documented in the schema but altType left as an enum-only field. The description confirms that orderId is used in the path and that a Sub-Account token is required, but it does not clarify altType or add much beyond the schema.

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 clearly states a specific verb and resource: list all notes of an order. The endpoint path reinforces that this is the order-notes listing operation, though it does not explicitly distinguish itself from nearby payment-order siblings such as ghl_payment_order_get or ghl_payment_order_list_fulfillments.

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?

The intended use is implied by 'List all notes of an order', but there is no explicit guidance on when to choose this tool over alternatives. It also does not state any exclusions or preconditions beyond the 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