Skip to content

reach.runtime

Agent execution runtime interfaces, selection outcomes, and driver options models.

Define the core AgentRuntime interface and shared runtime agent helpers.

AgentOptions

Bases: BaseModel

Base configuration common to all agent drivers.

Source code in src/reach/runtime/__init__.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
class AgentOptions(BaseModel):
    """Base configuration common to all agent drivers."""

    model_config = ConfigDict(frozen=True, extra="forbid", str_strip_whitespace=True)

    model: str = ""
    effort: str | None = None
    provider: str | None = None
    max_turns: int = Field(default=3, ge=1)
    early_exit: bool = True
    allowed_tools: tuple[str, ...] | None = None
    blocked_env_vars: tuple[str, ...] | None = None
    api_key: str | None = None
    use_symlinks: bool = True
    isolate_config_dir: bool = True
    auto_clean: bool = False
    json_schema: str | None = None

    #: Name of the field configuring an explicit isolation directory, if supported.
    isolation_dir_field: ClassVar[str | None] = None

    @property
    def custom_isolation_dir(self) -> Path | None:
        """Return custom isolation directory path configured on this options instance, if any."""
        if self.isolation_dir_field:
            val = getattr(self, self.isolation_dir_field, None)
            return Path(val) if val is not None else None
        return None

    @model_validator(mode="after")
    def _validate_isolation_dir_boundary(self) -> Self:
        """Validate that custom isolation directory does not point to active home or root."""
        if self.isolation_dir_field and self.custom_isolation_dir is not None:
            from reach.runtime._fs import validate_isolated_directory

            validate_isolated_directory(self.custom_isolation_dir, self.isolation_dir_field)
        return self

custom_isolation_dir property 

custom_isolation_dir: Path | None

Return custom isolation directory path configured on this options instance, if any.

AgentRuntime

Bases: ABC

Define standard abstract base class for agent runtime implementations.

