Skip to main content

Using AI with BoxNCase

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

note

BoxNCase doesn't share any data to AI vendors.

For AI Agents​

If you're an AI agent exploring BoxNCase documentation:

URL Patterns​

Public documentation URLs follow this pattern:

https://docs.boxncase.com/{path}

Raw MDX source files are available at:

Illustrative pseudocode: bracketed placeholders must be supplied by your installed integration; they are not literal package names or API identifiers. Use the runtime integration contract.

[INTEGRATION_REFERENCE_URL]

Key Entry Points​

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

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:

Illustrative pseudocode: bracketed placeholders must be supplied by your installed integration; they are not literal package names or API identifiers. Use the runtime integration contract.

{
"mcpServers": {
"[INTEGRATION_IDENTIFIER]": {
"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://support.boxncase.com/contact

Note: The URL includes the specific BoxNCase version (3.23) 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.23): the integration identifier
  • Main (may contain unreleased and unstable changes): the integration identifier