Skip to main content
Glama
MyFatoorah MCP

MyFatoorah MCP

by kuwaitdevs

MyFatoorah MCP

一个对 LLM 友好的 Model Context Protocol 服务器,用于 MyFatoorah API。它让 Claude、VS Code、Cursor 以及其他 MCP 主机能够通过专用工具发现支付方式、创建支付链接、验证支付、查看发票以及管理退款。

这是一个独立的社区项目,不是 MyFatoorah 的官方产品。在使用正式账户之前,请先在沙盒环境中测试。

有关分步主机设置、Inspector 测试、智能体提示词、支付验证、退款和故障排查,请参阅使用指南。

要求

  • Node.js 20 或更高版本

  • 一个 MyFatoorah API 令牌,仅需包含你所使用工具要求的权限

Related MCP server: pai

设置

npm install
cp .env.example .env
npm run build

在 MCP 主机的环境中设置 MYFATOORAH_API_TOKEN。服务器不会自动加载 .env 文件;VS Code 的调试配置会加载。

环境变量

变量

必填

默认值

说明

MYFATOORAH_API_TOKEN

调用 API 时需要

—

Bearer 令牌。切勿将其暴露给智能体提示词。

MYFATOORAH_ENVIRONMENT

否

test

test、kuwait、uae、saudi_arabia、qatar 或 egypt

MYFATOORAH_BASE_URL

否

环境 URL

用于受支持的 MyFatoorah 部署或测试代理的 HTTPS 覆盖

MYFATOORAH_TIMEOUT_MS

否

30000

请求超时,范围为 1 到 300000 毫秒

科威特环境还覆盖巴林、约旦和阿曼共用的 API 源。多国家账户需要为每个国家使用单独的令牌。

连接 MCP 主机

在主机配置中使用绝对路径。请在本地替换 /absolute/path/to/myfatoorah-mcp 和令牌占位符。

Claude Desktop

将此服务器添加到 Claude Desktop 的 MCP 配置中:

{
  "mcpServers": {
    "myfatoorah": {
      "command": "node",
      "args": ["/absolute/path/to/myfatoorah-mcp/dist/index.js"],
      "env": {
        "MYFATOORAH_API_TOKEN": "YOUR_TOKEN",
        "MYFATOORAH_ENVIRONMENT": "test"
      }
    }
  }
}

保存配置后,重启 Claude Desktop。

Claude Code

项目级配置可以使用 .mcp.json(如果其中包含令牌,请勿提交):

{
  "mcpServers": {
    "myfatoorah": {
      "type": "stdio",
      "command": "node",
      "args": ["/absolute/path/to/myfatoorah-mcp/dist/index.js"],
      "env": {
        "MYFATOORAH_API_TOKEN": "YOUR_TOKEN",
        "MYFATOORAH_ENVIRONMENT": "test"
      }
    }
  }
}

VS Code / GitHub Copilot

随附的 .vscode/mcp.json 会启动构建后的服务器,并安全地提示输入令牌。构建一次,打开 MCP 服务器视图,然后启动 myfatoorah。该令牌不会存储在仓库中。

Cursor 和通用 stdio 主机

使用与 Claude Desktop 示例相同的 command、args 和 env 值。MCP 协议消息使用 stdin/stdout;服务器诊断信息必须使用 stderr。

发布到 npm 后,主机也可以改用 npx -y myfatoorah-mcp 启动它。

工具

工具

影响

用途

myfatoorah_get_payment_methods

只读

列出已启用的支付方式及其 ApiName 值

myfatoorah_create_payment

创建数据

使用 POST /v3/payments 创建托管结账或发票链接

myfatoorah_get_payment

只读

按 PaymentId 获取权威支付详情

myfatoorah_get_invoice

只读

按 InvoiceId 或外部标识符获取发票

myfatoorah_create_refund

破坏性

创建全额或部分退款;需要 confirm: true

myfatoorah_get_refund

只读

按 RefundId 获取退款详情

myfatoorah_api_request

视情况而定

针对相对 /v2/ 或 /v3/ 路径的受限逃生通道;变更操作需要确认

该服务器还提供:

  • 资源 myfatoorah://configuration:环境、基础 URL、超时时间,以及是否已配置令牌——绝不包含令牌本身。

  • 提示 create-payment-safely:一个可复用的引导式支付链接工作流。

