Implementing NLWeb on Shopify

Open project for natural-language website interfaces and agent discoverability. This guide is specific to Shopify teams shipping production integrations.

Back to NLWeb Back to protocol collection

Why this implementation exists

NLWeb helps publishers expose schema-backed site knowledge through natural language interfaces and MCP-compatible access patterns.

Build protocol adapters in your app backend and treat Shopify APIs as authoritative state, with GraphQL-first integrations.

Protocol-specific implementation focus

Normalize content into schema-rich sources (Schema.org, RSS, JSON feeds).
Build retrieval and answer layers with provenance and attribution.
Expose safe query surfaces while keeping privileged actions behind policy checks.

Shopify technical foundation

GraphQL Admin API as primary integration surface (REST Admin is legacy for new public apps).
OAuth/token exchange for authenticated app sessions and scoped access.
Strict scope minimization (`read_*`, `write_*`) for every protocol capability.
Queue-based workers for long-running tasks and resilient retries.

Step-by-step production rollout

Scope the target journey. Pick one high-value flow where NLWeb adds deterministic value and define success metrics (latency, completion rate, human override rate).
Build a protocol adapter service. Keep NLWeb logic in a dedicated adapter layer, separate from CMS templates and page rendering concerns.
Map protocol contracts to Shopify primitives. Define read/write boundaries and strict schemas before implementation starts.
Add authentication and policy gates. Enforce least-privilege tokens, role checks, and explicit approval points for sensitive operations.
Implement idempotency + retries. Make long-running operations safe for replay, and include request IDs for traceability.
Instrument observability. Log capability calls, validation failures, latency, and user escalations with protocol-level correlation IDs.
Run conformance + integration tests. Validate schema contracts, permission boundaries, and rollback behavior before production.
Roll out progressively. Start with read-only capability exposure, then enable controlled writes, then full orchestration.

Security and governance controls

Use environment-scoped secrets and rotate credentials for Shopify integrations on a fixed cadence.
Treat protocol payloads as untrusted input; validate all schemas before execution.
Record human approvals and denied operations for post-incident audits.
Apply explicit write allowlists for NLWeb actions that mutate Shopify content or commerce state.
NLWeb deployments should be treated as AI product surfaces with retrieval quality checks, source provenance, and safety evaluation loops.

Validation checklist

GraphQL mutation/query contract tests with mocked throttle scenarios.
OAuth callback verification tests (HMAC/state checks).
End-to-end checkout/order flow tests in a development store.

Common failure modes and mitigations

Using legacy REST paths for new app capabilities that require GraphQL-only features.
Over-scoped access tokens exposing unnecessary merchant operations.
Ignoring cost-based throttling and running into hard request limits.