interrupt

type Error ¶

type Error struct {
	// Kind distinguishes clarification pauses from approval pauses.
	Kind Kind

	// RequestID is the unique identifier of the pending request
	// (clarification ID or approval ID).
	RequestID string

	// Payload carries kind-specific metadata:
	//   - Clarify:  clarify.ClarificationEvent
	//   - Approval: hitl.ApprovalRequest
	Payload any
}

Error signals that a tool call needs external input (human approval, clarification, etc.) before it can complete.

In the current in-process executor (blocking mode), the middleware catches this internally and blocks on the store's wait channel — callers never see it. In a future Temporal executor (non-blocking mode), the workflow propagates the interrupt upward so it can be modelled as a Temporal signal wait.

The API mirrors [graph.InterruptError] from trpc-agent-go so that the two can be bridged without conversion when Temporal is adopted.

func Get(err error) (*Error, bool)

func (e *Error) Error() string

type Kind ¶

type Kind string

Kind identifies what type of human input is required.

const (
	// Clarify indicates the tool needs the user to answer a clarifying
	// question before execution can continue.
	Clarify Kind = "clarify"

	// Approval indicates the tool call requires human approval
	// (approve / reject) before execution can proceed.
	Approval Kind = "approval"
)