Source code in src/reach/runtime/__init__.py 
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
class AgentRuntime[OptionsT: AgentOptions](ABC):
    """Define standard abstract base class for agent runtime implementations."""

    name: str
    settings: RuntimeSettings | None = None
    options: OptionsT = cast("Any", AgentOptions())
    api_key_env_var: str | None = None
    _resident: tuple[str, ...] = ()
    is_dynamic: bool = False

    def __init__(
        self,
        settings: RuntimeSettings | None = None,
        options: OptionsT | None = None,
    ) -> None:
        """Initialize agent runtime settings and options."""
        agent_name = getattr(self, "name", "agent")
        self.settings = settings
        if options is not None:
            self.options = options
        elif settings is not None:
            resolved = resolve_options(settings)
            opt_cls = options_model(agent_name)
            if opt_cls is not None and issubclass(opt_cls, AgentOptions):
                self.options = cast(
                    "OptionsT",
                    resolved
                    if isinstance(resolved, opt_cls)
                    else opt_cls.model_validate(dict(settings.options or {})),
                )
            else:
                self.options = cast(
                    "OptionsT",
                    resolved
                    if isinstance(resolved, AgentOptions)
                    else AgentOptions.model_validate(dict(settings.options or {})),
                )
        else:
            opt_cls = options_model(agent_name)
            if opt_cls is not None and issubclass(opt_cls, AgentOptions):
                self.options = cast("OptionsT", opt_cls())
            else:
                self.options = cast("OptionsT", AgentOptions())
        self._resident = ()

    @property
    def timeout_s(self) -> int | None:
        """Return per-probe execution timeout in seconds from settings."""
        return self.settings.timeout_s if self.settings is not None else None

    @property
    def skills_subpath(self) -> str:
        """Return relative skill directory subpath from profile or runtime default."""
        profile = agent_profiles().get(self.name)

        if profile is not None and profile.skills_dir:
            return profile.skills_dir
        if subpath := getattr(self, "_skills_subpath", None):
            return str(subpath)
        return ""

    @property
    def model(self) -> str:
        """Return the identifier of the model being evaluated."""
        return self.options.model

    @model.setter
    def model(self, value: str) -> None:
        """Update the configured model identifier in options."""
        self.options = self.options.model_copy(update={"model": value})

    @property
    def effort(self) -> str | None:
        """Return the reasoning effort tier being evaluated."""
        return self.options.effort

    @property
    def provider(self) -> str | None:
        """Return the model provider identifier being evaluated."""
        return self.options.provider

    @property
    def max_turns(self) -> int:
        """Return the maximum turns configured on the runtime options."""
        return self.options.max_turns

    @property
    def early_exit(self) -> bool:
        """Return whether early exit is enabled on the runtime options."""
        return self.options.early_exit

    @property
    def api_key(self) -> str | None:
        """Return the API key string configured on the runtime options."""
        return self.options.api_key

    @property
    def allowed_tools(self) -> tuple[str, ...] | None:
        """Return explicit allowed tools override from options or settings."""
        return (
            self.options.allowed_tools
            if self.options.allowed_tools is not None
            else getattr(self.settings, "allowed_tools", None)
        )

    @property
    def blocked_env_vars(self) -> tuple[str, ...] | None:
        """Return explicit blocked environment variables override from options or settings."""
        return resolve_blocked_env_vars(self.options, self.settings)

    @property
    def use_symlinks(self) -> bool:
        """Return whether symlink installation is enabled on the runtime options."""
        return self.options.use_symlinks

    @property
    def isolate_config_dir(self) -> bool:
        """Return whether isolated runtime config is enabled on the runtime options."""
        return self.options.isolate_config_dir

    @property
    def auto_clean(self) -> bool:
        """Return whether automatic post-probe cleanup is enabled on the runtime options."""
        return self.options.auto_clean

    @property
    def rations_catalog(self) -> bool:
        """Return True if this runtime actively rations skill listing budgets."""
        return False

    @property
    def is_cli(self) -> bool:
        """Return True if this runtime executes via a CLI subprocess."""
        return False

    @property
    def isolation_dir_field(self) -> str | None:
        """Return the options field name used for custom directory isolation, if supported."""
        return getattr(self.options, "isolation_dir_field", None)

    @property
    def custom_isolation_dir(self) -> Path | None:
        """Return the configured custom isolation directory path, or None."""
        return getattr(self.options, "custom_isolation_dir", None)

    def skills_dir(self, workdir: Path) -> Path:
        """Return standard skill directory path in the workspace."""
        return Path(workdir) / self.skills_subpath

    def skill_roots(self, workdir: Path) -> tuple[SkillRoot, ...]:
        """Return discovery directories where runtime searches for skills."""
        here = self.skills_dir(resolve_path(workdir))
        return (SkillRoot(path=here, scope="project", precedence=0),) if here.is_dir() else ()

    def fit(self, catalog: Catalog, skills: Iterable[Skill]) -> CatalogFit:  # noqa: ARG002
        """Evaluate whether a catalog fits listing budgets without materializing."""
        return CatalogFit()

    def install(self, catalog: Catalog, skills: Iterable[Skill], workdir: Path) -> Path:
        """Materialize resident skills in workspace and return workspace path."""
        target = resolve_path(workdir)
        self._validate_install(target)
        by_name = resolve_catalog_skills(catalog, skills)
        self._resident = install_skills(
            catalog,
            by_name,
            self.skills_dir(target),
            use_symlinks=self.use_symlinks,
        )
        self._post_install(target)
        return target

    def _validate_install(self, workdir: Path) -> None:
        """Validate workspace preconditions before installation."""
        del workdir

    def _post_install(self, workdir: Path) -> None:
        """Configure permissions or settings after installation."""
        del workdir

    def post_probe(self, workdir: Path) -> None:
        """Execute post-probe cleanup actions."""
        del workdir

    def clone_isolated(self) -> Self:
        """Create a thread-local isolated clone of this runtime."""
        clone = copy.copy(self)
        clone._resident = ()  # noqa: SLF001
        return clone

    def cleanup(self) -> None:  # noqa: B027
        """Release any isolated temporary resources owned by this runtime."""

    def build_env(self, workdir: Path | None = None) -> dict[str, str]:
        """Assemble process environment with API keys and workspace overrides."""
        del workdir
        env = dict(os.environ)
        if (home_dir := getattr(self.options, "home_dir", None)) is not None:
            env["HOME"] = str(home_dir)
        if api_key_var := self.api_key_env_var:
            if (api_key := self.api_key) is not None:
                env[api_key_var] = str(api_key)
            elif not env.get(api_key_var) and (resolved := resolve_env_secret(env, api_key_var)):
                env[api_key_var] = resolved
            env.pop(f"{api_key_var}_FILE", None)
        return sanitize_subprocess_env(env, blocked_env_vars=self.blocked_env_vars)

    def _make_tracker(self, target_skill: str | None = None) -> TrajectoryTracker:
        """Create a TrajectoryTracker configured with this runtime's turn and early-exit options."""
        return TrajectoryTracker(
            target_skill=target_skill,
            max_turns=self.options.max_turns,
            early_exit=self.options.early_exit,
        )

    @abstractmethod
    def select(
        self,
        query_text: str,
        workdir: Path,
        target_skill: str | None = None,
    ) -> SelectionOutcome:
        """Execute a single query probe and return the observed skill selection."""
        ...

    @property
    def effective_effort(self) -> str | None:
        """Return configured reasoning effort or default from model profile."""
        options = getattr(self, "options", None)
        if options is not None and (effort := getattr(options, "effort", None)):
            return None if effort.lower() in ("none", "off") else effort
        try:
            return model_profile(self.model).effort
        except (KeyError, ValueError):
            return None

    def resident_skill_paths(self, workdir: Path) -> frozenset[Path]:
        """Return set of valid filesystem directory paths for resident skills."""
        skills_dir = self.skills_dir(resolve_path(workdir))
        return frozenset(resolve_path(skills_dir / name) for name in self._resident)

    def parse_stream(
        self,
        lines: Iterable[str],
        resident: Sequence[str] = (),
        early_exit: bool = False,
    ) -> SessionSummary:
        """Parse transcript or log lines into a standardized SessionSummary.

        Default implementation records early_exit and assigns SUCCESS status
        if lines were produced. Subclasses override this to extract tool
        invocations, reasoning, and telemetry.
        """
        del resident
        line_list = list(lines)
        return SessionSummary(
            early_exit=early_exit,
            status=SessionStatus.SUCCESS if line_list else None,
        )