成功的工具会返回简洁的文本摘要,外加包含 MyFatoorah 响应的机器可读 structuredContent。

安全支付工作流

  1. 读取 myfatoorah://configuration,确认是测试环境还是正式环境。

  2. 如需选择支付网关,请调用 myfatoorah_get_payment_methods 并使用其 ApiName。

  3. 确认金额、货币、客户、通知方式以及回调 URL。

  4. 调用 myfatoorah_create_payment,将返回的 PaymentURL 提供给客户。

  5. 回调之后,使用返回的 PaymentId 调用 myfatoorah_get_payment。重定向并不代表支付完成;必须确认发票状态为 PAID 且交易状态为 SUCCESS。

退款在正式模式下会真实转移资金。在传入 confirm: true 之前,必须就确切的 PaymentId 和金额获得用户的明确批准。

开发

npm run format
npm run lint
npm run typecheck
npm test
npm run build
npm run inspect

npm run inspect 会针对编译后的 stdio 服务器启动官方 MCP Inspector。VS Code 还包含构建/测试任务和调试配置。

测试会模拟所有 MyFatoorah 请求;它们不会发起网络调用,也不需要令牌。

安全

  • 使用最小权限的 MyFatoorah API 密钥,并定期轮换。

  • 将凭据放入主机环境或密钥管理器中,切勿放入源代码管理或模型上下文。

  • 通用请求工具会拒绝绝对 URL、协议相对 URL、路径穿越以及 /v2/ 和 /v3/ 之外的路径,以防凭据外泄。

  • API 错误和 Bearer 值在到达模型之前会被脱敏。

  • 对于受支持的变更操作,请优先使用幂等键和稳定的订单标识符。

  • 请勿将此 stdio 进程作为未经身份验证的网络服务暴露。

  • 直接卡片处理被刻意未建模为专用工具;这需要符合 PCI 合规要求。

API 范围与参考

这些专用工具使用 MyFatoorah 文档中截至 2026 年 8 月的 v3 路由:

  • GET /v3/payment-methods

  • POST /v3/payments

  • GET /v3/payments/{paymentId}

  • GET /v3/invoices/{invoiceId}

  • GET /v3/invoices/externalIdentifier/{externalIdentifier}

  • POST /v3/refunds

  • GET /v3/refunds/{refundId}

参考:

许可证

MIT

Available Tools

7 tools
myfatoorah_api_requestAdvanced MyFatoorah API requestA
Destructive

Escape hatch for documented MyFatoorah v2/v3 endpoints not covered by another tool. Accepts only safe relative /v2/ or /v3/ paths and GET, POST, or PUT. Absolute URLs are blocked so credentials cannot be sent elsewhere. POST/PUT require confirm=true.

NameRequiredDescriptionDefault
bodyNo
pathYesRelative path beginning with /v2/ or /v3/.
methodNoGET
confirmNoMust be true for POST or PUT.
idempotencyKeyNo

Output Schema

NameRequiredDescription
responseYes

TDQS

A4.4/5.0
Behavior5/5

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

Beyond the annotations, the description discloses substantial behavioral constraints: only safe relative /v2/ or /v3/ paths are accepted, only GET/POST/PUT methods, absolute URLs are blocked to prevent credential exfiltration, and POST/PUT require confirm=true. These align with (and add detail to) the destructiveHint=true annotation; no contradiction.

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?

Four short sentences, each earning its place: purpose first, then method/path constraints, then the safety rationale, then the mutation gate. No filler or redundancy.

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?

With an output schema present, return values need no explanation, and the annotations plus description cover the safety profile well. The remaining gaps are body format and idempotencyKey usage guidance, which an agent needs for correct POST/PUT invocations, but the core contract is otherwise fully specified.

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 only 40%, so the description carries part of the burden. It adds real value for path (relative-only, absolute URLs blocked) and reinforces the confirm gate, but it leaves body format and idempotencyKey semantics completely unexplained — meaningful gaps for a generic request tool. The POST/PUT confirm requirement merely restates the schema's confirm description.

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 states a specific purpose — an escape hatch for documented MyFatoorah v2/v3 endpoints — and explicitly scopes it to endpoints 'not covered by another tool,' which differentiates it from the six sibling tools that cover specific payment/invoice/refund operations. The resource (MyFatoorah API endpoints) and scope (only uncovered endpoints) are unambiguous.

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 gives a clear selection criterion: use this tool only when a documented endpoint is not covered by another tool. This implies sibling tools should be preferred for their respective operations, though it does not name them explicitly or give a when-not-to-use example.

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

