runtime-connection

Generated reference page for spec/v1/schemas/commands/runtime-connection.json.

Metadata

• Type: JSON Schema
• Source: spec/v1/schemas/commands/runtime-connection.json
• Raw: View Raw

Summary

• Schema ID: https://agent-service.spec/v1/schemas/commands/runtime-connection.json
• Defs: 23
• Properties: 0
• Required: 0

Source

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://agent-service.spec/v1/schemas/commands/runtime-connection.json",
  "$defs": {
    "CoreCapabilityName": {
      "type": "string",
      "enum": [
        "input.receive",
        "output.publish",
        "tool.call",
        "interaction.request",
        "tracing",
        "config.read",
        "secrets.read",
        "kv.read",
        "kv.write",
        "checkpoint.save",
        "checkpoint.load"
      ]
    },
    "CoreCapabilitySupportLevel": {
      "type": "string",
      "enum": ["native", "polyfilled", "unsupported"]
    },
    "PlatformCapabilityName": {
      "type": "string",
      "enum": [
        "fs.read",
        "fs.write",
        "fs.list",
        "workspace.snapshot",
        "workspace.restore",
        "terminal.exec",
        "browser.open"
      ]
    },
    "PlatformCapabilitySupportLevel": {
      "type": "string",
      "enum": ["native", "unsupported"]
    },
    "CoreCapabilityDescriptor": {
      "type": "object",
      "additionalProperties": false,
      "required": ["surface", "name", "supportLevel"],
      "properties": {
        "surface": {
          "type": "string",
          "const": "core"
        },
        "name": {
          "$ref": "#/$defs/CoreCapabilityName"
        },
        "supportLevel": {
          "$ref": "#/$defs/CoreCapabilitySupportLevel"
        }
      }
    },
    "PlatformCapabilityDescriptor": {
      "type": "object",
      "additionalProperties": false,
      "required": ["surface", "name", "supportLevel"],
      "properties": {
        "surface": {
          "type": "string",
          "const": "platform"
        },
        "name": {
          "$ref": "#/$defs/PlatformCapabilityName"
        },
        "supportLevel": {
          "$ref": "#/$defs/PlatformCapabilitySupportLevel"
        }
      }
    },
    "SDKCapabilityDescriptor": {
      "oneOf": [
        {
          "$ref": "#/$defs/CoreCapabilityDescriptor"
        },
        {
          "$ref": "#/$defs/PlatformCapabilityDescriptor"
        }
      ]
    },
    "RuntimeAttachRequest": {
      "type": "object",
      "additionalProperties": false,
      "required": ["runId", "runtimeInstanceId", "protocolVersion", "sdkCapabilities"],
      "properties": {
        "runId": {
          "$ref": "../common/identity.json#/$defs/runId"
        },
        "attemptId": {
          "$ref": "../common/identity.json#/$defs/attemptId"
        },
        "runtimeInstanceId": {
          "$ref": "../common/identity.json#/$defs/opaqueId"
        },
        "protocolVersion": {
          "type": "string"
        },
        "reconnect": {
          "type": "boolean",
          "default": false
        },
        "connectionEpoch": {
          "type": "integer",
          "minimum": 0
        },
        "sdkCapabilities": {
          "type": "array",
          "minItems": 1,
          "uniqueItems": true,
          "items": {
            "$ref": "#/$defs/SDKCapabilityDescriptor"
          }
        }
      }
    },
    "RuntimeAttachResponse": {
      "type": "object",
      "additionalProperties": false,
      "required": ["runtimeConnectionId", "sessionId", "runId", "heartbeatIntervalMs", "leaseExpiresAt", "effectiveSdkCapabilities"],
      "properties": {
        "runtimeConnectionId": {
          "$ref": "../common/identity.json#/$defs/runtimeConnectionId"
        },
        "sessionId": {
          "$ref": "../common/identity.json#/$defs/sessionId"
        },
        "runId": {
          "$ref": "../common/identity.json#/$defs/runId"
        },
        "heartbeatIntervalMs": {
          "type": "integer",
          "minimum": 1000
        },
        "leaseExpiresAt": {
          "$ref": "../common/identity.json#/$defs/timestamp"
        },
        "configVersion": {
          "type": "string"
        },
        "effectiveSdkCapabilities": {
          "type": "array",
          "minItems": 1,
          "uniqueItems": true,
          "items": {
            "$ref": "#/$defs/SDKCapabilityDescriptor"
          }
        }
      }
    },
    "HeartbeatCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": ["runtimeConnectionId", "runId"],
      "properties": {
        "runtimeConnectionId": {
          "$ref": "../common/identity.json#/$defs/runtimeConnectionId"
        },
        "runId": {
          "$ref": "../common/identity.json#/$defs/runId"
        },
        "runtimeInstanceId": {
          "$ref": "../common/identity.json#/$defs/opaqueId"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "HeartbeatResponse": {
      "type": "object",
      "additionalProperties": false,
      "required": ["accepted", "nextHeartbeatDueAt"],
      "properties": {
        "accepted": {
          "type": "boolean"
        },
        "nextHeartbeatDueAt": {
          "$ref": "../common/identity.json#/$defs/timestamp"
        }
      }
    },
    "RecoverConnectionsCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": ["runtimeConnectionId", "mainRunId"],
      "properties": {
        "runtimeConnectionId": {
          "$ref": "../common/identity.json#/$defs/runtimeConnectionId"
        },
        "mainRunId": {
          "$ref": "../common/identity.json#/$defs/runId"
        },
        "subRunIds": {
          "type": "array",
          "items": {
            "$ref": "../common/identity.json#/$defs/runId"
          }
        },
        "connectionEpoch": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "RecoverConnectionsResponse": {
      "type": "object",
      "additionalProperties": false,
      "required": ["accepted"],
      "properties": {
        "accepted": {
          "type": "boolean"
        }
      }
    },
    "GetSecretsCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": ["runtimeConnectionId", "runId"],
      "properties": {
        "runtimeConnectionId": {
          "$ref": "../common/identity.json#/$defs/runtimeConnectionId"
        },
        "runId": {
          "$ref": "../common/identity.json#/$defs/runId"
        },
        "names": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "GetSecretsResponse": {
      "type": "object",
      "additionalProperties": false,
      "required": ["secrets"],
      "properties": {
        "secrets": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      }
    },
    "GetConfigCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": ["runtimeConnectionId", "runId"],
      "properties": {
        "runtimeConnectionId": {
          "$ref": "../common/identity.json#/$defs/runtimeConnectionId"
        },
        "runId": {
          "$ref": "../common/identity.json#/$defs/runId"
        }
      }
    },
    "GetConfigResponse": {
      "type": "object",
      "additionalProperties": false,
      "required": ["config"],
      "properties": {
        "config": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "GetKVCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": ["runtimeConnectionId", "runId", "keys"],
      "properties": {
        "runtimeConnectionId": {
          "$ref": "../common/identity.json#/$defs/runtimeConnectionId"
        },
        "runId": {
          "$ref": "../common/identity.json#/$defs/runId"
        },
        "keys": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "GetKVResponse": {
      "type": "object",
      "additionalProperties": false,
      "required": ["kv"],
      "properties": {
        "kv": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      }
    },
    "SetKVCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": ["runtimeConnectionId", "runId", "kv"],
      "properties": {
        "runtimeConnectionId": {
          "$ref": "../common/identity.json#/$defs/runtimeConnectionId"
        },
        "runId": {
          "$ref": "../common/identity.json#/$defs/runId"
        },
        "kv": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      }
    },
    "SetKVResponse": {
      "type": "object",
      "additionalProperties": false,
      "required": ["accepted"],
      "properties": {
        "accepted": {
          "type": "boolean"
        }
      }
    },
    "PublishOutputEventsRequest": {
      "type": "object",
      "additionalProperties": false,
      "required": ["runtimeConnectionId", "runId", "events"],
      "properties": {
        "runtimeConnectionId": {
          "$ref": "../common/identity.json#/$defs/runtimeConnectionId"
        },
        "runId": {
          "$ref": "../common/identity.json#/$defs/runId"
        },
        "events": {
          "type": "array",
          "items": {
            "$ref": "../events/output-event.json#/$defs/OutputEvent"
          }
        }
      }
    },
    "PublishOutputEventsResponse": {
      "type": "object",
      "additionalProperties": false,
      "required": ["accepted"],
      "properties": {
        "accepted": {
          "type": "boolean"
        }
      }
    }
  }
}