capabilities.json

{
  "name": "api-verity-lab",
  "version": "0.2.0",
  "summary": "API contract governance across seven protocols: diff, breaking-change rules, runtime drift, performance budgets and agent-tool governance under one contract model and one result format.",
  "repository": "https://github.com/webdevsamran/api-verity-lab",
  "documentation": "https://webdevsamran.github.io/api-verity-lab",
  "license": "Apache-2.0",
  "spec_plugins": [
    {
      "plugin": "AsyncApiSpecPlugin",
      "protocol": "asyncapi"
    },
    {
      "plugin": "GraphQlSpecPlugin",
      "protocol": "graphql"
    },
    {
      "plugin": "GrpcSpecPlugin",
      "protocol": "grpc"
    },
    {
      "plugin": "McpSpecPlugin",
      "protocol": "mcp"
    },
    {
      "plugin": "OpenApiSpecPlugin",
      "protocol": "openapi"
    },
    {
      "plugin": "Swagger2SpecPlugin",
      "protocol": "openapi"
    },
    {
      "plugin": "WsdlSpecPlugin",
      "protocol": "soap"
    }
  ],
  "protocol_values": [
    "openapi",
    "graphql",
    "grpc",
    "asyncapi",
    "sse",
    "websocket",
    "mcp",
    "soap"
  ],
  "commands": [
    {
      "name": "agent-setup",
      "summary": "tell the coding agents working in this repository that this tool exists",
      "options": [
        "--force",
        "--json",
        "--target",
        "--write"
      ]
    },
    {
      "name": "agent-tasks",
      "summary": "export a verified MCP tool surface as a tooltrace-bench task pack",
      "options": [
        "--allow-findings",
        "--include-flagged",
        "--json",
        "--pack",
        "-o"
      ]
    },
    {
      "name": "app",
      "summary": "read the contract out of an application object and check it",
      "options": [
        "--against",
        "--json",
        "--root",
        "-o"
      ]
    },
    {
      "name": "audit",
      "summary": "export the hash-chained audit log, or verify an exported one",
      "options": [
        "--against",
        "--db",
        "--hmac-key-env",
        "--json",
        "--org-id",
        "-o"
      ]
    },
    {
      "name": "baseline",
      "summary": "measure latency percentiles and store them for later comparison",
      "options": [
        "--auth-profile",
        "--auth-profiles",
        "--base-url",
        "--header",
        "--iterations",
        "--json",
        "--slo",
        "--warmup",
        "-o"
      ]
    },
    {
      "name": "breaking",
      "summary": "classify those changes against the rule catalogue and fail on the breaking ones",
      "options": [
        "--check-semver",
        "--consumers",
        "--json",
        "--new-version",
        "--old-version",
        "--require-minor-for-warnings",
        "--sdk",
        "--sdk-convention",
        "--severity-by-consumers",
        "--severity-override",
        "--suggest-fix",
        "--suggest-version",
        "--summary"
      ]
    },
    {
      "name": "budget",
      "summary": "check observed calls against a declared call budget",
      "options": [
        "--budget",
        "--json",
        "--spec"
      ]
    },
    {
      "name": "capture",
      "summary": "record real traffic through a proxy, into a HAR corpus",
      "options": [
        "--duration",
        "--host",
        "--i-know-this-is-exposed",
        "--json",
        "--max-body-bytes",
        "--max-entries",
        "--no-response-bodies",
        "--out",
        "--port",
        "--target",
        "--timeout"
      ]
    },
    {
      "name": "changelog",
      "summary": "a release note for a version bump, in markdown or HTML",
      "options": [
        "--html",
        "--json",
        "--output"
      ]
    },
    {
      "name": "config",
      "summary": "validate or show the project config",
      "options": [
        "--json",
        "--path"
      ]
    },
    {
      "name": "coverage",
      "summary": "which operations and statuses a run actually exercised",
      "options": [
        "--exercised",
        "--json"
      ]
    },
    {
      "name": "diff",
      "summary": "every semantic change between two contracts, with a stable id each",
      "options": [
        "--json"
      ]
    },
    {
      "name": "digest",
      "summary": "one contract-health document per team, from a sweep artifact",
      "options": [
        "--json",
        "--out",
        "--since"
      ]
    },
    {
      "name": "drift",
      "summary": "the declared contract against a live service, a recorded corpus or an MCP server",
      "options": [
        "--against-corpus",
        "--allow-undeclared-fields",
        "--auth-profile",
        "--auth-profiles",
        "--base-url",
        "--baseline",
        "--corpus",
        "--execute",
        "--header",
        "--i-know-this-is-production",
        "--include-response-bodies",
        "--invoke-tool",
        "--json",
        "--max-list-pages",
        "--min-samples",
        "--otlp-endpoint",
        "--save-baseline",
        "--seed",
        "--skip-auth-probe",
        "--timeout"
      ]
    },
    {
      "name": "evidence",
      "summary": "assemble result artifacts into a dated, checksummed evidence pack",
      "options": [
        "--as-of",
        "--json",
        "-o"
      ]
    },
    {
      "name": "explain",
      "summary": "explain one rule: what it means, why, and how to change its severity",
      "options": [
        "--json"
      ]
    },
    {
      "name": "export",
      "summary": "write a portable .apiverity bundle with checksums",
      "options": [
        "--config",
        "--data",
        "--json",
        "--perf",
        "--spec",
        "--workflow",
        "-o"
      ]
    },
    {
      "name": "federation",
      "summary": "what a subgraph change does to the composed graph",
      "options": [
        "--against",
        "--json",
        "--subgraph"
      ]
    },
    {
      "name": "freeze",
      "summary": "emergency stop: refuse deployments and approvals until lifted",
      "options": [
        "--json",
        "--reason",
        "--review-by",
        "--server",
        "--token-env"
      ]
    },
    {
      "name": "ghosts",
      "summary": "find routes the contract no longer declares that the server still answers",
      "options": [
        "--auth-profile",
        "--auth-profiles",
        "--base-url",
        "--corpus",
        "--header",
        "--json",
        "--timeout",
        "--was"
      ]
    },
    {
      "name": "graph",
      "summary": "which contract in a tree reads whose schemas",
      "options": [
        "--dependents-of",
        "--json",
        "--limit",
        "--mermaid"
      ]
    },
    {
      "name": "import-rules",
      "summary": "read a Spectral ruleset and report what migrating it would cost",
      "options": [
        "--json"
      ]
    },
    {
      "name": "infer",
      "summary": "draft a contract from recorded traffic, labelled as a draft",
      "options": [
        "--infer-enums",
        "--json",
        "--title",
        "-o"
      ]
    },
    {
      "name": "init",
      "summary": "detect this project's contracts and write .apiverity.yaml",
      "options": [
        "--dry-run",
        "--force",
        "--json"
      ]
    },
    {
      "name": "lsp",
      "summary": "run the language server on stdio (editor diagnostics)",
      "options": []
    },
    {
      "name": "mcp-inventory",
      "summary": "list the MCP servers this machine is configured to reach, and flag unapproved ones",
      "options": [
        "--config",
        "--include-home",
        "--inventory",
        "--json"
      ]
    },
    {
      "name": "mcp-lock",
      "summary": "write or check mcp.lock, a reviewed baseline for an MCP tool surface",
      "options": [
        "--auth-profile",
        "--auth-profiles",
        "--base-url",
        "--force",
        "--header",
        "--json",
        "--key-env",
        "--lock",
        "--max-list-pages",
        "--require-minor-for-warnings",
        "--sign",
        "--surface-version",
        "--timeout"
      ]
    },
    {
      "name": "mock",
      "summary": "serve a deterministic mock of a contract, with optional misbehaviour",
      "options": [
        "--force-status",
        "--json",
        "--latency-ms",
        "--malformed",
        "--port",
        "--rate-limit-after",
        "--workspace"
      ]
    },
    {
      "name": "monitor",
      "summary": "run a command on a schedule and report what changed since last time",
      "options": [
        "--interval",
        "--json",
        "--out",
        "--runs",
        "--state"
      ]
    },
    {
      "name": "notify",
      "summary": "route a result artifact's findings to the teams they concern",
      "options": [
        "--consumers",
        "--json",
        "--root",
        "--routes",
        "--send"
      ]
    },
    {
      "name": "plugins",
      "summary": "list installed plugins across the six entry-point groups",
      "options": [
        "--json"
      ]
    },
    {
      "name": "regression",
      "summary": "measure again and fail when latency or error rate regressed past a tolerance",
      "options": [
        "--auth-profile",
        "--auth-profiles",
        "--base-url",
        "--baseline",
        "--concurrency",
        "--curve",
        "--header",
        "--include-mutations",
        "--iterations",
        "--json",
        "--operation",
        "--path",
        "--policy",
        "--shape",
        "--tolerance",
        "--warmup"
      ]
    },
    {
      "name": "replay",
      "summary": "replay a sanitized traffic corpus, dry-run by default",
      "options": [
        "--allow-host",
        "--allow-method",
        "--auth-profile",
        "--auth-profiles",
        "--base-url",
        "--confirm",
        "--execute",
        "--header",
        "--i-know-this-is-production",
        "--json",
        "--rate"
      ]
    },
    {
      "name": "report",
      "summary": "render a result bundle: terminal, markdown, HTML, JUnit, SARIF, oasdiff's own JSON shape, a pull request comment, or an OWASP mapping",
      "options": [
        "--format"
      ]
    },
    {
      "name": "rules",
      "summary": "the whole rule catalogue, with the severities this run would apply",
      "options": [
        "--json",
        "--packs",
        "--policy-vocabulary",
        "--profiles"
      ]
    },
    {
      "name": "self-test",
      "summary": "check this installation can load, diff and classify a bundled fixture",
      "options": [
        "--json"
      ]
    },
    {
      "name": "serve",
      "summary": "serve a bundle over HTTP for local viewing",
      "options": [
        "--json",
        "--port"
      ]
    },
    {
      "name": "server-db",
      "summary": "backup/restore/export/import a server database",
      "options": [
        "--db",
        "--input",
        "--json",
        "--org-id",
        "-o"
      ]
    },
    {
      "name": "sweep",
      "summary": "every contract in a tree, with an owner and a verdict for each",
      "options": [
        "--base",
        "--json",
        "--limit"
      ]
    },
    {
      "name": "test",
      "summary": "generate cases from the schema and run them against a live service",
      "options": [
        "--allow-credential-payloads",
        "--as",
        "--auth-profile",
        "--auth-profiles",
        "--authz",
        "--base-url",
        "--collection",
        "--generator",
        "--header",
        "--include-mutations",
        "--json",
        "--list-generators",
        "--max-payload-bytes",
        "--minimize",
        "--model-based",
        "--operations",
        "--seed",
        "--timeout"
      ]
    },
    {
      "name": "validate",
      "summary": "load a contract, report what is wrong with the document itself",
      "options": [
        "--json",
        "--policy-file"
      ]
    },
    {
      "name": "verify",
      "summary": "check a bundle against its own SHA256SUMS",
      "options": [
        "--json"
      ]
    },
    {
      "name": "watch",
      "summary": "re-run a command whenever the files it names change",
      "options": [
        "--interval",
        "--path"
      ]
    },
    {
      "name": "workflow",
      "summary": "run a multi-step workflow manifest, or infer a draft from a contract",
      "options": [
        "--auth-profile",
        "--auth-profiles",
        "--base-url",
        "--header",
        "--infer",
        "--input",
        "--json",
        "--list-templates",
        "--no-preflight",
        "--spec",
        "--template",
        "--to-arazzo",
        "--workflow-id",
        "-o"
      ]
    }
  ],
  "rules": {
    "count": 79,
    "ids": [
      "BRK-CONDITIONAL-SCHEMA-CHANGED",
      "BRK-CONSTRAINT-LOOSENED",
      "BRK-CONSTRAINT-TIGHTENED",
      "BRK-CONTAINS-CHANGED",
      "BRK-DEPENDENT-REQUIRED-ADDED",
      "BRK-DEPENDENT-REQUIRED-REMOVED",
      "BRK-DEPENDENT-SCHEMA-CHANGED",
      "BRK-DEPRECATION-ADDED",
      "BRK-DEPRECATION-REMOVED",
      "BRK-ENUM-NARROWED-REQUEST",
      "BRK-ENUM-NARROWED-RESPONSE",
      "BRK-ENUM-WIDENED",
      "BRK-FIELD-NUMBER-REUSED",
      "BRK-FIELD-NUMBER-UNRESERVED",
      "BRK-FIELD-PRESENCE-LOST",
      "BRK-HEADER-ADDED",
      "BRK-HEADER-REMOVED",
      "BRK-MCP-ANNOTATION-DECLARATION-CHANGED",
      "BRK-MCP-DESTRUCTIVE-HINT-CLEARED",
      "BRK-MCP-DESTRUCTIVE-HINT-SET",
      "BRK-MCP-IDEMPOTENT-HINT-CLEARED",
      "BRK-MCP-IDEMPOTENT-HINT-SET",
      "BRK-MCP-MANIFEST-TRUNCATED",
      "BRK-MCP-OPENWORLD-HINT-CHANGED",
      "BRK-MCP-OUTPUT-SCHEMA-ADDED",
      "BRK-MCP-OUTPUT-SCHEMA-REMOVED",
      "BRK-MCP-READONLY-HINT-CLEARED",
      "BRK-MCP-READONLY-HINT-SET",
      "BRK-MCP-TOOL-DESCRIPTION-CHANGED",
      "BRK-MCP-TOOL-RENAME-SUSPECTED",
      "BRK-MEDIA-TYPE-CHANGED",
      "BRK-ONEOF-NARROWED",
      "BRK-ONEOF-WIDENED",
      "BRK-OP-ADDED",
      "BRK-OP-REMOVED",
      "BRK-PARAM-ADDED-OPTIONAL",
      "BRK-PARAM-ADDED-REQUIRED",
      "BRK-PARAM-OPTIONALIZED",
      "BRK-PARAM-REMOVED",
      "BRK-PARAM-REQUIRED",
      "BRK-PARAM-TYPE-CHANGED",
      "BRK-PATTERN-PROPERTIES-CHANGED",
      "BRK-PROPERTY-NAMES-CHANGED",
      "BRK-REQ-BODY-ADDED-OPTIONAL",
      "BRK-REQ-BODY-ADDED-REQUIRED",
      "BRK-REQ-BODY-REMOVED",
      "BRK-REQ-BODY-REQUIRED",
      "BRK-REQ-FIELD-ADDED-OPTIONAL",
      "BRK-REQ-FIELD-ADDED-REQUIRED",
      "BRK-REQ-FIELD-BECAME-REQUIRED",
      "BRK-REQ-FIELD-OPTIONALIZED",
      "BRK-REQ-FIELD-REMOVED",
      "BRK-REQ-NULLABLE-ADDED",
      "BRK-REQ-NULLABLE-REMOVED",
      "BRK-RESERVATION-REMOVED",
      "BRK-RESP-CONSTRAINT-LOOSENED",
      "BRK-RESP-CONSTRAINT-TIGHTENED",
      "BRK-RESP-FIELD-ADDED",
      "BRK-RESP-FIELD-GUARANTEED",
      "BRK-RESP-FIELD-OPTIONALIZED",
      "BRK-RESP-FIELD-REMOVED",
      "BRK-RESP-NULLABLE-ADDED",
      "BRK-RESP-NULLABLE-REMOVED",
      "BRK-RESP-STATUS-ADDED",
      "BRK-RESP-STATUS-REMOVED",
      "BRK-RESP-TYPE-CHANGED",
      "BRK-RPC-ADDED",
      "BRK-RPC-REMOVED",
      "BRK-RPC-STREAMING-CHANGED",
      "BRK-SECURITY-CHANGED",
      "BRK-SOAP-ACTION-CHANGED",
      "BRK-SOAP-STYLE-CHANGED",
      "BRK-SOAP-VERSION-CHANGED",
      "BRK-STREAM-ENCODING-CHANGED",
      "BRK-STREAM-ITEM-SCHEMA-ADDED",
      "BRK-STREAM-ITEM-SCHEMA-REMOVED",
      "BRK-STREAM-PREFIX-COUNT-CHANGED",
      "BRK-STREAM-SEQUENTIAL-CHANGED",
      "BRK-TUPLE-SHAPE-CHANGED"
    ],
    "every_rule_has_an_alternative": true
  },
  "exit_codes": {
    "ok": 0,
    "findings": 1,
    "usage": 2,
    "unreachable": 3,
    "internal": 4
  },
  "schemas": {
    "result": "schemas/result-v1.schema.json",
    "config": "schemas/config-v1.schema.json"
  },
  "generated_by": "scripts/generate_capability_manifest.py"
}