Agent as a Service

主题

control-plane ​

Generated reference page for spec/v1/schemas/commands/control-plane.json.

Metadata ​

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

Summary ​

Source ​

json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://agent-service.spec/v1/schemas/commands/control-plane.json",
  "$defs": {
    "VersionedWriteOptions": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "expectedVersion": {
          "$ref": "../common/identity.json#/$defs/version"
        }
      }
    },
    "CreateOrganizationCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "orgId",
        "name"
      ],
      "properties": {
        "orgId": {
          "$ref": "../common/identity.json#/$defs/orgId"
        },
        "name": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "status": {
          "$ref": "../common/enums.json#/$defs/organizationStatus"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "UpdateOrganizationCommand": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "expectedVersion": {
          "$ref": "../common/identity.json#/$defs/version"
        },
        "name": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "status": {
          "$ref": "../common/enums.json#/$defs/organizationStatus"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "CreateAgentCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "agentId"
      ],
      "properties": {
        "agentId": {
          "$ref": "../common/identity.json#/$defs/agentId"
        },
        "card": {
          "type": "object",
          "additionalProperties": true
        },
        "defaultReleaseChannelId": {
          "$ref": "../common/identity.json#/$defs/releaseChannelId"
        },
        "enabled": {
          "type": "boolean"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "UpdateAgentCommand": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "expectedVersion": {
          "$ref": "../common/identity.json#/$defs/version"
        },
        "card": {
          "type": "object",
          "additionalProperties": true
        },
        "defaultReleaseChannelId": {
          "$ref": "../common/identity.json#/$defs/releaseChannelId"
        },
        "enabled": {
          "type": "boolean"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "CreateAgentRevisionCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "agentRevisionId",
        "executionProfile"
      ],
      "properties": {
        "agentRevisionId": {
          "$ref": "../common/identity.json#/$defs/agentRevisionId"
        },
        "card": {
          "type": "object",
          "additionalProperties": true
        },
        "protocolProfiles": {
          "$ref": "../common/protocol-profile.json#/$defs/ProtocolProfiles"
        },
        "callableRefs": {
          "type": "array",
          "items": {
            "$ref": "../resources/agent-revision.json#/$defs/CallableRef"
          }
        },
        "executionProfile": {
          "$ref": "../common/execution-profile.json#/$defs/ExecutionProfile"
        },
        "runPolicy": {
          "$ref": "../common/execution-profile.json#/$defs/RunPolicy"
        },
        "secretRefs": {
          "type": "array",
          "items": {
            "$ref": "../common/execution-profile.json#/$defs/SecretRef"
          }
        },
        "releaseNotes": {
          "type": "string"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "CreateToolCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "toolId",
        "name"
      ],
      "properties": {
        "toolId": {
          "$ref": "../common/identity.json#/$defs/toolId"
        },
        "name": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string"
        },
        "defaultReleaseChannelId": {
          "$ref": "../common/identity.json#/$defs/releaseChannelId"
        },
        "enabled": {
          "type": "boolean"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "UpdateToolCommand": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "expectedVersion": {
          "$ref": "../common/identity.json#/$defs/version"
        },
        "name": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string"
        },
        "defaultReleaseChannelId": {
          "$ref": "../common/identity.json#/$defs/releaseChannelId"
        },
        "enabled": {
          "type": "boolean"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "CreateMcpServerCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "mcpServerId",
        "name"
      ],
      "properties": {
        "mcpServerId": {
          "$ref": "../common/identity.json#/$defs/mcpServerId"
        },
        "name": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string"
        },
        "defaultReleaseChannelId": {
          "$ref": "../common/identity.json#/$defs/releaseChannelId"
        },
        "enabled": {
          "type": "boolean"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "UpdateMcpServerCommand": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "expectedVersion": {
          "$ref": "../common/identity.json#/$defs/version"
        },
        "name": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string"
        },
        "defaultReleaseChannelId": {
          "$ref": "../common/identity.json#/$defs/releaseChannelId"
        },
        "enabled": {
          "type": "boolean"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "CreateToolRevisionCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "toolRevisionId",
        "description",
        "executionMode",
        "resultTransport"
      ],
      "properties": {
        "toolRevisionId": {
          "$ref": "../common/identity.json#/$defs/toolRevisionId"
        },
        "description": {
          "type": "string",
          "minLength": 1
        },
        "parametersSchema": {
          "type": "object",
          "additionalProperties": true
        },
        "resultSchema": {
          "type": "object",
          "additionalProperties": true
        },
        "executionMode": {
          "$ref": "../common/enums.json#/$defs/toolExecutionMode"
        },
        "resultTransport": {
          "$ref": "../common/enums.json#/$defs/toolResultTransport"
        },
        "executionProfile": {
          "$ref": "../common/execution-profile.json#/$defs/ExecutionProfile"
        },
        "runPolicy": {
          "$ref": "../common/execution-profile.json#/$defs/RunPolicy"
        },
        "authPolicy": {
          "type": "object",
          "additionalProperties": true
        },
        "idempotent": {
          "type": "boolean"
        },
        "releaseNotes": {
          "type": "string"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "CreateMcpServerRevisionCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "mcpServerRevisionId",
        "description",
        "mcpProfile",
        "executionProfile"
      ],
      "properties": {
        "mcpServerRevisionId": {
          "$ref": "../common/identity.json#/$defs/mcpServerRevisionId"
        },
        "description": {
          "type": "string",
          "minLength": 1
        },
        "mcpProfile": {
          "$ref": "../common/protocol-profile.json#/$defs/MCPProtocolProfile"
        },
        "toolCatalog": {
          "type": "array",
          "items": {
            "$ref": "../resources/mcp-server-revision.json#/$defs/McpToolDescriptor"
          }
        },
        "executionProfile": {
          "$ref": "../common/execution-profile.json#/$defs/ExecutionProfile"
        },
        "runPolicy": {
          "$ref": "../common/execution-profile.json#/$defs/RunPolicy"
        },
        "authPolicy": {
          "type": "object",
          "additionalProperties": true
        },
        "secretRefs": {
          "type": "array",
          "items": {
            "$ref": "../common/execution-profile.json#/$defs/SecretRef"
          }
        },
        "releaseNotes": {
          "type": "string"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "CreateReleaseChannelCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "channelId",
        "resourceType",
        "resourceId",
        "name",
        "status",
        "routingMode",
        "releases"
      ],
      "properties": {
        "channelId": {
          "$ref": "../common/identity.json#/$defs/releaseChannelId"
        },
        "resourceType": {
          "$ref": "../common/enums.json#/$defs/taskResourceType"
        },
        "resourceId": {
          "$ref": "../common/identity.json#/$defs/opaqueId"
        },
        "name": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string"
        },
        "status": {
          "$ref": "../common/enums.json#/$defs/releaseChannelStatus"
        },
        "routingMode": {
          "$ref": "../common/enums.json#/$defs/releaseRoutingMode"
        },
        "currentRevisionId": {
          "$ref": "../common/identity.json#/$defs/opaqueId"
        },
        "releases": {
          "type": "array",
          "items": {
            "$ref": "../resources/release-channel.json#/$defs/ChannelRelease"
          }
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "UpdateReleaseChannelCommand": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "expectedVersion": {
          "$ref": "../common/identity.json#/$defs/version"
        },
        "name": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string"
        },
        "status": {
          "$ref": "../common/enums.json#/$defs/releaseChannelStatus"
        },
        "routingMode": {
          "$ref": "../common/enums.json#/$defs/releaseRoutingMode"
        },
        "currentRevisionId": {
          "$ref": "../common/identity.json#/$defs/opaqueId"
        },
        "releases": {
          "type": "array",
          "items": {
            "$ref": "../resources/release-channel.json#/$defs/ChannelRelease"
          }
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      },
      "allOf": [
        {
          "if": {
            "properties": {
              "protocol": {
                "const": "mcp"
              }
            },
            "required": ["protocol"]
          },
          "then": {
            "properties": {
              "targetType": {
                "const": "mcp_server_revision"
              }
            }
          }
        },
        {
          "if": {
            "properties": {
              "targetType": {
                "const": "mcp_server_revision"
              }
            },
            "required": ["targetType"]
          },
          "then": {
            "properties": {
              "protocol": {
                "const": "mcp"
              }
            }
          }
        }
      ]
    },
    "CreateProtocolBindingCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "bindingId",
        "targetType",
        "targetId",
        "protocol",
        "protocolVersion",
        "endpoint",
        "transports"
      ],
      "properties": {
        "bindingId": {
          "$ref": "../common/identity.json#/$defs/protocolBindingId"
        },
        "targetType": {
          "$ref": "../common/enums.json#/$defs/bindingTargetType"
        },
        "targetId": {
          "$ref": "../common/identity.json#/$defs/opaqueId"
        },
        "protocol": {
          "$ref": "../common/enums.json#/$defs/protocolName"
        },
        "protocolVersion": {
          "type": "string",
          "minLength": 1
        },
        "endpoint": {
          "type": "string",
          "format": "uri-reference"
        },
        "transports": {
          "type": "array",
          "items": {
            "$ref": "../common/protocol-profile.json#/$defs/ProtocolTransport"
          }
        },
        "security": {
          "type": "array",
          "items": {
            "$ref": "../common/protocol-profile.json#/$defs/ProtocolSecurityRequirement"
          }
        },
        "regions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "audiences": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "enabled": {
          "type": "boolean"
        },
        "extensions": {
          "type": "array",
          "items": {
            "$ref": "../common/protocol-profile.json#/$defs/ProtocolExtension"
          }
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "UpdateProtocolBindingCommand": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "expectedVersion": {
          "$ref": "../common/identity.json#/$defs/version"
        },
        "protocolVersion": {
          "type": "string",
          "minLength": 1
        },
        "endpoint": {
          "type": "string",
          "format": "uri-reference"
        },
        "transports": {
          "type": "array",
          "items": {
            "$ref": "../common/protocol-profile.json#/$defs/ProtocolTransport"
          }
        },
        "security": {
          "type": "array",
          "items": {
            "$ref": "../common/protocol-profile.json#/$defs/ProtocolSecurityRequirement"
          }
        },
        "regions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "audiences": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "enabled": {
          "type": "boolean"
        },
        "extensions": {
          "type": "array",
          "items": {
            "$ref": "../common/protocol-profile.json#/$defs/ProtocolExtension"
          }
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "CreateCallableGrantCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "grantId",
        "providerOrgId",
        "consumerOrgId",
        "resourceType",
        "resourceId",
        "releaseChannelId"
      ],
      "properties": {
        "grantId": {
          "$ref": "../common/identity.json#/$defs/callableGrantId"
        },
        "providerOrgId": {
          "$ref": "../common/identity.json#/$defs/orgId"
        },
        "consumerOrgId": {
          "$ref": "../common/identity.json#/$defs/orgId"
        },
        "resourceType": {
          "$ref": "../common/enums.json#/$defs/taskResourceType"
        },
        "resourceId": {
          "$ref": "../common/identity.json#/$defs/opaqueId"
        },
        "releaseChannelId": {
          "$ref": "../common/identity.json#/$defs/releaseChannelId"
        },
        "enabled": {
          "type": "boolean"
        },
        "visibilityScopes": {
          "type": "array",
          "items": {
            "$ref": "../common/enums.json#/$defs/callableGrantVisibilityScope"
          }
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "UpdateCallableGrantCommand": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "expectedVersion": {
          "$ref": "../common/identity.json#/$defs/version"
        },
        "releaseChannelId": {
          "$ref": "../common/identity.json#/$defs/releaseChannelId"
        },
        "enabled": {
          "type": "boolean"
        },
        "visibilityScopes": {
          "type": "array",
          "items": {
            "$ref": "../common/enums.json#/$defs/callableGrantVisibilityScope"
          }
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "CreateRunCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "resourceType",
        "resourceId",
        "input"
      ],
      "properties": {
        "resourceType": {
          "$ref": "../common/enums.json#/$defs/taskResourceType"
        },
        "resourceId": {
          "$ref": "../common/identity.json#/$defs/opaqueId"
        },
        "resourceRevisionId": {
          "$ref": "../common/identity.json#/$defs/opaqueId"
        },
        "releaseChannelId": {
          "$ref": "../common/identity.json#/$defs/releaseChannelId"
        },
        "runId": {
          "$ref": "../common/identity.json#/$defs/runId"
        },
        "threadId": {
          "$ref": "../common/identity.json#/$defs/threadId"
        },
        "contextId": {
          "$ref": "../common/identity.json#/$defs/opaqueId"
        },
        "input": {
          "$ref": "../resources/run.json#/$defs/RunInput"
        },
        "runPolicyOverride": {
          "$ref": "../common/execution-profile.json#/$defs/RunPolicy"
        },
        "webhook": {
          "$ref": "../resources/webhook-subscription.json"
        },
        "idempotencyKey": {
          "type": "string"
        }
      },
      "allOf": [
        {
          "if": {
            "properties": {
              "resourceType": {
                "const": "agent"
              }
            },
            "required": ["resourceType"]
          },
          "then": {
            "properties": {
              "input": {
                "$ref": "../resources/run.json#/$defs/AgentRunInput"
              }
            }
          }
        },
        {
          "if": {
            "properties": {
              "resourceType": {
                "const": "tool"
              }
            },
            "required": ["resourceType"]
          },
          "then": {
            "properties": {
              "input": {
                "$ref": "../resources/run.json#/$defs/ToolRunInput"
              }
            }
          }
        },
        {
          "if": {
            "properties": {
              "resourceType": {
                "const": "mcp_server"
              }
            },
            "required": ["resourceType"]
          },
          "then": {
            "properties": {
              "input": {
                "$ref": "../resources/run.json#/$defs/McpServerRunInput"
              }
            }
          }
        }
      ]
    },
    "ContinueRunCommand": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "mode",
            "messages"
          ],
          "properties": {
            "mode": {
              "const": "agent"
            },
            "messages": {
              "type": "array",
              "items": {
                "$ref": "../resources/message-record.json#/$defs/TaskInputMessage"
              }
            }
          }
        },
        {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "mode",
            "requests"
          ],
          "properties": {
            "mode": {
              "const": "mcp_server"
            },
            "requests": {
              "type": "array",
              "minItems": 1,
              "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                  "method"
                ],
                "properties": {
                  "id": {},
                  "method": {
                    "type": "string",
                    "minLength": 1
                  },
                  "params": {},
                  "metadata": {
                    "type": "object",
                    "additionalProperties": true
                  }
                }
              }
            }
          }
        }
      ]
    },
    "NotifyRunCommand": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "CancelRunCommand": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "reason": {
          "type": "string"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "FailRunCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "errorMessage"
      ],
      "properties": {
        "errorMessage": {
          "type": "string",
          "minLength": 1
        }
      }
    },
    "RespondInteractionCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "decision"
      ],
      "properties": {
        "decision": {
          "$ref": "../common/enums.json#/$defs/interactionDecision"
        },
        "selectedOptionId": {
          "type": "string"
        },
        "payload": {},
        "submittedBy": {
          "type": "string"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "SaveCheckpointCommand": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "label": {
          "type": "string"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        },
        "strategies": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true
          }
        }
      }
    },
    "LoadCheckpointCommand": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "checkpointId"
      ],
      "properties": {
        "checkpointId": {
          "$ref": "../common/identity.json#/$defs/checkpointId"
        },
        "strategyIds": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}

白皮书与规范内容以仓库真源为准。

Agent as a Service