myfatoorah_create_paymentCreate MyFatoorah payment or invoice linkA

Creates a payment/invoice using POST /v3/payments. In a live environment this creates a real payable invoice. Omit paymentMethod to show all enabled methods; use notificationOption for invoicing. The returned PaymentURL is where the customer pays.

NameRequiredDescriptionDefault
amountYesPayment amount; must be greater than zero.
advancedNoAdditional documented v3 request fields. Explicit fields above take precedence.
currencyNoDisplay currency. Defaults to the account base currency.
customerNo
languageNo
suppliersNo
webhookUrlNoPer-payment webhook URL.
paymentExpiryNoUTC ISO-8601 expiration time.
paymentMethodNoApiName from myfatoorah_get_payment_methods; omit to show enabled methods.
idempotencyKeyNo
redirectionUrlNoCustomer return URL after payment.
userDefinedFieldsNo
externalIdentifierNo
notificationOptionNo
displayPaymentMethodsNo

Output Schema

NameRequiredDescription
responseYes

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already establish that this is not read-only and not idempotent; the description adds the crucial consequence that in live environments it creates a real payable invoice, and the PaymentURL is the customer-facing payment destination. This is exactly the kind of real-world context needed for a financial write operation, and there is no contradiction with annotations.

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?

Four short sentences, each contributes a distinct fact: endpoint, live consequence, key parameter behaviors, and result URL. No filler and purpose is front-loaded.

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 complex 15-parameter financial tool, the description supplies the essential operational context: live invoice risk, payment-method behavior, invoicing mode, and customer payment URL. The schema and output schema cover most parameter and return details, so the remaining gaps around idempotency and sandbox behavior are not fatal.

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 only 47%, so the description should compensate for under-documented parameters. It does add useful meaning for paymentMethod (omit to show enabled methods) and notificationOption (invoicing), but other fields like idempotencyKey, suppliers, and displayPaymentMethods receive no extra explanation, leaving gaps.

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?

Description opens with a specific verb ('Creates') and resource ('payment/invoice') plus the exact endpoint POST /v3/payments. It also states the key outcome ('real payable invoice' in live, PaymentURL for customer), which clearly distinguishes it from the get/refund sibling tools.

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?

It gives clear operational guidance: omit paymentMethod to surface all enabled methods, and use notificationOption for invoicing. The live-environment warning frames when the call has real financial effect, though it does not explicitly name sibling alternatives, so it stops short of a 5.

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

myfatoorah_create_refundCreate a MyFatoorah refundA
Destructive

Creates a real full or partial refund using POST /v3/refunds. This moves money in live environments. Call only after the user explicitly approves the exact PaymentId and amount; confirm must be true.

NameRequiredDescriptionDefault
amountYes
commentNo
confirmYesMust be true after explicit user approval.
paymentIdYes
idempotencyKeyNo
externalIdentifierNo
supplierRefundedAmountNo
serviceChargeOnCustomerNo

Output Schema

NameRequiredDescription
responseYes

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already mark destructiveHint=true/readOnlyHint=false, but the description adds non-redundant context: the refund is 'real', moves money in live environments, and requires explicit user approval of exact PaymentId and amount. No contradiction with annotations.

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?

Two tight sentences: the first states the action and risk, the second provides the mandatory approval guard. There is no filler or redundant restatement of schema content.

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?

Given the output schema and destructive annotations, the description covers the essentials: what it does, that it moves real money, and the safety precondition. It could additionally mention duplicate/retry behavior since idempotentHint=false, but for a refund creation call this is a minor gap.

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 only 13%, so the description must compensate. It adds meaning for the required parameters: 'full or partial' explains amount and 'confirm must be true' restates the approval gate. However, it does not help with the five optional parameters such as idempotencyKey, supplierRefundedAmount, or serviceChargeOnCustomer, so compensation is incomplete.

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?

States it creates a real full or partial refund via POST /v3/refunds, a specific verb+resource that is clearly distinct from create_payment and get_refund among siblings. 'Moves money in live environments' reinforces what operation this is.

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?