allowed_tools property 

allowed_tools: tuple[str, ...] | None

Return explicit allowed tools override from options or settings.

api_key property 

api_key: str | None

Return the API key string configured on the runtime options.

auto_clean property 

auto_clean: bool

Return whether automatic post-probe cleanup is enabled on the runtime options.

blocked_env_vars property 

blocked_env_vars: tuple[str, ...] | None

Return explicit blocked environment variables override from options or settings.

custom_isolation_dir property 

custom_isolation_dir: Path | None

Return the configured custom isolation directory path, or None.

early_exit property 

early_exit: bool

Return whether early exit is enabled on the runtime options.

effective_effort property 

effective_effort: str | None

Return configured reasoning effort or default from model profile.

effort property 

effort: str | None

Return the reasoning effort tier being evaluated.

is_cli property 

is_cli: bool

Return True if this runtime executes via a CLI subprocess.

isolate_config_dir property 

isolate_config_dir: bool

Return whether isolated runtime config is enabled on the runtime options.

isolation_dir_field property 

isolation_dir_field: str | None

Return the options field name used for custom directory isolation, if supported.

max_turns property 

max_turns: int

Return the maximum turns configured on the runtime options.

model property writable 

model: str

Return the identifier of the model being evaluated.

provider property 

provider: str | None

Return the model provider identifier being evaluated.

rations_catalog property 

rations_catalog: bool

Return True if this runtime actively rations skill listing budgets.

skills_subpath property 

skills_subpath: str

Return relative skill directory subpath from profile or runtime default.

timeout_s property 

timeout_s: int | None

Return per-probe execution timeout in seconds from settings.

use_symlinks: bool

Return whether symlink installation is enabled on the runtime options.

__init__ 

__init__(
    settings: RuntimeSettings | None = None,
    options: OptionsT | None = None,
) -> None

Initialize agent runtime settings and options.

Source code in src/reach/runtime/__init__.py 
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
def __init__(
    self,
    settings: RuntimeSettings | None = None,
    options: OptionsT | None = None,
) -> None:
    """Initialize agent runtime settings and options."""
    agent_name = getattr(self, "name", "agent")
    self.settings = settings
    if options is not None:
        self.options = options
    elif settings is not None:
        resolved = resolve_options(settings)
        opt_cls = options_model(agent_name)
        if opt_cls is not None and issubclass(opt_cls, AgentOptions):
            self.options = cast(
                "OptionsT",
                resolved
                if isinstance(resolved, opt_cls)
                else opt_cls.model_validate(dict(settings.options or {})),
            )
        else:
            self.options = cast(
                "OptionsT",
                resolved
                if isinstance(resolved, AgentOptions)
                else AgentOptions.model_validate(dict(settings.options or {})),
            )
    else:
        opt_cls = options_model(agent_name)
        if opt_cls is not None and issubclass(opt_cls, AgentOptions):
            self.options = cast("OptionsT", opt_cls())
        else:
            self.options = cast("OptionsT", AgentOptions())
    self._resident = ()

build_env 

build_env(workdir: Path | None = None) -> dict[str, str]

Assemble process environment with API keys and workspace overrides.

Source code in src/reach/runtime/__init__.py 
830
831
832
833
834
835
836
837
838
839
840
841
842
def build_env(self, workdir: Path | None = None) -> dict[str, str]:
    """Assemble process environment with API keys and workspace overrides."""
    del workdir
    env = dict(os.environ)
    if (home_dir := getattr(self.options, "home_dir", None)) is not None:
        env["HOME"] = str(home_dir)
    if api_key_var := self.api_key_env_var:
        if (api_key := self.api_key) is not None:
            env[api_key_var] = str(api_key)
        elif not env.get(api_key_var) and (resolved := resolve_env_secret(env, api_key_var)):
            env[api_key_var] = resolved
        env.pop(f"{api_key_var}_FILE", None)
    return sanitize_subprocess_env(env, blocked_env_vars=self.blocked_env_vars)

cleanup 

cleanup() -> None

Release any isolated temporary resources owned by this runtime.

