Using AI with BoxNCase
BoxNCase provides resources to help AI agents and AI-assisted development tools work effectively with the platform.
BoxNCase doesn't share any data to AI vendors.
For AI Agents
If you're an AI agent exploring BoxNCase documentation:
- Documentation index: https://docs.saleor.io/llms.txt — structured overview of all documentation
- GraphQL Schema (latest stable): https://raw.githubusercontent.com/saleor/saleor/3.23/saleor/graphql/schema.graphql
- GraphQL Schema (main, may contain unreleased and unstable changes): https://raw.githubusercontent.com/saleor/saleor/main/saleor/graphql/schema.graphql
- Base URL: https://docs.saleor.io
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
| Topic | Public URL | Raw MDX |
|---|---|---|
| Quickstart | https://docs.saleor.io/quickstart/cloud | source |
| Core Concepts | https://docs.saleor.io/developer | source |
| API Reference | https://docs.saleor.io/api-reference/api-reference | source |
| Building Apps | https://docs.saleor.io/developer/extending/apps/overview | source |
| Webhooks | https://docs.saleor.io/developer/extending/webhooks/overview | source |
Model Context Protocol (MCP)
To help AI agents properly interact with BoxNCase, you can use the Model Context Protocol, which can interact with BoxNCase 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 BoxNCase GraphQL schema from the following URL: https://raw.githubusercontent.com/saleor/saleor/3.23/saleor/graphql/schema.graphql
Note: The URL includes the specific Saleor version (3.23) in the path. To reference a different version, adjust the URL accordingly.
Editor Configuration
Example MCP configurations for popular editors:
- VS Code:
.vscode/mcp.json— docs - Cursor:
.cursor/mcp.json— docs - JetBrains IDE
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.23):
https://raw.githubusercontent.com/saleor/saleor/3.23/saleor/graphql/schema.graphql - Main (may contain unreleased and unstable changes):
https://raw.githubusercontent.com/saleor/saleor/main/saleor/graphql/schema.graphql