Gives an explicit call condition ('only after the user explicitly approves the exact PaymentId and amount; confirm must be true'), which tells an agent when it is safe to invoke a destructive refund. It does not name sibling alternatives such as get_refund for verification, so it lacks explicit exclusions or alternative routing.

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

myfatoorah_get_invoiceGet MyFatoorah invoiceA
Read-onlyIdempotent

Gets an invoice by exactly one lookup type. Invoice ID uses /v3/invoices/{value}; external identifier returns the most recent matching invoice and uses /v3/invoices/externalIdentifier/{value}.

NameRequiredDescriptionDefault
valueYesInvoice ID or merchant-provided external identifier.
lookupByYes

Output Schema

NameRequiredDescription
responseYes

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior. The description adds useful behavioral detail beyond that, particularly the exact endpoint routing and the fact that external identifier lookup returns the most recent matching invoice. No contradiction with annotations.

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?

Two sentences with no filler. The purpose is front-loaded, and each clause carries distinct information: the lookup constraint, the invoice-ID path, and the external-identifier path with its recency behavior.

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?

The tool has only two parameters, an output schema, and annotations covering safety and idempotence. The description provides the remaining necessary operational details, including endpoints and the semantics of external identifier lookups, so an agent has everything needed to call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 50%, with lookupBy having no description beyond its enum. The description compensates by mapping lookupBy values to specific endpoint paths and clarifying that externalIdentifier resolves to the most recent matching invoice, adding meaning beyond the schema.

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 states a specific action, 'Gets an invoice', and precisely defines the two lookup modes with endpoint paths. The resource (invoice) is clearly distinct from sibling tools that retrieve payments, refunds, or payment methods, so an agent can select it without ambiguity.

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 conveys when this tool is appropriate: when an invoice needs to be retrieved by exactly one lookup type. It does not explicitly name alternatives or exclusion conditions, but the sibling tools are organized by resource, making the intended context evident.

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

myfatoorah_get_paymentGet MyFatoorah payment detailsA
Read-onlyIdempotent

Gets authoritative payment details by PaymentId using GET /v3/payments/{paymentId}. Treat payment as successful only when Invoice.Status is PAID and Transaction.Status is SUCCESS.

NameRequiredDescriptionDefault
paymentIdYesPaymentId from a callback or payment response.

Output Schema

NameRequiredDescription
responseYes

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description adds valuable behavioral context beyond annotations: it is authoritative, uses a specific GET endpoint, and defines the exact success criteria (Invoice.Status = PAID and Transaction.Status = SUCCESS). No contradiction with annotations.

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?

Two concise sentences with no filler. The first sentence front-loads the action, resource, and endpoint, while the second delivers the critical success rule. Every sentence earns its place.

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?

The tool is simple with a single parameter, high schema coverage, rich annotations, and an output schema. The description covers the essential success logic and authoritative nature, making it complete enough for correct invocation. It could be slightly stronger with an explicit pointer to sibling tools, but this is not essential for a read-only getter.

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 paymentId documented as 'PaymentId from a callback or payment response.' The description mentions 'by PaymentId' but adds no additional semantic detail beyond what the schema provides, so it meets the baseline without exceeding it.

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?

Description states a specific verb ('Gets'), resource ('payment details'), and identifier ('PaymentId'), with a direct API endpoint. It is distinct from siblings by focusing on payment details, but it does not explicitly differentiate itself from myfatoorah_get_invoice, which could be confused for a closely related operation.

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 description implies usage: use this tool when you have a PaymentId and need authoritative payment details, especially to verify success. However, it gives no explicit guidance on when to prefer this over siblings like myfatoorah_get_invoice or myfatoorah_api_request, nor any exclusions.

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

myfatoorah_get_payment_methodsGet MyFatoorah payment methodsA
Read-onlyIdempotent

List payment methods enabled for this account. Read ApiName from the result and pass it as paymentMethod when creating a hosted payment.

NameRequiredDescriptionDefault

No parameters

Output Schema

NameRequiredDescription
responseYes

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, open-world, and non-destructive behavior. The description adds value by scoping results to the current account and by disclosing that the output contains an ApiName field that must be reused. This is useful behavioral context beyond what annotations provide.

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?

