shopify-dev

Search Shopify developer documentation across all APIs via search_docs.mjs.

Updated Nov 16, 2022
One-click install
npx skills add https://github.com/kos3nz/dotfiles --skill shopify-dev-kos3nz
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: shopify-dev
Source: https://github.com/kos3nz/dotfiles/tree/main/.config/agents/skills/shopify-dev
Command: npx skills add https://github.com/kos3nz/dotfiles --skill shopify-dev-kos3nz

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Locating authoritative Shopify developer documentation is hard when a user question touches multiple APIs, so this skill provides a centralized search across shopify.dev to surface relevant guidance.

Core Features & Use Cases

  • Cross-API search across shopify.dev to unify context for multi-API tasks.
  • Quick access to official API references, guides, and best practices to inform development decisions.
  • Use Case: When a user asks about integrating features that span Admin GraphQL, Liquid themes, and Checkout Extensions, retrieve the authoritative docs to guide implementation.

Quick Start

Run search_docs.mjs with a topic or feature name to retrieve the relevant Shopify developer documentation.

Frequently Asked Questions about shopify-dev

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I search Shopify developer documentation across multiple APIs?

To search Shopify developer documentation across multiple APIs, execute the search_docs.mjs script against the shopify.dev endpoint to retrieve unified context for questions spanning different APIs. It returns relevant raw or formatted documentation data directly into your context.

What is the best way to find official Shopify docs for Admin GraphQL and Liquid themes?

The best way to find official Shopify docs for Admin GraphQL and Liquid themes is to perform a cross-API search across shopify.dev. This surfaces authoritative references, guides, and best practices to inform your development decisions.

When do I need a cross-API search for Shopify development?

You need a cross-API search for Shopify development when a user question touches multiple APIs and no API-specific skill applies, such as queries spanning Admin GraphQL, Liquid themes, and Checkout Extensions simultaneously.

Can I retrieve official Shopify API references directly into my agent context?

Yes, you can retrieve official Shopify API references directly into your agent context. The skill executes a documentation search and returns the raw or formatted data for embedding directly into the active context window.

Does this Shopify documentation search work for Checkout Extensions?

Yes, this Shopify documentation search works for Checkout Extensions. It queries the centralized shopify.dev endpoint to surface relevant guidance when integrating features that span Checkout Extensions and other APIs.