stub

Save supplier

save_supplier

Create or update a supplier. Pass an id to update that supplier; omit id to create a new one. Returns the new supplier id on create. Updating an existing supplier with an opening date later than its own earliest bill or expense is refused, unwritten, with code confirm-required until the same call is repeated with confirm true. To create/update many at once, send an items array — one all-or-nothing transaction with a single ledger recompute; each item with an id updates, each without creates.

Input Schema

Name	Required	Description
`id`	No	Supplier id. Present → update that supplier; omit → create a new one.
`city`	No	City.
`name`	No	Display name / description of the supplier.
`email`	No	Supplier email address.
`items`	No	Vector of supplier objects to create/update in one all-or-nothing batch. Preferred over repeated calls. Each item with an id updates; each without creates.
`number`	No	Main telephone (landline) number of the supplier, beside the contact person's contactnumber. Trimmed; a blank value on update clears it.
`suburb`	No	Suburb or district.
`address`	No	Street address line 1.
`confirm`	No	PROD-1951: required only to save an opening date that is LATER than the supplier's own earliest bill or expense. Without it that one case is refused, unwritten, with code confirm-required plus earliesttransactiondate and transactionsbefore, so the caller can show what the date would exclude from the creditors balance and let the user override it.
`country`	No	Supplier country (ISO code or name).
`starred`	No	Whether this supplier is marked as a favourite.
`website`	No	Supplier website, e.g. www.example.co.za. Trimmed; a blank string clears it, null leaves it unchanged.
`address2`	No	Street address line 2.
`contacts`	No	The full list of contact people. It replaces the stored list: a person left out is removed. Leave the key out to keep the stored list; send [] to clear it.
`addresses`	No	The full list of addresses. It replaces the stored list: an address left out is removed. Leave the key out to keep the stored list; send [] to clear it.
`vatnumber`	No	VAT / tax registration number.
`postalcity`	No	Postal address city.
`postalcode`	No	Postal or ZIP code.
`contactname`	No	Name of the primary contact person.
`creditlimit`	No	Most the business means to owe this supplier, in base currency. It only warns: a bill over it still saves.
`openingdate`	No	Date the opening balance applies from (ISO 8601).
`contactemail`	No	Email of the primary contact person.
`postalsuburb`	No	Postal address suburb.
`contactnumber`	No	Phone number of the primary contact person.
`postaladdress`	No	Postal address line 1, e.g. a PO Box.
`openingbalance`	No	Opening balance amount carried for this supplier at openingdate.
`postaladdress2`	No	Postal address line 2.
`documentaddress`	No	Which address documents print: physical (default) or postal.
`clearcreditlimit`	No	When true, removes the stored supplier limit.
`postalpostalcode`	No	Postal address postal code.
`registrationnumber`	No	Business registration number.
`clearopeningbalance`	No	Reserved, mirrors update_bank_account: when true the opening-date confirmation below is not asked.

Schema Changelog

Changes observed during successful MCP inspections.

Changed4 schema fields changedNov 2, 2026

addedInput schema / properties / addresses

Added value: +{
+  "description": "The full list of addresses. It replaces the stored list: an address left out is removed. Leave the key out to keep the stored list; send [] to clear it.",
+  "items": {
+    "properties": {
+      "address": {
+        "type": "string"
+      },
+      "address2": {
+        "type": "string"
+      },
+      "city": {
+        "type": "string"
+      },
+      "country": {
+        "type": "string"
+      },
+      "id": {
+        "description": "The address id. Send it to keep and update that address; leave it out to add a new one.",
+        "type": "string"
+      },
+      "label": {
+        "description": "A name for the address, e.g. Head office.",
+        "type": "string"
+      },
+      "postalcode": {
+        "type": "string"
+      },
+      "showoninvoices": {
+        "description": "True on the ONE address that documents print. More than one is refused.",
+        "type": "boolean"
+      },
+      "suburb": {
+        "type": "string"
+      }
+    },
+    "required": [],
+    "type": "object"
+  },
+  "maxItems": 50,
+  "type": "array"
+}

addedInput schema / properties / contacts

