harnest.server

All Python modules · Import and compatibility guidance

Exports

Name	Kind
`HTTPServerConfig`	Class
`PlaygroundConfig`	Class
`ServerConfig`	Class
`ServerConfigError`	Class
`ServerLimits`	Class
`load_server_config`	Function

HTTPServerConfig

Configure the compiled agent’s HTTP listener and request concurrency.

HTTPServerConfig(
    host: str = '127.0.0.1',
    port: int = 1907,
    allow_remote: bool = False,
    request_timeout_seconds: float = 300,
    max_concurrent_requests: int = 8,
) -> None

Fields (— means no declared default):

Field	Type	Default
`host`	`str`	`'127.0.0.1'`
`port`	`int`	`1907`
`allow_remote`	`bool`	`False`
`request_timeout_seconds`	`float`	`300`
`max_concurrent_requests`	`int`	`8`

Parameters and example

Parameter	Type	Default
`host`	`str`	`'127.0.0.1'`
`port`	`int`	`1907`
`allow_remote`	`bool`	`False`
`request_timeout_seconds`	`float`	`300`
`max_concurrent_requests`	`int`	`8`

from harnest.server import HTTPServerConfig

config = HTTPServerConfig()

PlaygroundConfig

Control whether the local agent playground is exposed.

PlaygroundConfig(enabled: bool = True) -> None

Fields (— means no declared default):

Field	Type	Default
`enabled`	`bool`	`True`

Parameters and example

Parameter	Type	Default
`enabled`	`bool`	`True`

from harnest.server import PlaygroundConfig

config = PlaygroundConfig()

ServerConfig

Group validated listener, limit, UI, transport, and principal policy.

ServerConfig(
    http: HTTPServerConfig = HTTPServerConfig(host='127.0.0.1', port=1907, allow_remote=False, request_timeout_seconds=300, max_concurrent_requests=8),
    limits: ServerLimits = ServerLimits(max_request_bytes=1048576),
    playground: PlaygroundConfig = PlaygroundConfig(enabled=True),
    live: bool = False,
    agent_principal: Literal['optional', 'required'] = 'optional',
    openapi: bool = True,
    agui: bool = True,
) -> None

Fields (— means no declared default):

Field	Type	Default
`http`	`HTTPServerConfig`	`HTTPServerConfig(host='127.0.0.1', port=1907, allow_remote=False, request_timeout_seconds=300, max_concurrent_requests=8)`
`limits`	`ServerLimits`	`ServerLimits(max_request_bytes=1048576)`
`playground`	`PlaygroundConfig`	`PlaygroundConfig(enabled=True)`
`live`	`bool`	`False`
`agent_principal`	`Literal['optional', 'required']`	`'optional'`
`openapi`	`bool`	`True`
`agui`	`bool`	`True`

Parameters and example

Parameter	Type	Default
`http`	`HTTPServerConfig`	`HTTPServerConfig(host='127.0.0.1', port=1907, allow_remote=False, request_timeout_seconds=300, max_concurrent_requests=8)`
`limits`	`ServerLimits`	`ServerLimits(max_request_bytes=1048576)`
`playground`	`PlaygroundConfig`	`PlaygroundConfig(enabled=True)`
`live`	`bool`	`False`
`agent_principal`	`Literal['optional', 'required']`	`'optional'`
`openapi`	`bool`	`True`
`agui`	`bool`	`True`

from harnest.server import ServerConfig

config = ServerConfig()

ServerConfig.with_overrides

ServerConfig.with_overrides(
    *,
    host: str | None = None,
    port: int | None = None,
    request_timeout_seconds: float | None = None,
    max_concurrent_requests: int | None = None,
    allow_remote: bool | None = None,
) -> 'ServerConfig'

Apply the compiled launcher’s explicit operational overrides.

Parameters and example

Parameter	Type	Default
`host`	`str \| None`	`None`
`port`	`int \| None`	`None`
`request_timeout_seconds`	`float \| None`	`None`
`max_concurrent_requests`	`int \| None`	`None`
`allow_remote`	`bool \| None`	`None`

from harnest.server import ServerConfig

config: ServerConfig
config = config.with_overrides()

ServerConfigError

Server settings are unsafe or do not match the public contract.

Example

from harnest.server import ServerConfigError

try:
    ...
except ServerConfigError as error:
    ...

ServerLimits

Set transport-independent limits enforced by the agent server.

ServerLimits(max_request_bytes: int = 1048576) -> None

Fields (— means no declared default):

Field	Type	Default
`max_request_bytes`	`int`	`1048576`

Parameters and example

Parameter	Type	Default
`max_request_bytes`	`int`	`1048576`

from harnest.server import ServerLimits

limits = ServerLimits()

load_server_config

Load server.yaml and resolve exact environment references.

load_server_config(path: str | Path, *, environment: Mapping[str, str] | None = None) -> ServerConfig

Parameters and example

Parameter	Type	Default
`path`	`str \| Path`	Required
`environment`	`Mapping[str, str] \| None`	`None`

from harnest.server import load_server_config

config = load_server_config(path=...)

Overview

Get started

Harnest Studio

Guides

API reference

harnest.server

Exports

HTTPServerConfig

PlaygroundConfig

ServerConfig

ServerConfig.with_overrides

ServerConfigError

ServerLimits

load_server_config

​Exports

​HTTPServerConfig

​PlaygroundConfig

​ServerConfig

​ServerConfig.with_overrides

​ServerConfigError

​ServerLimits

​load_server_config

Exports

HTTPServerConfig

PlaygroundConfig

ServerConfig

ServerConfig.with_overrides

ServerConfigError

ServerLimits

load_server_config