Search Docs Chunks
Search Shopify developer documentation and return the most relevant chunks
search_docs_chunks
Searches Shopify's developer documentation through the embedded Shopify dev MCP server and returns the most relevant documentation chunks for your query. Use it to find the exact object, field, or mutation you need before drafting an Admin GraphQL operation — so your AI client works from Shopify's real docs instead of guessing.
Read-only — this searches Shopify's developer documentation and never touches your store. Unlike the offline learn_shopify_api and validate_graphql_codeblocks, it queries Shopify's live documentation service, so your search prompt is sent to Shopify. Call learn_shopify_api first and pass the conversationId it returns so the search shares the same API and version context.
Parameters
| Name | Type | Required | Description | Default |
|---|---|---|---|---|
prompt | string | Yes | The Shopify documentation search query. | — |
max_num_results | number | No | Maximum number of documentation results to return. | — |
api_name | string | No | Shopify API name to scope the search, for example admin. | — |
version | string | No | Shopify API version to scope to, YYYY-MM (e.g. 2026-04). Omit to use the current stable version. | — |
conversationId | string | No | Conversation id returned by learn_shopify_api. Omit and one is minted for you. | — |
Returns
- The most relevant documentation chunks for your
prompt— the reference text your client needs to build a valid operation.
Example prompts
Search the Shopify Admin docs for how to paginate orders with a cursorFind the Admin API mutation for adding tags to a customerWhat fields are available on the Product object in the Admin API?Notes
- Scope with
api_name(useadminfor CDP brand work) andversionto keep results aligned with the operation you plan to run throughshopify_admin_graphql. - Pass the
conversationIdfromlearn_shopify_apiso the search shares your loaded API context. - This is documentation search only — it returns reference text, not data from your store.