OpenAPI security summary

Resolve authentication requirements across an OpenAPI 3.x or Swagger 2.x document. Send POST /api/openapi-security-summary with the required field spec and pay $0.001 per call over x402 or MPP, or call it free by solving a proof-of-work challenge. It returns a JSON object with schemes, globalSecurity, operations and summary.

Returns the catalog of security schemes (`components.securitySchemes` in OpenAPI 3, `securityDefinitions` in Swagger 2) verbatim, the document-level default, and the *effective* security for each operation after layering. Honors the OpenAPI rule that `security: []` on an operation overrides the global default with "explicitly open" rather than inheriting it - so an agent sees `open: true` for that op and won't try to attach a token. Includes a `schemeUsage` count so callers know which scheme is actually needed. Operations are sorted `METHOD /path` for deterministic output. Pure CPU - deterministic, no network.

Category: Data conversion · Tags: openapi swagger security auth api

TRY IN PLAYGROUND →

Parameters

Example request

curl -i -X POST https://agent402.tools/api/openapi-security-summary \
  -H "Content-Type: application/json" \
  -d '{"spec":{"openapi":"3.0.0","info":{"title":"Demo","version":"1.0.0"},"security":[{"bearerAuth":[]}],"paths":{"/users":{"get":{"responses":{"200":{}}}},"/public":{"get":{"security":[],"responses":{"200":{}}}},"/admin":{"post":{"security":[{"bearerAuth":["admin"]}],"responses":{"201":{}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}}}'

Without payment this returns HTTP 402 Payment Required with the exact price for openapi-security-summary; any x402 v2 or MPP client pays it and retries.

Example response

{
  "schemes": {
    "bearerAuth": {
      "type": "http",
      "scheme": "bearer"
    }
  },
  "globalSecurity": [
    {
      "bearerAuth": []
    }
  ],
  "operations": [
    {
      "method": "GET",
      "path": "/public",
      "security": [],
      "open": true
    },
    {
      "method": "GET",
      "path": "/users",
      "security": [
        {
          "bearerAuth": []
        }
      ],
      "open": false
    },
    {
      "method": "POST",
      "path": "/admin",
      "security": [
        {
          "bearerAuth": [
            "admin"
          ]
        }
      ],
      "open": false
    }
  ],
  "summary": {
    "schemes": 1,
    "operations": 3,
    "openOperations": 1,
    "securedOperations": 2,
    "schemeUsage": {
      "bearerAuth": 2
    }
  }
}

From an MCP client

catalog.call {
  "slug": "openapi-security-summary",
  "params": {
    "spec": {
      "openapi": "3.0.0",
      "info": {
        "title": "Demo",
        "version": "1.0.0"
      },
      "security": [
        {
          "bearerAuth": []
        }
      ],
      "paths": {
        "/users": {
          "get": {
            "responses": {
              "200": {}
            }
          }
        },
        "/public": {
          "get": {
            "security": [],
            "responses": {
              "200": {}
            }
          }
        },
        "/admin": {
          "post": {
            "security": [
              {
                "bearerAuth": [
                  "admin"
                ]
              }
            ],
            "responses": {
              "201": {}
            }
          }
        }
      },
      "components": {
        "securitySchemes": {
          "bearerAuth": {
            "type": "http",
            "scheme": "bearer"
          }
        }
      }
    }
  }
}

On the hosted connector at https://agent402.tools/mcp, catalog.call runs openapi-security-summary free (rate-limited, no wallet). Local install: npx -y agent402-mcp.

Errors and behavior

• spec is required. An input the tool rejects returns an HTTP 4xx whose body carries error, tool, expected, required and example, so the caller can correct it.
• A paid call that ends in any status of 400 or above is not charged over x402, MPP or a prepaid credits key: settlement is cancelled when the tool fails. The exception is a Tempo push credential, a transfer the buyer sent before the call: it settles before the tool runs, so if the tool then fails the payment is recorded as a refund owed to the paying wallet.
• Free tier: no outbound network call leaves the server for this tool, so proof-of-work (16 leading zero bits of sha256) pays for it.
• A GET or HEAD to /api/openapi-security-summary returns the same 402 quote, so the price can be read without a body.
• An Idempotency-Key header makes a retried paid call replay the first 200 instead of charging again (an answer larger than 1 MB is not replayed).

Paid call (JavaScript agent)

import { wrapFetchWithPayment } from "@x402/fetch";
import { x402Client } from "@x402/core/client";
import { registerExactEvmScheme } from "@x402/evm/exact/client";
import { privateKeyToAccount } from "viem/accounts";

const client = new x402Client();
client.setSpendControls?.(false); // keep your own spending ceiling in code
registerExactEvmScheme(client, { signer: privateKeyToAccount(KEY) });
const payFetch = wrapFetchWithPayment(fetch, client);

const res = await payFetch("https://agent402.tools/api/openapi-security-summary", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    "spec": {
      "openapi": "3.0.0",
      "info": {
        "title": "Demo",
        "version": "1.0.0"
      },
      "security": [
        {
          "bearerAuth": []
        }
      ],
      "paths": {
        "/users": {
          "get": {
            "responses": {
              "200": {}
            }
          }
        },
        "/public": {
          "get": {
            "security": [],
            "responses": {
              "200": {}
            }
          }
        },
        "/admin": {
          "post": {
            "security": [
              {
                "bearerAuth": [
                  "admin"
                ]
              }
            ],
            "responses": {
              "201": {}
            }
          }
        }
      },
      "components": {
        "securitySchemes": {
          "bearerAuth": {
            "type": "http",
            "scheme": "bearer"
          }
        }
      }
    }
  }),
});

No wallet? Pay with compute

Fetch a challenge, solve the sha256 puzzle (16 leading zero bits, a fraction of a second of CPU), and resend with the X-Pow-Solution header:

import { createHash } from "node:crypto";
const lz = (b) => { let t = 0; for (const x of b) { if (!x) { t += 8; continue; } t += Math.clz32(x) - 24; break; } return t; };
const c = await (await fetch("https://agent402.tools/api/pow/challenge?slug=openapi-security-summary")).json();
let n = 0;
while (lz(createHash("sha256").update(c.challenge + ":" + n).digest()) < c.difficulty) n++;
await fetch("https://agent402.tools/api/openapi-security-summary", { method: "POST", headers: { "X-Pow-Solution": c.token + ":" + n, "Content-Type": "application/json" }, body: JSON.stringify({"spec":{"openapi":"3.0.0","info":{"title":"Demo","version":"1.0.0"},"security":[{"bearerAuth":[]}],"paths":{"/users":{"get":{"responses":{"200":{}}}},"/public":{"get":{"security":[],"responses":{"200":{}}}},"/admin":{"post":{"security":[{"bearerAuth":["admin"]}],"responses":{"201":{}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}}}) });

Part of these workflows

OpenAPI security summary is one step in these 2 skill packs, each sold as a single call:

• API contract drift check - The 'did this API contract change in a way that breaks our integration?' workflow. Diff two OpenAPI snapshots structurally, lint the new one for agent-readiness regressions, extract the endpoint surface for inventory comparison, validate a known-good payload against the new contract, and summarize security-relevant changes. Six tools, one go/no-go answer on whether the upstream API broke us.
• OpenAPI spec audit - Lint an OpenAPI spec and validate a sample payload against it - catch schema errors in one pass.

Related tools