Skip to content
littleworksdocs

Explore the documentation

Meet LittleworksA little backend for what you’re building on Shopify.Littleworks or your own appWhat it takes to give a Shopify feature a backend: with Littleworks, or with a custom app you build and run yourself.Connect to LittleworksChoose the CLI, a plugin, or a remote MCP connection.CLIConnect from your terminal with Shopify approval and no manual tokens.Claude pluginThe Littleworks MCP connection and agent guidance in one package.OpenAI pluginThe Littleworks MCP connection and agent guidance in one package.MCP with OAuthConnect a compatible client directly, without a marketplace plugin.Build with an agentThe operating guide for agents building on Shopify with Littleworks.Write a workA JavaScript handler, a small manifest, and a version you test and then publish.Keep secretsEncrypted credentials, shared across your store’s works.Call external servicesMake public HTTPS API requests from a work using http.fetch().Store dataDocument collections with a small API, scoped automatically to the work that uses them.Call ShopifyCall Shopify’s Admin and Storefront GraphQL APIs with credentials held by Littleworks.Store filesKeep uploads such as artwork and photos in the merchant’s Shopify Files, uploaded by the browser straight to Shopify.Expose an endpointConnect an existing frontend to a work through a small JSON API.Customer access and invitationsRequire a signed-in shopper or a narrow, expiring invitation before a work runs.RecipesUseful things to build for your store, with the backend already taken care of.Product reviewsCollect customer reviews, verify purchases, and publish approved content directly into your Shopify theme.Customer wishlistsGive signed-in customers a persistent list of products they can revisit across devices.Customer quote requestsCollect a customer’s products, quantities, and requirements without turning a request into an order.Back-in-stock alertsCollect confirmed signups on sold-out variants, email them through your own provider when stock returns, and see every signup and send in your admin.Transactional emailSend email from your works through your own provider, never twice for the same thing, and see what was sent and what failed.Build a merchant pageDescribe your records and what merchants do with them; Littleworks renders a native Shopify admin page.Run works on their ownRun a work when something happens in the store, on a schedule, or from a Shopify Flow workflow.Run background jobsQueue runs for later or in the background: fan out to thousands of customers, import in pages, follow up days later, and retry what fails.MCP tool referenceTools to inspect, deploy, run, and organize the backend for a connected store.Usage and allowancesSee what your works use, how much capacity remains, and when allowances reset.Inspect and troubleshootFind the relevant run, understand the failure, and make the next change deliberately.Limits and securityThe current runtime boundaries, data isolation model, and execution allowances.
Shopify admin
Browse documentation
Start here
Markdown

Connect to Littleworks

Choose the CLI, a plugin, or a remote MCP connection.

Choose your connection

ConnectionUse it forSetup
CLITerminal workflows, local bundling, and coding agents.Install the CLI and sign in.
Claude pluginLittleworks tools and guidance in Claude.Follow the Claude connection guide.
OpenAI pluginLittleworks tools and guidance for ChatGPT, Work, and Codex.Follow the guide for your OpenAI client.
MCP with OAuthA fallback for clients that support remote MCP.Add the server URL and authorize your store.

One server address

Remote MCP server
https://littleworks.app/mcp

Every new connection uses the same address. During OAuth, enter your store’s myshopify.com domain, sign in to Shopify if needed, and approve the connection inside Littleworks. Each connection authorizes one store. It does not grant access to your other stores.

Finish connecting

Return to your client after approval. Littleworks detects a successful connection automatically; no special chat prompt is required. If the Works page shows Finish setup, select it. If your client needs a restart or a new session, follow its instructions.

You can connect before you start building. Works appear whenever you ask your agent to build and deploy something. You can optionally share the agent introduction.

Build something for your store

When you have a build in mind, choose a recipe or describe it to your agent. Include the customer experience and how you want to manage it. For reviews or quote requests, ask for a merchant view so you can take actions inside Littleworks.

If the build needs more Shopify access, your agent will explain which permissions it needs and why. Open Littleworks → Works → Permissions, expand the named group, and approve only the requested access. Return to your agent and ask it to check again. This is separate from connecting the agent.

Review and publish

  1. Ask your agent for direct links to the draft view and any preview URL or unpublished theme, plus a short list of things to try. Check a successful action and a failed or unavailable state before publishing.
  2. Open the draft in Views and choose Publish when it is ready. Publishing a view also publishes the works it uses, so the published page runs the same versions as the draft. It does not publish your Shopify theme.
  3. For customer-facing builds, ask your agent to publish the works and point the theme at their real URLs, then review and publish the theme separately in Shopify.
  4. Testing uses your real store: Shopify changes made while testing affect the store, and records created by test runs are marked as test records until your agent or Data → Delete test records removes them.

Find your build afterward

WhereWhat you can do
ViewsOpen published screens to review submissions, manage requests, and take the actions your agent built.
WorksFind backend code, filter by status or Data group, inspect versions, and publish, pause or roll back a work.
DataInspect stored documents. Records created by test runs are marked, and Delete test records removes them.
RunsSee what ran and open its logs or error details.
Works → UsageCheck runs, stored documents, and available capacity.
Agent accessConnect or disconnect agents; deployed works keep running after disconnection.

Manage access

Open Agent access in Littleworks to inspect or disconnect a connection. Disconnecting stops its future requests; deployed works continue running. Pause a work separately when execution should stop.

For another store, create a separate connection where the client supports it, or disconnect and authorize the intended store. Check the store returned by get_context before making changes.