shopagent 1.0.1

Codegen Shopify agents in Ruby

shopagent

Generate a Shopify agent on the fly thanks to Llama and LSD.

Contents

• Getting started
  • One liner
  • From python package
    • Generate agent
    • Print data
    • Get data
  • From source
• Why
• Why only the admin API?
• Gimme the data
  • Pretty printing the data
  • Getting the data yourself
• Help me vibe code this
• Mining Shopify GraphQL yourself
• Mining
• LSD Cache

Getting started

One liner

This assumes you have uv installed as well as Ollama and the shopify_api.json file in your working directory.

Replace the {request} in the below snippet for a one-liner to generate a Shopify agent

$ echo 'from shopagent import generate_agent;generate_agent("{request}")' | uv run --with shopagent -

For example:

$ echo 'from shopagent import generate_agent;generate_agent("Cancel an order")' | uv run --with shopagent -

From python package

1. Download the shopify_api.json file to your working directory.

2. Install the python package

$ uv add shopagent

3. Download the shopify_api.json file to your local working directory

4. Import and run the method you're interested in

Generate agent

from shopagent import generate_agent

request = "Cancel an order"
generate_agent(request)

Generate agent from terminal input

from shopagent import gen_agent

gen_agent()

Print data

from shopagent import print_data

print_data()

Get data

from shopagent import get_data

get_data()

From source

1. Clone the repo

$ git clone https://github.com/lsd-so/shopagent.git

2. Run uv run main.py

$ uv run main.py

3. Answer prompt

What would you like your agent to do? <your reply here>

4. Now you have an agent.rb file

Why

Gumroad recently went open source to support AI writing Ruby code. In order to assist the initiative towards a more AI-infused world, we gathered the Shopify GraphQL spec plus code examples to make it easy to generate Shopify agents.

Why only the admin API?

The official Shopify MCP server explicitly prompts to not interact with the storefront or functions APIs. If there is a specific dataset you're interested in that wouldn't bother Shopify, then feel free to file an issue.

Gimme the data

If you're interested in the Shopify GraphQL being programmatically accessible, the two files you'd be most interested in are:

• api/models.py -> Where the Pydantic models for the derived GraphQL operations are defined
• shopify_api.json -> Where the Shopify GraphQL spec can be viewed as a JSON with code examples included.
  • This is structured as a ShopifyAPI object
  • For an example of working from the already obtained data, see get_data in main.py

Pretty printing the data

1. Clone this repository.

$ git clone https://github.com/lsd-so/shopagent.git

2. Update the main.py file file to print_data() instead of gen_agent()

def main():
    # get_data()
-     gen_agent()
+    # gen_agent()
-    # print_data()
+    print_data()

3. Using uv (Why?), run the main.py file at the root of the project.

$ uv run main.py

Getting the data yourself

If you'd like to get the data yourself or update to match a new version of the Shopify API, then continue reading to learn how.

Help me vibe code this

LLMs are already familiar with GraphQL so this gives them the ability to understand Shopify's GraphQL specifically.

1. Download the JSON file and Python models
2. Place both the JSON file and Python file in your repo
   1. Make sure you are using the models/api.py file!
3. Go to Cursor, click "New chat", click "Add context", click "Files & folders", and add both files to your context
4. Vibe code with Cursor now understanding how to use the Shopify GraphQL API
   1. If something doesn't work, try checking the option for longer context

Mining Shopify GraphQL yourself

1. Set the LSD_USER and LSD_API_KEY environment variables using your authenticated credentials.

$ export LSD_USER='[e-mail]'
$ export LSD_API_KEY='<api key from profile>'

2. Clone this repository.

$ git clone https://github.com/lsd-so/shopagent.git

3. And update the main.py file file to get_data() instead of gen_agent()

def main():
-    # get_data()
+     get_data()
-     gen_agent()
+    # gen_agent()
    # print_data()

4. Use uv.

$ uv run main.py

And there ya go.

LSD Cache

When running this python project, it involves querying the same page more than once for different groups of elements (such as in here or here). To prevent overloading Shopify's servers, pages in distinct states (whether statically off a public URL or following a sequence of deterministic interactions) are specifically cached for up to 15 minutes on LSD for scenarios like this.

Think of LSD as a language with caching that provides a more developer friendly Wayback machine. Follow us on Twitter to stay tuned!