introspect_graphql_schema

Extract relevant portions of the Shopify Admin API GraphQL schema based on user prompts, filtering by types, queries, or mutations. Use to identify schema elements for managing Shopify stores effectively.

Instructions

This tool introspects and returns the portion of the Shopify Admin API GraphQL schema relevant to the user prompt. Only use this for the Shopify Admin API, and not any other APIs like the Shopify Storefront API or the Shopify Functions API.

Input Schema

Name	Required	Description	Default
`api`	No	The API to introspect. Valid options are: - 'admin': The Admin API is the primary API for managing your Shopify store. It allows you to create and manage products, orders, customers, and more. Default is 'admin'.	admin
`conversationId`	Yes	🔗 REQUIRED: conversationId from learn_shopify_api tool. Call learn_shopify_api first if you don't have this.
`filter`	No	Filter results to show specific sections. Valid values are 'types', 'queries', 'mutations', or 'all' (default)
`query`	Yes	Search term to filter schema elements by name. Only pass simple terms like 'product', 'discountProduct', etc.
`version`	No	The version of the API to introspect. MUST be one of '2024-10' or '2025-01' or '2025-04' or '2025-07' or 'unstable'. Default is '2025-07'.	2025-07

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "api": {
      "default": "admin",
      "description": "The API to introspect. Valid options are:\n- 'admin': The Admin API is the primary API for managing your Shopify store. It allows you to create and manage products, orders, customers, and more.\nDefault is 'admin'.",
      "enum": [
        "admin"
      ],
      "type": "string"
    },
    "conversationId": {
      "description": "🔗 REQUIRED: conversationId from learn_shopify_api tool. Call learn_shopify_api first if you don't have this.",
      "type": "string"
    },
    "filter": {
      "default": [
        "all"
      ],
      "description": "Filter results to show specific sections. Valid values are 'types', 'queries', 'mutations', or 'all' (default)",
      "items": {
        "enum": [
          "all",
          "types",
          "queries",
          "mutations"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "query": {
      "description": "Search term to filter schema elements by name. Only pass simple terms like 'product', 'discountProduct', etc.",
      "type": "string"
    },
    "version": {
      "default": "2025-07",
      "description": "The version of the API to introspect. MUST be one of '2024-10' or '2025-01' or '2025-04' or '2025-07' or 'unstable'. Default is '2025-07'.",
      "enum": [
        "2024-10",
        "2025-01",
        "2025-04",
        "2025-07",
        "unstable"
      ],
      "type": "string"
    }
  },
  "required": [
    "conversationId",
    "query"
  ],
  "type": "object"
}

Shopify Dev MCP

introspect_graphql_schema

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from Shopify Dev MCP

Related Tools

MCP directory API