Two tight sentences with no filler. The first states the core action and scope; the second provides a concrete next step. Every word earns its place and the key information is front-loaded.

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 zero-parameter read-only listing tool with a full output schema and extensive annotations, the description covers the action, the account scoping, and the downstream usage of the result. Nothing critical is missing for an agent to call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has zero parameters, so the baseline is 4. The description does not need to explain parameter semantics, and the schema coverage is 100% by definition.

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: 'List payment methods enabled for this account.' This clearly distinguishes it from the create/get/refund siblings, and the second sentence explains how the result is used downstream.

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 gives clear contextual guidance: call this to discover payment methods, then read ApiName and pass it as paymentMethod when creating a hosted payment. It does not explicitly list exclusions or alternative tools, but the workflow context is sufficient given the sibling operations are quite different.

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

myfatoorah_get_refundGet MyFatoorah refund detailsA
Read-onlyIdempotent

Gets a refund by RefundId using GET /v3/refunds/{refundId}. Refund statuses include Refunded, Canceled, and Pending.

NameRequiredDescriptionDefault
refundIdYes

Output Schema

NameRequiredDescription
responseYes

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already convey read-only, idempotent, non-destructive behavior. The description adds meaningful context beyond those hints by naming the HTTP endpoint and listing possible refund statuses (Refunded, Canceled, Pending), which helps the agent interpret results. No contradiction with annotations.

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?

Two sentences with no filler: the first front-loads the action and endpoint, the second adds useful status context. Every word earns its place.

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?

The tool is a simple read operation, annotations cover safety, and an output schema exists so return-value documentation is unnecessary. The description is complete enough for correct invocation; only usage-vs-alternatives context is lightly missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate. It does so by identifying refundId as the RefundId used for lookup and tying it to the URL path. For a single, self-named parameter this is sufficient additional meaning beyond the raw schema.

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 states a specific verb ('Gets'), the resource (a refund), the lookup key (RefundId), and the exact endpoint (GET /v3/refunds/{refundId}). This clearly distinguishes it from sibling tools like myfatoorah_get_payment and myfatoorah_get_invoice.

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 description implies the tool is used when you have a RefundId and need refund details, but it does not explicitly discuss when to prefer this over sibling tools such as myfatoorah_get_payment, myfatoorah_get_invoice, or myfatoorah_create_refund. No exclusions or alternatives are named.

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

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 7 tool updatesv0.1.0
    • First observedmyfatoorah_api_request
    • First observedmyfatoorah_create_payment
    • First observedmyfatoorah_create_refund
    • First observedmyfatoorah_get_invoice
    • First observedmyfatoorah_get_payment
    • First observedmyfatoorah_get_payment_methods
    • First observedmyfatoorah_get_refund

TDQS

A4.2/5.0

Scored across 7 tools

Disambiguation5/5

Each core tool targets a distinct resource and action: payment methods, payments, invoices, and refunds are clearly separated. The api_request escape hatch is explicitly scoped to endpoints not covered by the other tools, so it complements rather than overlaps with them.

Naming Consistency4/5

Six tools consistently follow the myfatoorah_verb_noun pattern, which is predictable and readable. The only deviation is myfatoorah_api_request, a noun-style escape hatch, which is a minor exception rather than a systemic inconsistency.

Tool Count5/5

Seven tools is well-scoped for a payment-focused server: it covers payment methods, payment creation/retrieval, invoice retrieval, refund creation/retrieval, plus one generic escape hatch. Every tool earns its place, and the count is neither bloated nor too thin.

Completeness4/5

The set covers the core payment workflow: create payment, check payment status, retrieve invoice, create refund, and check refund status. It lacks explicit cancel/update/list operations, but the api_request escape hatch covers documented endpoints not individually modeled, so agents are not left with a hard dead end.

Maintenance

ActivityStale
ResponsivenessNo recent community issues

Related MCP Connectors

Related MCP Servers

  • A
    license
    Not graded
    quality
    A
    maintenance
    Enables AI agents to manage API keys and child keys with budgets and spending caps, set plans and model routing, handle wallet payments and top-ups, and verify signed receipts through MCP tools.
    265 npm
    2
    MIT
  • A
    license
    A
    quality
    B
    maintenance
    Enables AI agents to perform and manage payments through the Model Context Protocol, including paying, checking balances and history, registering bots, setting spending limits, discovering supported networks and tokens, inspecting commissions, and managing bot pools. It also supports governed tool calls with policy decisions, human approval, and tamper-evident audit traces.
    12
    7 npm
    Apache 2.0