Well

by io.github.WellApp-ai

Overview Discussions Admin

Delete supplier payment term

well_delete_supplier_payment_term

Destructive

Retire the active payment terms of a supplier in the current workspace. The row is kept for provenance.

REQUIRED: supplier_payment_terms_id.

Returns { success: true } on success, or { success: false, error } on failure.

A supplier's payment terms.

Input Schema

Name	Required	Description
`workspace_id`	No	Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several — a write lands in exactly one workspace and this call would not say which.
`conversation_id`	No	The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation.
`idempotency_key`	No	Optional client-supplied key. A retried write with the same key returns the original result instead of re-applying the operation.
`workspace_scope`	No	Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace.
`supplier_payment_terms_id`	Yes	The id of the supplier payment terms to retire.

Output Schema

Name	Required	Description
`code`	No
`error`	No
`success`	Yes
`reply_lines`	No
`conversation_id`	No	The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation.
`near_candidates`	No
`newly_connected`	No	Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later.
`conversation_id_note`	No	Present only when the server opened a fresh lane, stating that no choice recorded earlier was read.
`conversation_id_source`	No	Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened.
`near_candidates_truncated`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed4 schema fields changedOct 28, 2026

addedOutput schema / properties / code
```
Added value: +{
+  "type": "string"
+}
```

addedOutput schema / properties / near_candidates

Added value: +{
+  "items": {
+    "additionalProperties": false,
+    "properties": {
+      "company_id": {
+        "type": "string"
+      },
+      "name": {
+        "type": "string"
+      }
+    },
+    "required": [
+      "company_id",
+      "name"
+    ],
+    "type": "object"
+  },
+  "type": "array"
+}

addedOutput schema / properties / near_candidates_truncated
```
Added value: +{
+  "type": "boolean"
+}
```

addedOutput schema / properties / reply_lines

Added value: +{
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}

AddedOct 20, 2026

TDQS

A3.7/5.0

Behavior4/5

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

Annotations already flag destructiveHint=true, so the important addition is 'The row is kept for provenance' — it tells the agent this is a soft delete and the record remains queryable, which the annotations cannot express. The response shape ({ success, error }) is also disclosed. It does not mention permission requirements or whether other records referencing the term are affected.

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 behavioral facts are front-loaded in the first two sentences and the required-parameter and return-value notes follow logically. The trailing fragment 'A supplier's payment terms.' is a dangling, redundant non-sequitur that costs a little clarity.

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 single-record mutation, the description covers the soft-delete semantics and the failure surface, and an output schema exists so return values need not be expanded further. Only the permission/authorization context and downstream effects of retiring terms are unaddressed.

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 all five parameters are already documented, including workspace disambiguation and idempotency. The description's 'REQUIRED: supplier_payment_terms_id' merely restates the schema's required list and adds no semantics beyond it; baseline 3 applies.

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?

A specific verb ('Retire') plus a precise resource ('the active payment terms of a supplier'), which an agent can distinguish from the sibling well_update_supplier_payment_term and well_create_supplier_payment_term. It stops short of naming those siblings explicitly.

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 word 'Retire' and the note that the row persists imply this is the soft-delete path rather than an edit, but the description never states when to choose this over well_update_supplier_payment_term (e.g., to deactivate rather than correct terms). With ~150 siblings in an obviously CRUD-heavy family, the guidance is only implied.

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

All Well 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?