Skip to main content

Using AI with Saleor

Saleor provides resources to help AI agents and AI-assisted development tools work effectively with the platform.

note

Saleor doesn't share any data to AI vendors.

For AI Agents​

If you're an AI agent exploring Saleor documentation:

URL Patterns​

Public documentation URLs follow this pattern:

https://docs.saleor.io/{path}

Raw MDX source files are available at:

https://raw.githubusercontent.com/saleor/saleor-docs/main/docs/{path}.mdx

Key Entry Points​

TopicPublic URLRaw MDX
Quickstarthttps://docs.saleor.io/quickstart/cloudsource
Core Conceptshttps://docs.saleor.io/developersource
API Referencehttps://docs.saleor.io/api-reference/api-referencesource
Building Appshttps://docs.saleor.io/developer/extending/apps/overviewsource
Webhookshttps://docs.saleor.io/developer/extending/webhooks/overviewsource

Model Context Protocol (MCP)​

To help AI agents properly interact with Saleor, you can use the Model Context Protocol, which can interact with Saleor by understanding the GraphQL schema.

To configure your compatible IDE / editor to use the MCP, you can use the following configuration:

{
"mcpServers": {
"mcp-saleor": {
"command": "npx",
"args": ["mcp-graphql"],
"env": {
"SCHEMA": "/path/to/local/schema.graphql"
}
}
}
}

You can download the full Saleor GraphQL schema from the following URL: https://raw.githubusercontent.com/saleor/saleor/3.22/saleor/graphql/schema.graphql

Note: The URL includes the specific Saleor version (3.22) in the path. To reference a different version, adjust the URL accordingly.

Editor Configuration​

Example MCP configurations for popular editors:

GraphQL Schema​

The GraphQL schema is the source of truth for all API operations. It includes:

  • Queries: Read operations (products, orders, users, etc.)
  • Mutations: Write operations (create, update, delete)
  • Subscriptions: Real-time events via webhooks
  • Types: All data structures and their fields

Schema URLs by version:

  • Latest stable (3.22): https://raw.githubusercontent.com/saleor/saleor/3.22/saleor/graphql/schema.graphql
  • Main (may contain unreleased and unstable changes): https://raw.githubusercontent.com/saleor/saleor/main/saleor/graphql/schema.graphql