Added value: +{
+  "description": "The full list of contact people. It replaces the stored list: a person left out is removed. Leave the key out to keep the stored list; send [] to clear it.",
+  "items": {
+    "properties": {
+      "email": {
+        "type": "string"
+      },
+      "id": {
+        "description": "The contact person id. Send it to keep and update that person; leave it out to add a new one.",
+        "type": "string"
+      },
+      "name": {
+        "type": "string"
+      },
+      "ondocuments": {
+        "description": "True to send documents to this person.",
+        "type": "boolean"
+      },
+      "phone": {
+        "type": "string"
+      },
+      "role": {
+        "type": "string"
+      }
+    },
+    "required": [],
+    "type": "object"
+  },
+  "maxItems": 50,
+  "type": "array"
+}

addedInput schema / properties / items / items / properties / addresses

Added value: +{
+  "description": "The full list of addresses. It replaces the stored list: an address left out is removed. Leave the key out to keep the stored list; send [] to clear it.",
+  "items": {
+    "properties": {
+      "address": {
+        "type": "string"
+      },
+      "address2": {
+        "type": "string"
+      },
+      "city": {
+        "type": "string"
+      },
+      "country": {
+        "type": "string"
+      },
+      "id": {
+        "description": "The address id. Send it to keep and update that address; leave it out to add a new one.",
+        "type": "string"
+      },
+      "label": {
+        "description": "A name for the address, e.g. Head office.",
+        "type": "string"
+      },
+      "postalcode": {
+        "type": "string"
+      },
+      "showoninvoices": {
+        "description": "True on the ONE address that documents print. More than one is refused.",
+        "type": "boolean"
+      },
+      "suburb": {
+        "type": "string"
+      }
+    },
+    "required": [],
+    "type": "object"
+  },
+  "maxItems": 50,
+  "type": "array"
+}

addedInput schema / properties / items / items / properties / contacts

Added value: +{
+  "description": "The full list of contact people. It replaces the stored list: a person left out is removed. Leave the key out to keep the stored list; send [] to clear it.",
+  "items": {
+    "properties": {
+      "email": {
+        "type": "string"
+      },
+      "id": {
+        "description": "The contact person id. Send it to keep and update that person; leave it out to add a new one.",
+        "type": "string"
+      },
+      "name": {
+        "type": "string"
+      },
+      "ondocuments": {
+        "description": "True to send documents to this person.",
+        "type": "boolean"
+      },
+      "phone": {
+        "type": "string"
+      },
+      "role": {
+        "type": "string"
+      }
+    },
+    "required": [],
+    "type": "object"
+  },
+  "maxItems": 50,
+  "type": "array"
+}

Changed4 schema fields changedOct 20, 2026

addedInput schema / properties / clearcreditlimit

Added value: +{
+  "description": "When true, removes the stored supplier limit.",
+  "type": "boolean"
+}

addedInput schema / properties / creditlimit

Added value: +{
+  "description": "Most the business means to owe this supplier, in base currency. It only warns: a bill over it still saves.",
+  "type": "number"
+}

addedInput schema / properties / items / items / properties / clearcreditlimit

Added value: +{
+  "description": "When true, removes the stored supplier limit.",
+  "type": "boolean"
+}

addedInput schema / properties / items / items / properties / creditlimit

Added value: +{
+  "description": "Most the business means to owe this supplier, in base currency. It only warns: a bill over it still saves.",
+  "type": "number"
+}

Changed4 schema fields changedOct 20, 2026

addedInput schema / properties / items / items / properties / number

Added value: +{
+  "description": "Main telephone (landline) number of the supplier, beside the contact person's contactnumber. Trimmed; a blank value on update clears it.",
+  "type": "string"
+}

addedInput schema / properties / items / items / properties / website

Added value: +{
+  "description": "Supplier website, e.g. www.example.co.za. Trimmed; a blank string clears it, null leaves it unchanged.",
+  "type": "string"
+}

addedInput schema / properties / number

Added value: +{
+  "description": "Main telephone (landline) number of the supplier, beside the contact person's contactnumber. Trimmed; a blank value on update clears it.",
+  "type": "string"
+}

addedInput schema / properties / website

