Skip to main content

Module schema

Module schema 

Source
Expand description

Versioned provider contract schema.

This module defines the machine-readable contract shared between provider adapters and agentctl:

  • adapter operation payloads (capabilities, healthcheck, execute, limits, auth-state)
  • normalized success/error envelopes
  • stable error categorization and retry semantics

Structs§

AuthStateRequest
Input payload for auth-state.
AuthStateResponse
Output payload for auth-state.
CapabilitiesRequest
Input payload for capabilities.
CapabilitiesResponse
Capability inventory.
Capability
Single declared capability.
ExecuteRequest
Input payload for execute.
ExecuteResponse
Output payload for execute.
HealthcheckRequest
Input payload for healthcheck.
HealthcheckResponse
Output payload for healthcheck.
LimitsRequest
Input payload for limits.
LimitsResponse
Output payload for limits.
ProviderEnvelope
Normalized envelope that agentctl can consume uniformly across providers.
ProviderError
Normalized provider error payload.
ProviderMetadata
Adapter metadata used by the provider trait.
ProviderRef
Provider identity included in each envelope for routing and diagnostics.

Enums§

AuthStateStatus
Authentication state categories.
ContractVersion
Supported provider contract versions.
HealthStatus
Provider health states.
ProviderErrorCategory
Stable error categorization for cross-provider policy handling.
ProviderMaturity
Provider maturity used for rollout and UX messaging.
ProviderOperation
Standardized adapter operations.
ProviderOutcome
Tagged envelope outcome to keep success/error shape stable over time.

Constants§

CONTRACT_VERSION_V1
Stable contract identifier for the v1 provider adapter schema.

Type Aliases§

ProviderResult
Normalized provider result type used by contract APIs.