API Reference

All API responses are pre-rendered static JSON files, served at high speed from a CDN. No authentication required.

⚠️ API endpoints and response formats are not yet stable and may change without notice. Use with caution. ⚠️

REST API

GET /api/v1/matrix.json Example →

Returns the full matrix definition from matrix.yml — all products, versions, and supported service ranges.

GET /api/v1/results.json Example →

Returns all test results across every product, version, and combination.

GET /api/v1/health.json Example →

Returns build metadata — total results, last run timestamp, pass/fail counts.

GET /api/v1/[product]/versions.json Example →

Returns the list of tested versions for a product (magento or mageos).

GET /api/v1/[product]/[version].json Example →

Returns all test results for a specific product version, with per-step details.

GET /api/v1/software/[service]/[version].json Example →

Returns aggregated compatibility for a specific service version across all product versions.

MCP Server

An MCP (Model Context Protocol) server is available for AI coding agents such as GitHub Copilot and Claude. It wraps the REST API and provides 5 tools your agent can call.

get_magento_versions

List all known Magento or MageOS versions.

get_compatibility_matrix

Get the full matrix for a specific product version.

check_service_compatibility

Check if a specific service version works with a given product version.

get_magento_versions_for_service

Find all product versions compatible with a given service.

get_all_results

Dump all raw test results for further analysis.

// .vscode/mcp.json

{
  "servers": {
    "m2compat": {
      "type": "stdio",
      "command": "node",
      "args": ["./mcp-server/dist/index.js"],
      "env": {
        "SITE_BASE_URL": "https://m2compat.example.com"
      }
    }
  }
}