Skip to main content
Glama
theYahia

retailcrm-mcp

by theYahia

order_payment_edit

Edit an existing order payment's amount, status, or paid_at timestamp. Returns success.

Instructions

Edit an existing order payment (amount/status/paid_at). Returns {success}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
byNoLookup fieldid
idYesPayment ID (or externalId) to edit
siteNoSite (store) symbolic code. Required on create/edit when the API key is scoped to multiple sites (see list_sites).
amountNoUpdated amount
statusNoUpdated payment status code
paid_atNoUpdated paid timestamp 'YYYY-MM-DD HH:MM:SS'
Behavior2/5

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

Annotations already indicate readOnlyHint=false and destructiveHint=false. The description adds no extra behavioral context such as side effects, permissions, or reversibility. It only says 'Edit' and 'Returns {success}'.

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 description is one sentence, concise, and front-loaded with verb and resource. It could include a brief usage hint, but overall efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description only mentions 'Returns {success}' which is minimal. It does not specify whether the response includes the updated payment object or just a success flag. For a mutation tool, more detail on return value and error handling is needed.

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 each parameter already has a description. The description summarizes editable fields but adds no new 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 clearly states the verb 'Edit' and resource 'existing order payment', and lists editable fields (amount/status/paid_at). It distinguishes from sibling tools like order_payment_create and order_payment_delete.

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 when editing an existing payment but does not explicitly state when to use, when not to use, or compare with alternatives like update_order.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/theYahia/retailcrm-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server