VYG Docs
Tools

Shopify tools

Query your connected Shopify store, and the developer tools for Shopify API documentation.

The Shopify tools let an assistant read your connected Shopify store and make supported changes when you have write access. They use the same connection as every other VYG tool; there is nothing extra to connect.

ToolWhat it doesReads or changesListed
read_shopifyRead Shopify data. Read orders, customers, products and live inventory from your connected Shopify store.Reads onlyYes, for every connection
mutate_shopifyChange Shopify data. Run an approved mutation against your connected Shopify store.Makes changesYes, for every connection
learn_shopify_apiLoad Shopify API docs. Read Shopify API documentation before writing a query.Reads onlyDeveloper only (?tools=developer)
search_shopify_docsSearch Shopify docs. Search Shopify developer documentation.Reads onlyDeveloper only (?tools=developer)
validate_shopify_graphqlCheck a Shopify GraphQL query. Check a GraphQL query against Shopify’s API schema.Reads onlyDeveloper only (?tools=developer)

read_shopify and mutate_shopify

read_shopify runs a Shopify Admin GraphQL query on your connected store. mutate_shopify handles mutations separately and requires approval before making a change.

  • Queries retrieve orders, products, customers and inventory from your connected store.
  • Mutations are off by default. A mutation runs only for a brand that has Shopify writes enabled and a person signed in with the shopify:admin scope. Without that, it is refused and reads keep working. Ask your VYG account team to enable writes.
  • Subscriptions (GraphQL subscription operations) are always refused.
  • Every operation is checked against the Admin API schema before anything is sent to Shopify, so invalid fields can be corrected before running the operation.
  • A large result is cut off with a [TRUNCATED] marker. Narrow the query or page through the results.
  • Shopify rate limiting comes back as an error with a wait time. A missing Shopify permission names the scope to add to the connection.

Example questions:

Show me the 10 most recent orders in my store with their totals and status.
How many products have fewer than 5 units in stock?

Developer tools

learn_shopify_api, search_shopify_docs and validate_shopify_graphql help someone writing Shopify GraphQL: they load and search Shopify's developer documentation and check a query against Shopify's schemas. None of them touch your store.

To show these tools in your client, add ?tools=developer to the URL or send the header x-vyg-mcp-tools: developer:

claude mcp add --transport http vyg-dev "https://api.vyg.app/mcp?tools=developer"

A typical developer session: load the Admin API context with learn_shopify_api, find the right fields with search_shopify_docs, check the draft with validate_shopify_graphql, then run it with read_shopify.

Requirements

  • A Shopify store connected to your brand in VYG. Without it, read_shopify says the store is not connected. The developer tools work without a store.
  • A sign-in. No API key can call the Shopify tools.

On this page