finpay-mcp-server

get_payment_hub

Check a payment hub's current details and health metrics: status, supported currencies and countries, transfer limits, latency, and 24-hour success rate.

Instructions

Get a payment hub's current details and health metrics. Returns hub status, supported currencies, supported countries, transfer amount limits, average latency, and 24h success rate. Returns a NOT_FOUND error if the hub ID does not exist.

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": {
      "id": "<id>"
    },
    "name": "get_payment_hub"
  }
}

Input Schema

Name	Required	Description	Default
`id`	Yes	Hub ID (e.g. hub-001, hub-002, hub-003, hub-004)

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.0.0Aug 14, 2026

TDQS

A4.3/5.0

Behavior4/5

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

With no annotations, the description carries the full burden. It discloses what the tool returns (health metrics, supported currencies/countries, limits) and explicitly mentions the NOT_FOUND error for invalid IDs, which is useful behavioral context. It does not mention auth or rate limits, but for a simple read-only getter, this is adequate.

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

Conciseness5/5

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

The description is two concise sentences. The first sentence front-loads the purpose and return data; the second covers error behavior. Every word earns its place with no fluff or repetition.

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?

For a simple getter with one parameter and no output schema, the description sufficiently covers input, output, and error cases. It lists all key return fields and the error condition, making it self-contained and complete for its complexity.

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% with a clear description and examples for the 'id' parameter. The tool description adds no extra semantic value beyond what the schema already provides; mentioning 'hub ID' in the error case is redundant. Baseline 3 is appropriate.

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 uses a specific verb ('Get'), identifies the resource ('a payment hub'), and clearly states the scope ('current details and health metrics'). It lists the exact data returned (status, currencies, countries, limits, latency, success rate), distinguishing it from sibling tools that list hubs or transactions.

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

Usage Guidelines4/5

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

The description clearly implies when to use this tool (when you need a single hub's details/health), and the error behavior indicates it's for an existing hub. However, it does not explicitly name alternatives like list_payment_hubs or state exclusions, so it falls slightly short of full guideline clarity.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server