Skip to content

ProtocolConfiguration

Structure Class

ProtocolConfiguration dataclass

Bases: _SerdeShape

The protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.

Attributes

path class-attribute instance-attribute
path: str | None = ...

The path on which the agent server accepts requests. The path must begin with /. When this field is omitted, the default is /invocations for HTTP and AGUI, /mcp for MCP, and / for A2A.

port class-attribute instance-attribute
port: int | None = ...

The port on which the agent server listens. The port must be between 8000 and 12000, excluding the reserved port 8443. When this field is omitted, the default is 8080 for HTTP and AGUI, 8000 for MCP, and 9000 for A2A.

server_protocol instance-attribute
server_protocol: str

The server protocol for the agent runtime. This field specifies which protocol the agent runtime uses to communicate with clients.