Expand description
Stable facade for embedding MicroClaw in Rust applications.
minimal exposes protocol contracts only, standard adds the embeddable runtime, and
full adds configuration-driven Agent Engine construction and Skill discovery.
Structs§
- Agent
- A reusable Agent handle with a fixed identity, prompt, Skills, and tool policy.
- Agent
Builder - Builder for an Agent identity and its selected Skills.
- Agent
Handle - AgentId
- Agent
Profile - Background
Job - A shell command running (or finished) in the background of a session:
started with
run_in_background, or moved there by the user while it ran. - Caller
Context - Checkpoint
- A workspace checkpoint (see
MicroClaw::checkpoint). - Context
Usage - How full a session’s context is (estimates; see
MicroClaw::context_usage). - Control
Request - A control message received by an executor that can be explicitly accepted or rejected.
- Delegated
Task - Stable SDK projection of a durable task delegated by the Main Agent.
- Execution
Context - Runtime-owned context passed to an execution engine for one run.
- Execution
Result - Local
Worker - Micro
Claw - A configured, embeddable MicroClaw runtime.
- Model
Usage - Token usage of one model within a session.
- Remote
Worker - A Worker backed by a versioned remote transport.
- Remote
Worker Options - Reconnection policy for remote Worker runs.
- RunController
- Cloneable control plane for a running task.
- RunHandle
- RunId
- RunRequest
- RunResult
- Runtime
- Runtime
Approval Option - Runtime
Builder - Runtime
Capabilities - Runtime
Error - Runtime
Event Envelope - Versioned transport envelope for replayable runtime event streams.
- Runtime
Plan Step - Runtime
Stats - Session
Compaction - Result of compacting a session.
- Session
Id - Session
Mark - A point in a session’s conversation ([
MicroClaw::session_mark]). Valid within the process that took it. - Session
Message - One stored message of a named session (see
MicroClaw::session_messages). - Session
Usage - Token usage of one session.
- Skill
Catalog - A snapshot of Skills discovered while the SDK runtime was initialized.
- Skill
Summary - Stable, UI-neutral metadata for one discovered Skill.
- Tool
Gate Call - Embedder tool gate (permission rules, hooks); see [
MicroClawBuilder::tool_gate]. One tool call as seen by the gate. - Tool
Gate Outcome - Embedder tool gate (permission rules, hooks); see [
MicroClawBuilder::tool_gate]. A decision plus an optional replacement input. - Tool
Gate Result - Embedder tool gate (permission rules, hooks); see [
MicroClawBuilder::tool_gate]. The tool result as seen byToolGate::after. - Worker
Descriptor - Worker
Health - Worker
Id
Enums§
- Delegated
Task Status - Lifecycle state for a task delegated by the Main Agent.
- RunStatus
- Runtime
Approval Decision - Runtime
Approval Option Kind - Runtime
Build Error - Runtime
Control - Runtime
Error Code - Runtime
Event - An observable event emitted by the shared agent runtime.
- Runtime
Plan Step Status - Runtime
Process Kind - SdkError
- An SDK-level error that does not expose Server or Agent Engine implementation types.
- SdkError
Code - Stable category for handling SDK failures without parsing display strings.
- Session
Message Role - Who wrote a
SessionMessage. - Tool
Gate Decision - Embedder tool gate (permission rules, hooks); see [
MicroClawBuilder::tool_gate]. What to do with a tool call. - Tool
Policy - Worker
Command - Transport-neutral command vocabulary for a remote Worker endpoint.
- Worker
Frame - Frames returned by a Worker transport. Events and the terminal result may be streamed over WebSocket/SSE or represented by repeated polling without changing their JSON shape.
- Worker
Health Status
Constants§
- INTERACTIVE_
APPROVALS RunRequest::metadatakey. Set it totrueand a tool call that needs a human pauses the run: the Agent Engine emitsApprovalRequiredand waits forRunController::resolve_approval_confirmed(approval_id, "1" | "2" | "3")(approve once, always allow the tool in this session, deny) instead of ending the run with a text prompt that the next message answers.- WORKER_
PROTOCOL_ VERSION
Traits§
- RunExecutor
- Product-independent execution port used by the Runtime.
- Tool
Gate - Embedder tool gate (permission rules, hooks); see [
MicroClawBuilder::tool_gate]. - Worker
- Worker
Connection - One ordered, bidirectional connection to a remote Worker endpoint.
- Worker
Transport - Creates independent remote Worker connections for discovery, health, and runs.