pi-agent-integration
von sentry
Integrate the latest `@earendil-works/pi-agent-core` APIs into an app, library, runtime, or agent harness. Use for Pi `Agent`, `AgentHarness`, streaming…
npx skills add https://github.com/getsentry/junior --skill pi-agent-integrationImplement Pi consumers against the latest published API. Keep streaming stable, queue behavior explicit, and wrapper code small.
Step 1: Classify the request
| Request type | Read first |
|---|---|
Wire or update Agent, loop, provider, stream, or tool APIs | references/api-surface.md |
| Add Pi behavior in an app, library, runtime, or adapter | references/common-use-cases.md |
Use AgentHarness, sessions, skills, resources, compaction, or execution helpers | references/harness.md |
| Debug streaming, tools, queues, continuation, proxy, abort, or harness failures | references/troubleshooting-workarounds.md |
Load each reference that the task needs. Keep guidance Pi-specific unless the user asks about a consuming product.
Step 2: Apply integration guardrails
- Check npm
latestfor@earendil-works/pi-agent-corebefore relying on a contract. Treat the published package as authoritative. Treat upstreammainas unreleased evidence. - Pass a
streamFnwhen constructingAgent. Also pass it as the last argument to low-level loop functions. - Use
Agentwhen event handling must finish before run settlement. UseagentLooponly when an observational event stream is enough. - Stream user-visible text only from
message_updatewhenassistantMessageEvent.type === "text_delta". - Preserve assistant message boundaries when forwarding multi-message output.
- Do not call
prompt(),continue(), orreset()while an agent is active. Queue mid-run input withsteer()orfollowUp(). - Continue a normal run only from a non-empty
userortoolResulttail. Anassistanttail can only drain queued steering or follow-up messages. - Keep
streamFn,convertToLlm,transformContext,getApiKey, queue providers, and loop hooks no-throw for expected failures. Return safe values or encode the failure in stream events. - Keep tool calls, progress, results, thinking deltas, and provider payloads internal unless the product exposes them on purpose.
- In
0.84.1, do not recommendAgentHarnessrun, queue, hook, or navigation paths for production use. They are scaffold APIs and most reject withHarnessNotImplemented. Use bareAgent, session APIs, and standalone helpers until the published implementation is complete.
Step 3: Implement with minimal surface
- Prefer Pi options over wrapper state machines:
streamFn,getApiKey,sessionId,thinkingBudgets,transport,maxRetryDelayMs,onPayload,onResponse,beforeToolCall,afterToolCall,shouldStopAfterTurn,prepareNextTurnWithContext,toolExecution,steeringMode, andfollowUpMode. - Mutate
Agentthroughagent.stateand public runtime options. Callreset()only when idle. - Use
transformContextfor message-level pruning or injection. UseconvertToLlmfor provider-compatible role conversion and filtering. - Set queue modes to
"one-at-a-time"or"all"when ordering or batching matters. - Use
streamFnwithstreamProxy-style behavior for server-proxied model access. - Use
toolExecution, per-toolexecutionMode,beforeToolCall,afterToolCall, thrown tool errors, andterminatebefore adding a custom tool runner. - Keep timeout and abort paths observable. Make sure streams and iterables settle.
Step 4: Verify behavior
- Verify the event bridge emits only text deltas, preserves intended boundaries, and closes on success, error, and abort.
- Verify active-run handling for
prompt(),continue(), andreset(). Verify queuedsteer()andfollowUp()behavior. - Verify
continue()with empty history and withuser,toolResult, andassistanttails. - Verify custom messages remain in agent state while
convertToLlmemits only provider-compatible messages. - Verify
streamFnencodes expected provider failures instead of throwing or rejecting. - Verify parallel and sequential tool ordering, hook blocking and patches, progress updates, usage, added tools, and termination.
- Verify
Agent.subscribe()listener settlement andwaitForIdle()with async listeners. - When reviewing the
AgentHarnessscaffold, verify implemented status in the published source before recommending any method.
Step 5: Keep version discipline
- Target npm
latestonly. - Re-check package metadata, declarations, implementation, README, and changelog before a material API update.
- Do not present unreleased
mainbehavior as published behavior. - Do not add compatibility shims or old package guidance unless the user asks for a migration.