Source code in src/reach/runtime/__init__.py 
827
828
def cleanup(self) -> None:  # noqa: B027
    """Release any isolated temporary resources owned by this runtime."""

clone_isolated 

clone_isolated() -> Self

Create a thread-local isolated clone of this runtime.

Source code in src/reach/runtime/__init__.py 
821
822
823
824
825
def clone_isolated(self) -> Self:
    """Create a thread-local isolated clone of this runtime."""
    clone = copy.copy(self)
    clone._resident = ()  # noqa: SLF001
    return clone

fit 

fit(
    catalog: Catalog, skills: Iterable[Skill]
) -> CatalogFit

Evaluate whether a catalog fits listing budgets without materializing.

Source code in src/reach/runtime/__init__.py 
791
792
793
def fit(self, catalog: Catalog, skills: Iterable[Skill]) -> CatalogFit:  # noqa: ARG002
    """Evaluate whether a catalog fits listing budgets without materializing."""
    return CatalogFit()

install 

install(
    catalog: Catalog, skills: Iterable[Skill], workdir: Path
) -> Path

Materialize resident skills in workspace and return workspace path.

Source code in src/reach/runtime/__init__.py 
795
796
797
798
799
800
801
802
803
804
805
806
807
def install(self, catalog: Catalog, skills: Iterable[Skill], workdir: Path) -> Path:
    """Materialize resident skills in workspace and return workspace path."""
    target = resolve_path(workdir)
    self._validate_install(target)
    by_name = resolve_catalog_skills(catalog, skills)
    self._resident = install_skills(
        catalog,
        by_name,
        self.skills_dir(target),
        use_symlinks=self.use_symlinks,
    )
    self._post_install(target)
    return target

parse_stream 

parse_stream(
    lines: Iterable[str],
    resident: Sequence[str] = (),
    early_exit: bool = False,
) -> SessionSummary

Parse transcript or log lines into a standardized SessionSummary.

Default implementation records early_exit and assigns SUCCESS status if lines were produced. Subclasses override this to extract tool invocations, reasoning, and telemetry.

Source code in src/reach/runtime/__init__.py 
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
def parse_stream(
    self,
    lines: Iterable[str],
    resident: Sequence[str] = (),
    early_exit: bool = False,
) -> SessionSummary:
    """Parse transcript or log lines into a standardized SessionSummary.

    Default implementation records early_exit and assigns SUCCESS status
    if lines were produced. Subclasses override this to extract tool
    invocations, reasoning, and telemetry.
    """
    del resident
    line_list = list(lines)
    return SessionSummary(
        early_exit=early_exit,
        status=SessionStatus.SUCCESS if line_list else None,
    )

post_probe 

post_probe(workdir: Path) -> None

Execute post-probe cleanup actions.

Source code in src/reach/runtime/__init__.py 
817
818
819
def post_probe(self, workdir: Path) -> None:
    """Execute post-probe cleanup actions."""
    del workdir

resident_skill_paths 

resident_skill_paths(workdir: Path) -> frozenset[Path]

Return set of valid filesystem directory paths for resident skills.

Source code in src/reach/runtime/__init__.py 
873
874
875
876
def resident_skill_paths(self, workdir: Path) -> frozenset[Path]:
    """Return set of valid filesystem directory paths for resident skills."""
    skills_dir = self.skills_dir(resolve_path(workdir))
    return frozenset(resolve_path(skills_dir / name) for name in self._resident)

select abstractmethod 

select(
    query_text: str,
    workdir: Path,
    target_skill: str | None = None,
) -> SelectionOutcome

Execute a single query probe and return the observed skill selection.

Source code in src/reach/runtime/__init__.py 
852
853
854
855
856
857
858
859
860
@abstractmethod
def select(
    self,
    query_text: str,
    workdir: Path,
    target_skill: str | None = None,
) -> SelectionOutcome:
    """Execute a single query probe and return the observed skill selection."""
    ...

skill_roots 

skill_roots(workdir: Path) -> tuple[SkillRoot, ...]

Return discovery directories where runtime searches for skills.

Source code in src/reach/runtime/__init__.py 
786
787
788
789
def skill_roots(self, workdir: Path) -> tuple[SkillRoot, ...]:
    """Return discovery directories where runtime searches for skills."""
    here = self.skills_dir(resolve_path(workdir))
    return (SkillRoot(path=here, scope="project", precedence=0),) if here.is_dir() else ()

skills_dir 

skills_dir(workdir: Path) -> Path

Return standard skill directory path in the workspace.

Source code in src/reach/runtime/__init__.py 
782
783
784
def skills_dir(self, workdir: Path) -> Path:
    """Return standard skill directory path in the workspace."""
    return Path(workdir) / self.skills_subpath

AntigravityOptions

Bases: VertexOptions

Configure common options for Antigravity-ecosystem agent runtimes.

