{"_id":"@a7garden/agent-core","name":"@a7garden/agent-core","dist-tags":{"latest":"0.66.2"},"versions":{"0.66.2":{"name":"@a7garden/agent-core","version":"0.66.2","description":"General-purpose agent with transport abstraction, state management, and attachment support","type":"module","main":"./dist/index.js","types":"./dist/index.d.ts","scripts":{"clean":"shx rm -rf dist","build":"tsgo -p tsconfig.build.json","dev":"tsgo -p tsconfig.build.json --watch --preserveWatchOutput","test":"vitest --run","prepublishOnly":"npm run clean && npm run build"},"dependencies":{"@a7garden/ai":"^0.66.2"},"keywords":["ai","agent","llm","transport","state-management"],"author":{"name":"Mario Zechner"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/badlogic/oxipi.git","directory":"packages/agent"},"engines":{"node":">=20.0.0"},"devDependencies":{"@types/node":"^24.3.0","typescript":"^5.7.3","vitest":"^3.2.4"},"gitHead":"0efd57439c27ecc869444e13a7ab1999c02c5bf5","_id":"@a7garden/agent-core@0.66.2","bugs":{"url":"https://github.com/badlogic/oxipi/issues"},"homepage":"https://github.com/badlogic/oxipi#readme","_nodeVersion":"24.14.1","_npmVersion":"11.11.0","dist":{"integrity":"sha512-CTVe1kI31dk6CopyOMfgNH8MO0ITn0d3daRgXwUl1nzXON4L7KZ8/BgIk5M8BBiAFX9TdZQHtm1Y21P4Z6ItBw==","shasum":"fedec794f269a94b2ab6628e94dacf127dc82c5d","tarball":"https://registry.npmjs.org/@a7garden/agent-core/-/agent-core-0.66.2.tgz","fileCount":22,"unpackedSize":246013,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDEZQT1B5wgnHJ2DmNykAzl+sLd4tjR7Zf8B86KdJI3BwIhAMuhE7yTeagYtWukZHbkLq3gvZxsicViQfvN2yW2zl4c"}]},"_npmUser":{"name":"a7garden","email":"a7garden@icloud.com"},"directories":{},"maintainers":[{"name":"a7garden","email":"a7garden@icloud.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/agent-core_0.66.2_1775996874899_0.8048726494765692"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-12T12:27:54.813Z","0.66.2":"2026-04-12T12:27:55.028Z","modified":"2026-04-12T12:27:55.224Z"},"maintainers":[{"name":"a7garden","email":"a7garden@icloud.com"}],"description":"General-purpose agent with transport abstraction, state management, and attachment support","homepage":"https://github.com/badlogic/oxipi#readme","keywords":["ai","agent","llm","transport","state-management"],"repository":{"type":"git","url":"git+https://github.com/badlogic/oxipi.git","directory":"packages/agent"},"author":{"name":"Mario Zechner"},"bugs":{"url":"https://github.com/badlogic/oxipi/issues"},"license":"MIT","readme":"# @oxipi/agent-core\n\nStateful agent with tool execution and event streaming. Built on `@oxipi/ai`.\n\n## Installation\n\n```bash\nnpm install @oxipi/agent-core\n```\n\n## Quick Start\n\n```typescript\nimport { Agent } from \"@oxipi/agent-core\";\nimport { getModel } from \"@oxipi/ai\";\n\nconst agent = new Agent({\n  initialState: {\n    systemPrompt: \"You are a helpful assistant.\",\n    model: getModel(\"anthropic\", \"claude-sonnet-4-20250514\"),\n  },\n});\n\nagent.subscribe((event) => {\n  if (event.type === \"message_update\" && event.assistantMessageEvent.type === \"text_delta\") {\n    // Stream just the new text chunk\n    process.stdout.write(event.assistantMessageEvent.delta);\n  }\n});\n\nawait agent.prompt(\"Hello!\");\n```\n\n## Core Concepts\n\n### AgentMessage vs LLM Message\n\nThe agent works with `AgentMessage`, a flexible type that can include:\n- Standard LLM messages (`user`, `assistant`, `toolResult`)\n- Custom app-specific message types via declaration merging\n\nLLMs only understand `user`, `assistant`, and `toolResult`. The `convertToLlm` function bridges this gap by filtering and transforming messages before each LLM call.\n\n### Message Flow\n\n```\nAgentMessage[] → transformContext() → AgentMessage[] → convertToLlm() → Message[] → LLM\n                    (optional)                           (required)\n```\n\n1. **transformContext**: Prune old messages, inject external context\n2. **convertToLlm**: Filter out UI-only messages, convert custom types to LLM format\n\n## Event Flow\n\nThe agent emits events for UI updates. Understanding the event sequence helps build responsive interfaces.\n\n### prompt() Event Sequence\n\nWhen you call `prompt(\"Hello\")`:\n\n```\nprompt(\"Hello\")\n├─ agent_start\n├─ turn_start\n├─ message_start   { message: userMessage }      // Your prompt\n├─ message_end     { message: userMessage }\n├─ message_start   { message: assistantMessage } // LLM starts responding\n├─ message_update  { message: partial... }       // Streaming chunks\n├─ message_update  { message: partial... }\n├─ message_end     { message: assistantMessage } // Complete response\n├─ turn_end        { message, toolResults: [] }\n└─ agent_end       { messages: [...] }\n```\n\n### With Tool Calls\n\nIf the assistant calls tools, the loop continues:\n\n```\nprompt(\"Read config.json\")\n├─ agent_start\n├─ turn_start\n├─ message_start/end  { userMessage }\n├─ message_start      { assistantMessage with toolCall }\n├─ message_update...\n├─ message_end        { assistantMessage }\n├─ tool_execution_start  { toolCallId, toolName, args }\n├─ tool_execution_update { partialResult }           // If tool streams\n├─ tool_execution_end    { toolCallId, result }\n├─ message_start/end  { toolResultMessage }\n├─ turn_end           { message, toolResults: [toolResult] }\n│\n├─ turn_start                                        // Next turn\n├─ message_start      { assistantMessage }           // LLM responds to tool result\n├─ message_update...\n├─ message_end\n├─ turn_end\n└─ agent_end\n```\n\nTool execution mode is configurable:\n\n- `parallel` (default): preflight tool calls sequentially, execute allowed tools concurrently, emit final `tool_execution_end` and `toolResult` messages in assistant source order\n- `sequential`: execute tool calls one by one, matching the historical behavior\n\nThe `beforeToolCall` hook runs after `tool_execution_start` and validated argument parsing. It can block execution. The `afterToolCall` hook runs after tool execution finishes and before `tool_execution_end` and final tool result message events are emitted.\n\nWhen you use the `Agent` class, assistant `message_end` processing is treated as a barrier before tool preflight begins. That means `beforeToolCall` sees agent state that already includes the assistant message that requested the tool call.\n\n### continue() Event Sequence\n\n`continue()` resumes from existing context without adding a new message. Use it for retries after errors.\n\n```typescript\n// After an error, retry from current state\nawait agent.continue();\n```\n\nThe last message in context must be `user` or `toolResult` (not `assistant`).\n\n### Event Types\n\n| Event | Description |\n|-------|-------------|\n| `agent_start` | Agent begins processing |\n| `agent_end` | Final event for the run. Awaited subscribers for this event still count toward settlement |\n| `turn_start` | New turn begins (one LLM call + tool executions) |\n| `turn_end` | Turn completes with assistant message and tool results |\n| `message_start` | Any message begins (user, assistant, toolResult) |\n| `message_update` | **Assistant only.** Includes `assistantMessageEvent` with delta |\n| `message_end` | Message completes |\n| `tool_execution_start` | Tool begins |\n| `tool_execution_update` | Tool streams progress |\n| `tool_execution_end` | Tool completes |\n+\n+`Agent.subscribe()` listeners are awaited in registration order. `agent_end` means no more loop events will be emitted, but `await agent.waitForIdle()` and `await agent.prompt(...)` only settle after awaited `agent_end` listeners finish.\n\n## Agent Options\n\n```typescript\nconst agent = new Agent({\n  // Initial state\n  initialState: {\n    systemPrompt: string,\n    model: Model<any>,\n    thinkingLevel: \"off\" | \"minimal\" | \"low\" | \"medium\" | \"high\" | \"xhigh\",\n    tools: AgentTool<any>[],\n    messages: AgentMessage[],\n  },\n\n  // Convert AgentMessage[] to LLM Message[] (required for custom message types)\n  convertToLlm: (messages) => messages.filter(...),\n\n  // Transform context before convertToLlm (for pruning, compaction)\n  transformContext: async (messages, signal) => pruneOldMessages(messages),\n\n  // Steering mode: \"one-at-a-time\" (default) or \"all\"\n  steeringMode: \"one-at-a-time\",\n\n  // Follow-up mode: \"one-at-a-time\" (default) or \"all\"\n  followUpMode: \"one-at-a-time\",\n\n  // Custom stream function (for proxy backends)\n  streamFn: streamProxy,\n\n  // Session ID for provider caching\n  sessionId: \"session-123\",\n\n  // Dynamic API key resolution (for expiring OAuth tokens)\n  getApiKey: async (provider) => refreshToken(),\n\n  // Tool execution mode: \"parallel\" (default) or \"sequential\"\n  toolExecution: \"parallel\",\n\n  // Preflight each tool call after args are validated. Can block execution.\n  beforeToolCall: async ({ toolCall, args, context }) => {\n    if (toolCall.name === \"bash\") {\n      return { block: true, reason: \"bash is disabled\" };\n    }\n  },\n\n  // Postprocess each tool result before final tool events are emitted.\n  afterToolCall: async ({ toolCall, result, isError, context }) => {\n    if (!isError) {\n      return { details: { ...result.details, audited: true } };\n    }\n  },\n\n  // Custom thinking budgets for token-based providers\n  thinkingBudgets: {\n    minimal: 128,\n    low: 512,\n    medium: 1024,\n    high: 2048,\n  },\n});\n```\n\n## Agent State\n\n```typescript\ninterface AgentState {\n  systemPrompt: string;\n  model: Model<any>;\n  thinkingLevel: ThinkingLevel;\n  tools: AgentTool<any>[];\n  messages: AgentMessage[];\n  readonly isStreaming: boolean;\n  readonly streamingMessage?: AgentMessage;\n  readonly pendingToolCalls: ReadonlySet<string>;\n  readonly errorMessage?: string;\n}\n```\n\nAccess state via `agent.state`.\n\nAssigning `agent.state.tools = [...]` or `agent.state.messages = [...]` copies the top-level array before storing it. Mutating the returned array mutates the current agent state.\n\nDuring streaming, `agent.state.streamingMessage` contains the current partial assistant message.\n\n`agent.state.isStreaming` remains `true` until the run fully settles, including awaited `agent_end` subscribers.\n\n## Methods\n\n### Prompting\n\n```typescript\n// Text prompt\nawait agent.prompt(\"Hello\");\n\n// With images\nawait agent.prompt(\"What's in this image?\", [\n  { type: \"image\", data: base64Data, mimeType: \"image/jpeg\" }\n]);\n\n// AgentMessage directly\nawait agent.prompt({ role: \"user\", content: \"Hello\", timestamp: Date.now() });\n\n// Continue from current context (last message must be user or toolResult)\nawait agent.continue();\n```\n\n### State Management\n\n```typescript\nagent.state.systemPrompt = \"New prompt\";\nagent.state.model = getModel(\"openai\", \"gpt-4o\");\nagent.state.thinkingLevel = \"medium\";\nagent.state.tools = [myTool];\nagent.toolExecution = \"sequential\";\nagent.beforeToolCall = async ({ toolCall }) => undefined;\nagent.afterToolCall = async ({ toolCall, result }) => undefined;\nagent.state.messages = newMessages; // top-level array is copied\nagent.state.messages.push(message);\nagent.reset();\n```\n\n### Session and Thinking Budgets\n\n```typescript\nagent.sessionId = \"session-123\";\n\nagent.thinkingBudgets = {\n  minimal: 128,\n  low: 512,\n  medium: 1024,\n  high: 2048,\n};\n```\n\n### Control\n\n```typescript\nagent.abort();           // Cancel current operation\nawait agent.waitForIdle(); // Wait for completion\n```\n\n### Events\n\n```typescript\nconst unsubscribe = agent.subscribe(async (event, signal) => {\n  if (event.type === \"agent_end\") {\n    // Final barrier work for the run\n    await flushSessionState(signal);\n  }\n});\nunsubscribe();\n```\n\n## Steering and Follow-up\n\nSteering messages let you interrupt the agent while tools are running. Follow-up messages let you queue work after the agent would otherwise stop.\n\n```typescript\nagent.steeringMode = \"one-at-a-time\";\nagent.followUpMode = \"one-at-a-time\";\n\n// While agent is running tools\nagent.steer({\n  role: \"user\",\n  content: \"Stop! Do this instead.\",\n  timestamp: Date.now(),\n});\n\n// After the agent finishes its current work\nagent.followUp({\n  role: \"user\",\n  content: \"Also summarize the result.\",\n  timestamp: Date.now(),\n});\n\nconst steeringMode = agent.steeringMode;\nconst followUpMode = agent.followUpMode;\n\nagent.clearSteeringQueue();\nagent.clearFollowUpQueue();\nagent.clearAllQueues();\n```\n\nUse clearSteeringQueue, clearFollowUpQueue, or clearAllQueues to drop queued messages.\n\nWhen steering messages are detected after a turn completes:\n1. All tool calls from the current assistant message have already finished\n2. Steering messages are injected\n3. The LLM responds on the next turn\n\nFollow-up messages are checked only when there are no more tool calls and no steering messages. If any are queued, they are injected and another turn runs.\n\n## Custom Message Types\n\nExtend `AgentMessage` via declaration merging:\n\n```typescript\ndeclare module \"@oxipi/agent-core\" {\n  interface CustomAgentMessages {\n    notification: { role: \"notification\"; text: string; timestamp: number };\n  }\n}\n\n// Now valid\nconst msg: AgentMessage = { role: \"notification\", text: \"Info\", timestamp: Date.now() };\n```\n\nHandle custom types in `convertToLlm`:\n\n```typescript\nconst agent = new Agent({\n  convertToLlm: (messages) => messages.flatMap(m => {\n    if (m.role === \"notification\") return []; // Filter out\n    return [m];\n  }),\n});\n```\n\n## Tools\n\nDefine tools using `AgentTool`:\n\n```typescript\nimport { Type } from \"@sinclair/typebox\";\n\nconst readFileTool: AgentTool = {\n  name: \"read_file\",\n  label: \"Read File\",  // For UI display\n  description: \"Read a file's contents\",\n  parameters: Type.Object({\n    path: Type.String({ description: \"File path\" }),\n  }),\n  execute: async (toolCallId, params, signal, onUpdate) => {\n    const content = await fs.readFile(params.path, \"utf-8\");\n\n    // Optional: stream progress\n    onUpdate?.({ content: [{ type: \"text\", text: \"Reading...\" }], details: {} });\n\n    return {\n      content: [{ type: \"text\", text: content }],\n      details: { path: params.path, size: content.length },\n    };\n  },\n};\n\nagent.state.tools = [readFileTool];\n```\n\n### Error Handling\n\n**Throw an error** when a tool fails. Do not return error messages as content.\n\n```typescript\nexecute: async (toolCallId, params, signal, onUpdate) => {\n  if (!fs.existsSync(params.path)) {\n    throw new Error(`File not found: ${params.path}`);\n  }\n  // Return content only on success\n  return { content: [{ type: \"text\", text: \"...\" }] };\n}\n```\n\nThrown errors are caught by the agent and reported to the LLM as tool errors with `isError: true`.\n\n## Proxy Usage\n\nFor browser apps that proxy through a backend:\n\n```typescript\nimport { Agent, streamProxy } from \"@oxipi/agent-core\";\n\nconst agent = new Agent({\n  streamFn: (model, context, options) =>\n    streamProxy(model, context, {\n      ...options,\n      authToken: \"...\",\n      proxyUrl: \"https://your-server.com\",\n    }),\n});\n```\n\n## Low-Level API\n\nFor direct control without the Agent class:\n\n```typescript\nimport { agentLoop, agentLoopContinue } from \"@oxipi/agent-core\";\n\nconst context: AgentContext = {\n  systemPrompt: \"You are helpful.\",\n  messages: [],\n  tools: [],\n};\n\nconst config: AgentLoopConfig = {\n  model: getModel(\"openai\", \"gpt-4o\"),\n  convertToLlm: (msgs) => msgs.filter(m => [\"user\", \"assistant\", \"toolResult\"].includes(m.role)),\n  toolExecution: \"parallel\",\n  beforeToolCall: async ({ toolCall, args, context }) => undefined,\n  afterToolCall: async ({ toolCall, result, isError, context }) => undefined,\n};\n\nconst userMessage = { role: \"user\", content: \"Hello\", timestamp: Date.now() };\n\nfor await (const event of agentLoop([userMessage], context, config)) {\n  console.log(event.type);\n}\n\n// Continue from existing context\nfor await (const event of agentLoopContinue(context, config)) {\n  console.log(event.type);\n}\n```\n\nThese low-level streams are observational. They preserve event order, but they do not wait for your async event handling to settle before later producer phases continue. If you need message processing to act as a barrier before tool preflight, use the `Agent` class instead of raw `agentLoop()` or `agentLoopContinue()`.\n\n## License\n\nMIT\n","readmeFilename":"README.md","_rev":"1-c668fe8b244931103b48413767bdd610"}