Added value: +{
+  "description": "Supplier website, e.g. www.example.co.za. Trimmed; a blank string clears it, null leaves it unchanged.",
+  "type": "string"
+}

Changed12 schema fields changedOct 20, 2026

addedInput schema / properties / documentaddress

Added value: +{
+  "description": "Which address documents print: physical (default) or postal.",
+  "enum": [
+    "physical",
+    "postal"
+  ],
+  "type": "string"
+}

addedInput schema / properties / items / items / properties / documentaddress

Added value: +{
+  "description": "Which address documents print: physical (default) or postal.",
+  "enum": [
+    "physical",
+    "postal"
+  ],
+  "type": "string"
+}

addedInput schema / properties / items / items / properties / postaladdress

Added value: +{
+  "description": "Postal address line 1, e.g. a PO Box.",
+  "type": "string"
+}

addedInput schema / properties / items / items / properties / postaladdress2

Added value: +{
+  "description": "Postal address line 2.",
+  "type": "string"
+}

addedInput schema / properties / items / items / properties / postalcity

Added value: +{
+  "description": "Postal address city.",
+  "type": "string"
+}

addedInput schema / properties / items / items / properties / postalpostalcode

Added value: +{
+  "description": "Postal address postal code.",
+  "type": "string"
+}

addedInput schema / properties / items / items / properties / postalsuburb

Added value: +{
+  "description": "Postal address suburb.",
+  "type": "string"
+}

addedInput schema / properties / postaladdress

Added value: +{
+  "description": "Postal address line 1, e.g. a PO Box.",
+  "type": "string"
+}

addedInput schema / properties / postaladdress2

Added value: +{
+  "description": "Postal address line 2.",
+  "type": "string"
+}

addedInput schema / properties / postalcity

Added value: +{
+  "description": "Postal address city.",
+  "type": "string"
+}

addedInput schema / properties / postalpostalcode

Added value: +{
+  "description": "Postal address postal code.",
+  "type": "string"
+}

addedInput schema / properties / postalsuburb

Added value: +{
+  "description": "Postal address suburb.",
+  "type": "string"
+}

Changed2 schema fields changedSep 23, 2026

addedInput schema / properties / clearopeningbalance

Added value: +{
+  "description": "Reserved, mirrors update_bank_account: when true the opening-date confirmation below is not asked.",
+  "type": "boolean"
+}

addedInput schema / properties / confirm

Added value: +{
+  "description": "PROD-1951: required only to save an opening date that is LATER than the supplier's own earliest bill or expense. Without it that one case is refused, unwritten, with code confirm-required plus earliesttransactiondate and transactionsbefore, so the caller can show what the date would exclude from the creditors balance and let the user override it.",
+  "type": "boolean"
+}

First observedSep 7, 2026

TDQS

A4.1/5.0

Behavior5/5

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

The annotations only declare readOnlyHint=false and destructiveHint=false, but the description discloses real behavioral traits: the opening-date guard that refuses and leaves data unwritten with code confirm-required until `confirm` is true, the all-or-nothing batch transaction with a single ledger recompute, and the returned supplier id on create. This is context the annotations cannot supply.

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 tight sentences, front-loaded with the create/update rule, then the confirm-required exception, then the batch path. Every sentence carries a distinct decision-relevant fact with no filler.

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 32-parameter upsert tool with no output schema, the description covers the create/update split, the batch alternative, the one refusal path, and what is returned. The many optional clear-flag and nested list-replacement behaviors are left entirely to the schema, which is acceptable given 100% coverage but leaves a small 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 100%, so the baseline is 3. The description restates the `id` and `items` semantics already in the schema and adds only the confirm-retry sequencing and the create-time return id; it says nothing about the many clear*/list-replacement flags beyond what the schema documents.

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?

Opens with a specific verb+resource pair ('Create or update a supplier') and immediately clarifies the upsert semantics that separate it from delete_supplier, list_suppliers, and match_suppliers. It does not name any sibling tool, so the differentiation is implied rather than explicit.

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 a clear decision rule ('Pass an `id` to update; omit `id` to create') and states that the `items` array is 'Preferred over repeated calls'. Missing an explicit exclusion: it never says when a single call beats the batch form, or that delete_supplier is the removal path.

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

All stub tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?