Source code in src/reach/runtime/__init__.py 
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
class AntigravityOptions(VertexOptions):
    """Configure common options for Antigravity-ecosystem agent runtimes."""

    use_symlinks: bool = False

    @property
    def effective_vertex(self) -> bool:
        """Return True if Vertex AI / Enterprise ADC mode is active.

        When vertex is not explicitly set and no Vertex toggle env var is active,
        ambient GEMINI_API_KEY / GOOGLE_API_KEY takes precedence over implicit
        GOOGLE_CLOUD_PROJECT detection.
        """
        if self.vertex is not None:
            return self.vertex
        if has_agy_vertex_env(os.environ):
            return True
        has_api_key = bool(
            self.api_key or resolve_env_secret(os.environ, "GEMINI_API_KEY", "GOOGLE_API_KEY")
        )
        return not has_api_key and bool(self.project or resolve_registry_project(self.project))

    @property
    def effective_project(self) -> str | None:
        """Return resolved Google Cloud project ID when Vertex/ADC is active.

        When api_key is explicitly set alongside Vertex (Express Mode), omit
        ambient/registry project fallback because VertexEndpoint forbids combining
        api_key with regional project/location parameters.
        """
        if not self.effective_vertex:
            return None
        if self.api_key:
            return self.project
        return resolve_registry_project(self.project)

    @property
    def effective_location(self) -> str | None:
        """Return resolved Google Cloud location when Vertex/ADC is active.

        When api_key is explicitly set alongside Vertex (Express Mode), omit
        ambient/registry location fallback because VertexEndpoint forbids combining
        api_key with regional project/location parameters.
        """
        if not self.effective_vertex:
            return None
        if self.api_key:
            return self.location
        return resolve_registry_location(self.location)

    @property
    def effective_api_key(self) -> str | None:
        """Return configured API key or fallback to environment variables."""
        if self.api_key:
            return self.api_key
        if self.effective_vertex:
            return None
        return resolve_env_secret(os.environ, "GEMINI_API_KEY", "GOOGLE_API_KEY")

    def resolve_model_provider(self, model: str = "") -> str | None:
        """Resolve model provider unless Vertex/ADC mode is active without explicit provider."""
        if self.effective_vertex and not self.provider:
            return None
        return detect_model_provider(
            model or self.model,
            self.provider,
            api_key=self.api_key,
        )

    def resolve_schema_dict(
        self,
        schema: str | Mapping[str, Any] | None = None,
    ) -> dict[str, Any] | None:
        """Parse and validate explicit or configured JSON schema into a dictionary."""
        if isinstance(schema, Mapping):
            return dict(schema)
        raw_schema = schema if isinstance(schema, str) else self.json_schema
        if not raw_schema:
            return None
        try:
            parsed = json.loads(raw_schema)
        except json.JSONDecodeError as exc:
            msg = f"Invalid JSON schema: {exc}"
            raise ValueError(msg) from exc
        if not isinstance(parsed, dict):
            msg = f"Expected JSON schema object, got {type(parsed).__name__}"
            raise ValueError(msg)
        return parsed

effective_api_key property 

effective_api_key: str | None

Return configured API key or fallback to environment variables.

effective_location property 

effective_location: str | None

Return resolved Google Cloud location when Vertex/ADC is active.

When api_key is explicitly set alongside Vertex (Express Mode), omit ambient/registry location fallback because VertexEndpoint forbids combining api_key with regional project/location parameters.

effective_project property 

effective_project: str | None

Return resolved Google Cloud project ID when Vertex/ADC is active.

When api_key is explicitly set alongside Vertex (Express Mode), omit ambient/registry project fallback because VertexEndpoint forbids combining api_key with regional project/location parameters.

effective_vertex property 

effective_vertex: bool

Return True if Vertex AI / Enterprise ADC mode is active.

When vertex is not explicitly set and no Vertex toggle env var is active, ambient GEMINI_API_KEY / GOOGLE_API_KEY takes precedence over implicit GOOGLE_CLOUD_PROJECT detection.

resolve_model_provider 

resolve_model_provider(model: str = '') -> str | None

Resolve model provider unless Vertex/ADC mode is active without explicit provider.

Source code in src/reach/runtime/__init__.py 
193
194
195
196
197
198
199
200
201
def resolve_model_provider(self, model: str = "") -> str | None:
    """Resolve model provider unless Vertex/ADC mode is active without explicit provider."""
    if self.effective_vertex and not self.provider:
        return None
    return detect_model_provider(
        model or self.model,
        self.provider,
        api_key=self.api_key,
    )

resolve_schema_dict 

resolve_schema_dict(
    schema: str | Mapping[str, Any] | None = None,
) -> dict[str, Any] | None

Parse and validate explicit or configured JSON schema into a dictionary.

