commands.list

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "origin": {
      "type": [
        "string",
        "null"
      ],
      "description": "Only the commands of one program: `executable`, `tool` or `workflow`."
    },
    "effect": {
      "type": [
        "string",
        "null"
      ],
      "description": "Only the commands whose effect is at most this one: `read_only`,\n`local_mutation`, `repository_mutation`, `network_mutation`, `destructive`."
    },
    "search": {
      "type": [
        "string",
        "null"
      ],
      "description": "Only the commands matching this text in their invocation, summary, tags or identity."
    }
  },
  "description": "Which commands to answer with. Every filter is the graph's own vocabulary; none is a\nsearch over rendered text.",
  "title": "CommandFilter"
}

{
  "type": "object",
  "properties": {
    "schema": {
      "type": "string",
      "description": "The schema of the graph these came from."
    },
    "fingerprint": {
      "type": "string",
      "description": "The fingerprint of that graph: a client may cache against it."
    },
    "total": {
      "type": "integer",
      "format": "uint",
      "minimum": 0,
      "description": "How many commands the graph holds, before the filter."
    },
    "commands": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/CommandSummary"
      },
      "description": "The commands that matched, in graph order."
    }
  },
  "required": [
    "schema",
    "fingerprint",
    "total",
    "commands"
  ],
  "description": "The commands this repository offers, filtered.",
  "title": "CommandIndex",
  "$defs": {
    "CommandSummary": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The canonical identity."
        },
        "invocation": {
          "type": "string",
          "description": "The command line a person types."
        },
        "summary": {
          "type": "string",
          "description": "One line."
        },
        "origin": {
          "type": "string",
          "description": "Which program runs it."
        },
        "effect": {
          "type": "string",
          "description": "What running it changes."
        },
        "group": {
          "type": [
            "string",
            "null"
          ],
          "description": "The group it is found under."
        },
        "projections": {
          "$ref": "#/$defs/CommandProjections",
          "description": "Where it appears."
        }
      },
      "required": [
        "id",
        "invocation",
        "summary",
        "origin",
        "effect",
        "projections"
      ],
      "description": "One command, as an index shows it: enough to choose, never enough to have to skim."
    },
    "CommandProjections": {
      "type": "object",
      "properties": {
        "cli": {
          "type": [
            "string",
            "null"
          ],
          "description": "The command line, as typed."
        },
        "workflow": {
          "type": [
            "string",
            "null"
          ],
          "description": "The generated workflow bridge's recipe name."
        },
        "mcp": {
          "type": [
            "string",
            "null"
          ],
          "description": "The MCP tool name, when the capability behind it declares one."
        },
        "http": {
          "type": [
            "string",
            "null"
          ],
          "description": "The HTTP route, when the capability behind it declares one."
        },
        "cockpit": {
          "type": [
            "string",
            "null"
          ],
          "description": "The Cockpit address, when the surface carries it."
        },
        "docs": {
          "type": "string",
          "description": "The page on the site. Every command has one."
        },
        "withheld": {
          "type": [
            "string",
            "null"
          ],
          "description": "Why a machine surface does not carry it, when one does not."
        }
      },
      "required": [
        "docs"
      ],
      "description": "Where one command appears, derived from its effect, its interactivity and its origin.\n\nEvery field is computed by `super::policy`. Nothing declares a projection, and no\nsurface keeps a list of what it carries: a surface asks the graph."
    }
  }
}