Ryde Developers
Español Dashboard ryde.us.com

Tool catalog

Every tool the Ryde MCP server exposes, with the scope and entitlement each requires.

API version v1 · View as Markdown

Generated from the operation registry, so a tool cannot appear here without a real operation behind it. "Confirmation" marks the tools that require a fresh quote the customer was shown, plus an idempotency key.

Tool Description Scope Ryde One Confirmation Status
get_membership_statusWhether this customer holds an active Ryde One membership. Call it before offering to transact, so the agent can explain the requirement rather than hit a 403 mid-sentence.profile.readNoNoBeta
search_restaurantsFind open restaurants, grocery stores and shops near a point.food.readNoNoBeta
get_restaurant_menuThe public catalogue for one merchant. Cost, stock, barcodes and supplier ids are the merchant's own business and are never returned here.food.readNoNoBeta
quote_food_orderPrice a basket exactly as checkout would: items, fees, taxes, any member discount, and the total. Returns the quote_id place_food_order requires.food.readNoNoBeta
place_food_orderPlace the order the customer confirmed, from a quote_id they were shown.food.orderRequiredRequiredBeta
get_food_orderLive state of one order, including courier progress. Deliberately NOT membership-gated: an order that exists stays trackable whatever happens to the membership.food.readNoNoBeta
list_food_ordersThe customer's own order history, newest first.food.readNoNoBeta
cancel_food_orderCancel an order, where its current state still allows it. Never membership-gated — getting OUT of a transaction must not require an entitlement.food.readNoNoBeta
search_ride_optionsThe vehicle tiers that can be requested, with each tier's base fare.rides.readNoNoBeta
quote_rideRoad distance, driving time and the final fare per vehicle tier, tax included. Returns the quote_id request_ride requires.rides.readNoNoBeta
request_rideRequest the ride the customer confirmed, from a quote_id they were shown.rides.requestRequiredRequiredBeta
get_rideLive state of one ride: dispatch progress, the assigned driver and vehicle, and the pickup ETA. Never membership-gated — a ride in progress stays trackable.rides.readNoNoBeta
list_ridesThe customer's own ride history, newest first.rides.readNoNoBeta
cancel_rideCancel a ride that has not started. Never membership-gated, for the same reason as cancelling an order.rides.readNoNoBeta
quote_deliveryPrice a courier run between two points. Runs the same pricing path the request does, so the quote is the charge.delivery.readNoNoBeta
request_deliveryDispatch a courier to move a package, from a quote_id the customer was shown.delivery.requestRequiredRequiredBeta
get_deliveryLive state of one delivery, including courier progress and proof of delivery once collected.delivery.readNoNoBeta
check_coverageAsk whether Ryde delivers to a postcode or a point, and at which service levels.coverage.readNoNoBeta
quote_ratesPrice one parcel to one address from your contracted rate card, per service level. Creates nothing.coverage.readNoNoBeta
create_shipmentHand Ryde one parcel to deliver. Returns its Ryde tracking number.shipments.createNoNoBeta
create_shipments_batchHand Ryde a manifest of up to 500 parcels in one request. Every row reports created, duplicate or rejected with a reason.shipments.createNoNoBeta
get_shipmentThe current state of one parcel, with its scan history and proof of delivery once delivered.shipments.readNoNoBeta
list_shipmentsYour parcels, newest first, filterable by status and date.shipments.readNoNoBeta
cancel_shipmentCancel a parcel you have given Ryde, at any point before it is delivered or returned.shipments.manageNoNoBeta
list_shipment_eventsEvery recorded event for one parcel, oldest first: where it was scanned, when, and why an attempt failed.shipments.readNoNoBeta
list_hubsThe depots your parcels are collected from.coverage.readNoNoBeta
search_service_providersFind providers who travel to the customer, with their live availability. Availability is derived per request and is never cached by the client.services.readNoNoBeta
get_provider_availabilityOpen appointment slots on a date, for a job of a given duration. A long job is only offered a start whose consecutive slots are all free.services.readNoNoBeta
quote_servicePrice a service booking before committing to a slot.services.readNoNoBeta
book_serviceBook a provider, optionally into a specific slot. Slot contention is settled by the platform: a losing booking is refused, never double-booked.services.bookRequiredRequiredBeta
get_service_bookingLive state of one booking, through arrival, start and completion.services.readNoNoBeta
list_task_typesThe task types this market can actually execute, with the evidence each one collects. Only types Ryde can staff are listed.tasks.readNoNoBeta
quote_taskPrice a task and confirm a qualified provider could be found for it before committing.tasks.readNoNoBeta
create_taskDispatch real-world work with structured requirements and evidence rules.tasks.createRequiredRequiredBeta
get_taskTask state, the assigned provider, and the evidence collected so far.tasks.readNoNoBeta
get_task_evidenceThe evidence collected against a task: photos with their content hashes, capture GPS and device timestamps, and any checklist answers.tasks.readNoNoBeta
cancel_taskCancel a task that has not started.tasks.readNoNoBeta
list_business_ordersList the store's orders, newest first. Filter by status or fulfillment, or ask only for active work.orders.readNoNoBeta
get_business_orderRead one of the store's orders in full, including its line items and status history.orders.readNoNoBeta
accept_business_orderAccept an incoming order. Refused with 402 if a card or wallet order has not been paid yet.orders.manageNoNoBeta
reject_business_orderReject an order. A paid order is refunded to the customer's Ryde wallet — or, when the store collected it on its own Stripe account, to the customer's card by the store — and any booked slot is released.orders.manageNoNoBeta
start_business_order_prepMark an accepted order as being prepared, so the customer's tracking reflects the kitchen.orders.manageNoNoBeta
mark_business_order_readyMark an order ready for collection. For a delivery order this is what dispatches a Ryde courier.orders.manageNoNoBeta
complete_business_orderComplete a pickup or dine-in order. Refused with 409 while a table check is still open.orders.manageNoNoBeta
list_catalog_itemsList the store's catalogue items with their prices, modifiers and availability.menu.readNoNoBeta
get_catalog_itemRead one catalogue item by its id: price, SKU, barcode, tax treatment, stock and availability.menu.readNoNoBeta
create_catalog_itemCreate a catalogue item. It appears immediately in the store's POS and on its Ryde storefront.menu.manageNoNoBeta
update_catalog_itemUpdate a catalogue item's name, description, price, category or modifier groups.menu.manageNoNoBeta
upsert_catalog_item_by_skuCreate or update the catalogue item with this SKU. The SKU is unique within the store, so the same call is safe to repeat.menu.manageNoNoBeta
set_catalog_item_availabilityTake an item off sale or put it back on, without deleting it. The reversible way to 86 something.menu.manageNoNoBeta
delete_catalog_itemRemove a catalogue item. There is no undo through the API — to take something off sale temporarily, set its availability instead.menu.manageNoNoBeta
import_catalog_itemsAdd many catalogue items at once, with their categories. Duplicate-safe: an item matched by SKU or barcode is updated (price and description) instead of added twice, a name-only match is skipped unless decided, and mode "replace" retires items missing from the list once confirm_retire equals the count a 409 names.menu.manageNoNoBeta
export_catalogExport the store's sellable catalogue as rows in the fixed template's columns (name, SKU, barcode, category, type, price, tax, cost, stock, warehouse, description). Cost, stock and barcode are filled only for a token with menu.manage.menu.readNoNoBeta
get_catalog_templateThe template's columns, the values each accepts, an example row, the row limit and the import modes.menu.readNoNoBeta
preview_catalog_importCheck rows in the template's columns against the catalogue WITHOUT writing: what is new, updated, unchanged, a possible duplicate or an error, per row. Answers a token for the commit.menu.manageNoNoBeta
commit_catalog_importApply a previewed import by its token, in mode merge, add_only or replace. Committing the same token again answers the first result and writes nothing.menu.manageNoNoBeta