Source code in src/reach/runtime/__init__.py 
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
def resolve_schema_dict(
    self,
    schema: str | Mapping[str, Any] | None = None,
) -> dict[str, Any] | None:
    """Parse and validate explicit or configured JSON schema into a dictionary."""
    if isinstance(schema, Mapping):
        return dict(schema)
    raw_schema = schema if isinstance(schema, str) else self.json_schema
    if not raw_schema:
        return None
    try:
        parsed = json.loads(raw_schema)
    except json.JSONDecodeError as exc:
        msg = f"Invalid JSON schema: {exc}"
        raise ValueError(msg) from exc
    if not isinstance(parsed, dict):
        msg = f"Expected JSON schema object, got {type(parsed).__name__}"
        raise ValueError(msg)
    return parsed

CatalogFit

Bases: BaseModel

Report catalog residency limits and potential description truncation metrics.

Source code in src/reach/runtime/__init__.py 
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
class CatalogFit(BaseModel):
    """Report catalog residency limits and potential description truncation metrics."""

    model_config = ConfigDict(frozen=True)

    allowed: int = Field(default=0, ge=0)
    asked: int = Field(default=0, ge=0)
    unit: str = ""
    truncated: int = Field(default=0, ge=0)
    remedy: str = ""
    elided_skills: tuple[str, ...] = ()

    @property
    def rations(self) -> bool:
        """Return True if the runtime enforces space limitations on catalog listings."""
        return self.allowed > 0

    @property
    def whole(self) -> bool:
        """Return True if all skills are presented without description truncation."""
        return not self.truncated

rations property 

rations: bool

Return True if the runtime enforces space limitations on catalog listings.

whole property 

whole: bool

Return True if all skills are presented without description truncation.

CliOptions

Bases: AgentOptions

Hold common configuration options for CLI subprocess-driven agent runtimes.

Source code in src/reach/runtime/__init__.py 
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
class CliOptions(AgentOptions):
    """Hold common configuration options for CLI subprocess-driven agent runtimes."""

    executable: str = ""
    extra_args: tuple[str, ...] = ()

    def effort_args(self, flag: str = "--effort") -> list[str]:
        """Format CLI argument pair for non-empty effort setting."""
        return [flag, self.effort] if self.effort else []

    def provider_args(self, flag: str = "--provider") -> list[str]:
        """Format CLI argument pair for non-empty provider setting."""
        return [flag, self.provider] if self.provider else []

    def max_turns_args(self, flag: str = "--max-turns") -> list[str]:
        """Format CLI argument pair for non-None max_turns setting."""
        return [flag, str(self.max_turns)] if self.max_turns is not None else []

    def api_key_args(self, flag: str = "--api-key") -> list[str]:
        """Format CLI argument pair for non-empty api_key setting."""
        return [flag, self.api_key] if self.api_key else []

api_key_args 

api_key_args(flag: str = '--api-key') -> list[str]

Format CLI argument pair for non-empty api_key setting.

Source code in src/reach/runtime/__init__.py 
242
243
244
def api_key_args(self, flag: str = "--api-key") -> list[str]:
    """Format CLI argument pair for non-empty api_key setting."""
    return [flag, self.api_key] if self.api_key else []

effort_args 

effort_args(flag: str = '--effort') -> list[str]

Format CLI argument pair for non-empty effort setting.

Source code in src/reach/runtime/__init__.py 
230
231
232
def effort_args(self, flag: str = "--effort") -> list[str]:
    """Format CLI argument pair for non-empty effort setting."""
    return [flag, self.effort] if self.effort else []

max_turns_args 

max_turns_args(flag: str = '--max-turns') -> list[str]

Format CLI argument pair for non-None max_turns setting.

Source code in src/reach/runtime/__init__.py 
238
239
240
def max_turns_args(self, flag: str = "--max-turns") -> list[str]:
    """Format CLI argument pair for non-None max_turns setting."""
    return [flag, str(self.max_turns)] if self.max_turns is not None else []

provider_args 

provider_args(flag: str = '--provider') -> list[str]

Format CLI argument pair for non-empty provider setting.

Source code in src/reach/runtime/__init__.py 
234
235
236
def provider_args(self, flag: str = "--provider") -> list[str]:
    """Format CLI argument pair for non-empty provider setting."""
    return [flag, self.provider] if self.provider else []

SelectionOutcome

Bases: _ProbeTelemetry

Represent the observable result of probing an agent runtime with a query.

Source code in src/reach/runtime/__init__.py 
390
391
392
393
394
395
396
397
398
399
400
401
402
403
class SelectionOutcome(_ProbeTelemetry):
    """Represent the observable result of probing an agent runtime with a query."""

    @model_validator(mode="before")
    @classmethod
    def _enforce_early_exit_invariants(cls, data: Any) -> Any:  # noqa: ANN401
        """Ensure process cancellation artifacts are never reported as probe errors."""
        if isinstance(data, dict):
            early = data.get("early_exit", False)
            err = data.get("error")
            if early and err and not str(err).startswith(("tool leak", "residency leak")):
                data = dict(data)
                data["error"] = None
        return data

