Skip to content
OpenStock
OpenStock

Get started

MCP serverConnect a client

Reference

ToolsSecurity
Dashboard
  1. MCP
  2. Reference

Tools

Every tool the server exposes and the scope each one needs.

Each tool calls one Store API endpoint with the same inputs, so the endpoint pages double as tool documentation. Tools whose scope the key lacks are not listed to the assistant at all.

Store#

ToolScopeWhat it does
get_storestore:readReturns the store the key belongs to, its storefront URL and currency, and the scopes on the key.

Products#

ToolScopeWhat it does
list_productsproducts:readLists products, newest first.
get_productproducts:readRetrieves one product.
create_productproducts:writeCreates a product in the key’s store.
update_productproducts:writeUpdates the fields you send and leaves the rest alone.
delete_productproducts:writePermanently deletes a product.
list_categoriesproducts:readLists product categories in display order.

Orders#

ToolScopeWhat it does
list_ordersorders:readLists orders, newest first, each with its line items.
get_orderorders:readRetrieves one order with its line items and the keys that were delivered.

Customers#

ToolScopeWhat it does
list_customerscustomers:readLists customers with their balance, lifetime spend and order count.
get_customercustomers:readRetrieves one customer.

Coupons#

ToolScopeWhat it does
list_couponscoupons:readLists coupons, newest first.
get_couponcoupons:readRetrieves one coupon, including how often it has been used.
create_couponcoupons:writeCreates a coupon.
update_couponcoupons:writeUpdates the fields you send.
delete_couponcoupons:writePermanently deletes a coupon.

Theme#

ToolScopeWhat it does
list_theme_filesthemes:readReturns every file in the theme’s draft project.
get_theme_filethemes:readReads one draft file.
write_theme_filesthemes:writeCreates or replaces draft files and deletes others in one request.
preview_themethemes:writeReturns a link that renders the current drafts with your store’s data and reloads itself when the drafts change.
publish_themethemes:writeBuilds the drafts on the server and makes them the live storefront.
list_theme_versionsthemes:readLists published versions, newest first, and which one is live.

Errors#

A failed tool call returns a normal result with isError: true and text such as permission_denied: API key does not have products:write permission, so the assistant can explain the problem or try something else.

Was this page helpful?

PreviousConnect a clientNextSecurity
© 2026 OpenStockTermsPrivacy