Skip to main content
Glama
Pletopay MCP Server

Pletopay MCP Server

Official
by pletopay

Create a split rule

create_split_rule
Destructive

Creates a split rule that shares each payment's net amount with one or more subaccounts, leaving the remainder in your balance.

Instructions

Create a split rule.

Create a split rule that shares each payment’s net amount (after fees) with one or more subaccounts. The rest stays in your balance.

percentage shares are basis points (2500 = 25%); flat shares are kobo, capped at the net amount. Pass the rule id as split when you create a payment, checkout session, payment link, invoice or subscription. The split is frozen on each payment when it is created.

In live mode this sends real money or changes where money is paid, and it cannot be undone. Before calling, confirm the exact amount (in kobo) and the destination with the user.

Input Schema

NameRequiredDescriptionDefault
nameYes
typeYes
metadataNo
allocationsYes
idempotency_keyNoOptional. A unique key for this request; retrying with the same key returns the original result instead of acting twice. One is generated if omitted.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true and readOnlyHint=false, but the description goes well beyond them by explaining that live mode moves real money, that the action cannot be undone, and that the split is frozen onto each payment at creation time. That freezing rule is non-obvious behavioral context an agent could not infer from the schema or annotations.

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 safety warning is front-loaded in the final sentence and every sentence carries information. Minor waste: the opening line "Create a split rule" duplicates the title, and the second sentence restarts with the same phrase rather than continuing the thought.

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 destructive, nested-parameter mutation tool with no output schema, the description covers the economics, the units, the downstream wiring, and the safety requirement. It stops short of saying what the call returns (the new rule id, presumably) or what constraints apply to `name`, which matters given there's no output schema to fall back on.

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?

With schema description coverage at only 20%, the description carries real weight and delivers the important part: that `percentage` shares are basis points (2500 = 25%), that `flat` shares are in kobo, and that flat shares are capped at the net amount. It does not explain `name` or `metadata`, and it never mentions `idempotency_key`, so the less obvious parameters are left to 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?

States a specific verb and resource ("Create a split rule") and immediately defines the resource's semantics: it shares each payment's net amount after fees with subaccounts while the remainder stays in the creator's balance. The create verb also separates it cleanly from the list/get/update split-rule siblings in the tool list.

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 concrete downstream usage: pass the rule id as `split` when creating a payment, checkout session, payment link, invoice or subscription, and it warns to confirm amount and destination with the user before calling in live mode. What's missing is explicit guidance on when to use `update_split_rule` instead of creating a new rule, or whether multiple rules may coexist.

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