SessionStatus

Bases: StrEnum

Enumerate canonical terminal execution statuses of an agent session.

Source code in src/reach/runtime/__init__.py 
290
291
292
293
294
295
296
class SessionStatus(StrEnum):
    """Enumerate canonical terminal execution statuses of an agent session."""

    CANCELLED = "CANCELLED"
    ERROR = "ERROR"
    SUCCESS = "SUCCESS"
    TIMEOUT = "TIMEOUT"

SessionSummary

Bases: _ProbeTelemetry

Hold parsed session outcomes and telemetry across CLI runtime logs.

Source code in src/reach/runtime/__init__.py 
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
class SessionSummary(_ProbeTelemetry):
    """Hold parsed session outcomes and telemetry across CLI runtime logs."""

    tool_calls: tuple[ToolCallInfo, ...] = ()
    status: SessionStatus | str | None = None
    retries: int = 0

    @field_validator("status", mode="before")
    @classmethod
    def _normalize_status(cls, value: object) -> SessionStatus | str | None:
        """Coerce known status variants to canonical SessionStatus enum members."""
        if value is None or isinstance(value, SessionStatus):
            return value
        if isinstance(value, str):
            normalized = value.strip()
            upper = normalized.upper()
            try:
                return SessionStatus(upper)
            except ValueError:
                return normalized
        return str(value)

    @property
    def saw_result(self) -> bool:
        """Return True if stream contained a terminal result event or early exit."""
        return self.status is not None or self.early_exit

    @model_validator(mode="before")
    @classmethod
    def _derive_observed_tools(cls, data: Any) -> Any:  # noqa: ANN401
        """Populate observed tools from tool calls if not explicitly provided."""
        if isinstance(data, dict):
            calls = data.get("tool_calls")
            if calls and not data.get("observed_tools"):
                names = sorted(
                    {c.name if hasattr(c, "name") else c.get("name") for c in calls if c}
                )
                data = dict(data)
                data["observed_tools"] = tuple(n for n in names if n)
        return data

    def to_outcome(
        self,
        observed_catalog: tuple[str, ...] | list[str] = (),
        fallback_model: str = "",
        early_exit: bool = False,
        turns_taken: int | None = None,
    ) -> SelectionOutcome:
        """Convert parsed session summary into a canonical SelectionOutcome."""
        effective_early_exit = early_exit or self.early_exit
        turns = turns_taken if turns_taken is not None else self.turns_taken

        catalog = tuple(observed_catalog) or self.observed_catalog
        return SelectionOutcome(
            cost_usd=self.cost_usd,
            duration_ms=self.duration_ms,
            prompt_tokens=self.prompt_tokens,
            error=self.error,
            invoked_skills=self.invoked_skills,
            early_exit=effective_early_exit,
            turns_taken=turns,
            observed_tools=self.observed_tools,
            reasoning=self.reasoning,
            resolved_model=self.resolved_model or fallback_model,
            observed_catalog=catalog,
        )

saw_result property 

saw_result: bool

Return True if stream contained a terminal result event or early exit.

to_outcome 

to_outcome(
    observed_catalog: tuple[str, ...] | list[str] = (),
    fallback_model: str = "",
    early_exit: bool = False,
    turns_taken: int | None = None,
) -> SelectionOutcome

Convert parsed session summary into a canonical SelectionOutcome.

Source code in src/reach/runtime/__init__.py 
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
def to_outcome(
    self,
    observed_catalog: tuple[str, ...] | list[str] = (),
    fallback_model: str = "",
    early_exit: bool = False,
    turns_taken: int | None = None,
) -> SelectionOutcome:
    """Convert parsed session summary into a canonical SelectionOutcome."""
    effective_early_exit = early_exit or self.early_exit
    turns = turns_taken if turns_taken is not None else self.turns_taken

    catalog = tuple(observed_catalog) or self.observed_catalog
    return SelectionOutcome(
        cost_usd=self.cost_usd,
        duration_ms=self.duration_ms,
        prompt_tokens=self.prompt_tokens,
        error=self.error,
        invoked_skills=self.invoked_skills,
        early_exit=effective_early_exit,
        turns_taken=turns,
        observed_tools=self.observed_tools,
        reasoning=self.reasoning,
        resolved_model=self.resolved_model or fallback_model,
        observed_catalog=catalog,
    )

SkillRoot

Bases: BaseModel

Represent a skill discovery directory location and its resolution precedence.

Source code in src/reach/runtime/__init__.py 
473
474
475
476
477
478
479
480
class SkillRoot(BaseModel):
    """Represent a skill discovery directory location and its resolution precedence."""

    model_config = ConfigDict(frozen=True)

    path: Path
    scope: str
    precedence: int = Field(default=0, ge=0)

ToolCallInfo

Bases: BaseModel

Represent an observed tool invocation and its parameters.

Source code in src/reach/runtime/__init__.py 
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
class ToolCallInfo(BaseModel):
    """Represent an observed tool invocation and its parameters."""

    model_config = ConfigDict(frozen=True)

    name: str = ""
    parameters: dict[str, Any] = Field(default_factory=dict)

    def __init__(
        self,
        name: str = "",
        parameters: dict[str, Any] | None = None,
        path: str | None = None,
        **data: Any,  # noqa: ANN401
    ) -> None:
        """Initialize tool invocation with optional direct path argument."""
        params = dict(parameters or data.pop("parameters", None) or {})
        if path is not None and "path" not in params and "AbsolutePath" not in params:
            params["path"] = str(path)
        super().__init__(name=name, parameters=params, **data)

    @model_validator(mode="before")
    @classmethod
    def _coerce_path(cls, data: Any) -> Any:  # noqa: ANN401
        """Populate parameters with path keyword argument when provided directly."""
        if isinstance(data, dict) and ("path" in data or data.get("parameters") is None):
            data = dict(data)
            params = dict(data.get("parameters") or {})
            if "path" in data:
                val = data.pop("path")
                if val is not None and "path" not in params and "AbsolutePath" not in params:
                    params["path"] = str(val)
            data["parameters"] = params
        return data

    @property
    def path(self) -> str | None:
        """Extract first non-empty filesystem path from recognized tool parameters."""
        from reach.runtime._fs import extract_tool_path

        return extract_tool_path(self.parameters)

path property 

path: str | None

Extract first non-empty filesystem path from recognized tool parameters.

__init__ 

__init__(
    name: str = "",
    parameters: dict[str, Any] | None = None,
    path: str | None = None,
    **data: Any,
) -> None

Initialize tool invocation with optional direct path argument.

Source code in src/reach/runtime/__init__.py 
255
256
257
258
259
260
261
262
263
264
265
266
def __init__(
    self,
    name: str = "",
    parameters: dict[str, Any] | None = None,
    path: str | None = None,
    **data: Any,  # noqa: ANN401
) -> None:
    """Initialize tool invocation with optional direct path argument."""
    params = dict(parameters or data.pop("parameters", None) or {})
    if path is not None and "path" not in params and "AbsolutePath" not in params:
        params["path"] = str(path)
    super().__init__(name=name, parameters=params, **data)

VertexOptions

Bases: AgentOptions

Configure Google Cloud Vertex AI and Application Default Credentials options.

Source code in src/reach/runtime/__init__.py 
126
127
128
129
130
131
class VertexOptions(AgentOptions):
    """Configure Google Cloud Vertex AI and Application Default Credentials options."""

    vertex: bool | None = None
    project: str | None = None
    location: str | None = None

build_runtime 

build_runtime(settings: RuntimeSettings) -> AgentRuntime

Instantiate and configure an AgentRuntime from settings.

Source code in src/reach/runtime/__init__.py 
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
def build_runtime(settings: RuntimeSettings) -> AgentRuntime:
    """Instantiate and configure an AgentRuntime from settings."""
    if settings.agent in _AGENT_FACTORIES:
        rt = _AGENT_FACTORIES[settings.agent][0](settings)
    else:
        builtin = _load_builtin_entry(settings.agent)
        if builtin is not None:
            rt = builtin[0](settings)
        else:
            agents = ", ".join(known_agents())
            msg = f"unknown runtime agent {settings.agent!r}; expected one of {agents}"
            raise ValueError(msg)
    if getattr(rt, "settings", None) is None:
        rt.settings = settings
    return rt

known_agents 

known_agents(
    config_path: Path | str | None = None,
) -> tuple[str, ...]

Return tuple of supported agent runtime names from configuration.

Source code in src/reach/runtime/__init__.py 
572
573
574
575
576
577
578
def known_agents(config_path: Path | str | None = None) -> tuple[str, ...]:
    """Return tuple of supported agent runtime names from configuration."""
    profiles = agent_profiles(config_path)
    builtins = set(_BUILTIN_AGENTS.keys())
    if profiles:
        return tuple(sorted(set(profiles.keys()) | builtins | set(_AGENT_FACTORIES.keys())))
    return tuple(sorted(builtins | set(_AGENT_FACTORIES.keys())))

register_agent 

register_agent(
    name: str,
    factory: Callable[[RuntimeSettings], AgentRuntime],
    options: type[BaseModel] | None = None,
) -> None

Register a runtime factory and optional options schema for an agent name.

Source code in src/reach/runtime/__init__.py 
512
513
514
515
516
517
518
def register_agent(
    name: str,
    factory: Callable[[RuntimeSettings], AgentRuntime],
    options: type[BaseModel] | None = None,
) -> None:
    """Register a runtime factory and optional options schema for an agent name."""
    _AGENT_FACTORIES[name] = (factory, options)