### Example Usage (app/pages/billing.vue)

Source: https://www.better-agent.com/docs/integrations/full-stack/nuxt

An example snippet demonstrating the import and basic setup of `useAgent` in a Vue component.

```APIDOC
## Example Usage

### File: `app/pages/billing.vue`

### Code Snippet
```typescript
<script setup lang="ts">
import { useAgent } from "@/lib/agent/useAgent";

// ... rest of your component logic
</script>
```
```

--------------------------------

### Install core packages

Source: https://www.better-agent.com/docs/get-started/installation

Install the required core and provider packages for the project.

```bash
npm install @better-agent/core @better-agent/providers
```

```bash
pnpm install @better-agent/core @better-agent/providers
```

--------------------------------

### Run Agent with Client

Source: https://www.better-agent.com/docs/concepts/cli

Execute an agent using the client. This example shows how to send an input to the 'assistant' agent and get a result.

```javascript
const result = await client.run("assistant", {
  input: "Hello!"
});
```

--------------------------------

### Server Configuration Example

Source: https://www.better-agent.com/docs/concepts/cli

Example of a server configuration file (`server.ts`) using `tools` import.

```typescript
import { tools }

```

--------------------------------

### Initialize Agent Client

Source: https://www.better-agent.com/docs/get-started/usage

Example of importing and initializing an agent client with a specific configuration.

```javascript
import { client } from "./client";

const agent = useAgent(client, {
 agent: "helloAgent",
});
```

--------------------------------

### Install Core Packages with bun

Source: https://www.better-agent.com/llms-full.txt

Install the core Better Agent packages using bun. Include '@better-agent/client' for typed frontends.

```bash
bun add @better-agent/core @better-agent/providers
```

--------------------------------

### Define Agent with Step Hooks

Source: https://www.better-agent.com/docs/concepts/agent

Use `onStep` to shape a run before a step starts, and `onStepFinish` to observe the result after it completes. This example activates only the 'search_web' tool for the first step and logs the finish reason.

```typescript
const researchAgent = defineAgent({
  name: "research",
  model: openai.model("gpt-4o"),
  tools: [searchWeb, readPage],
  maxSteps: 4,
  onStep: async ({ stepIndex, setActiveTools }) => {
    if (stepIndex === 0) {
      setActiveTools(["search_web"]);
    }
  },
  onStepFinish: async ({ stepIndex, result }) => {
    console.log("step", stepIndex + 1, result.response.finishReason);
  },
});
```

--------------------------------

### Configure Agent and Initial Messages

Source: https://www.better-agent.com/docs/integrations/full-stack/astro

Example of initializing an agent with a client and defining initial message structures.

```javascript
 = useAgent(client, {
  agent: "assistant",
  initialMessages: [
    {
      role: "assistant",
      parts: [{ type: "text", text: "Welcome back." }]
    }
  ]
  prepareMessages
```

--------------------------------

### Connect the UI with React

Source: https://www.better-agent.com/docs/get-started/usage

Implementation example for connecting the UI using React.

```typescript
import { ... } from '...';

function App() {
  return (
    <div>
      <h1>Hello World</h1>
    </div>
  );
}
```

--------------------------------

### Install Core Packages with pnpm

Source: https://www.better-agent.com/llms-full.txt

Install the core Better Agent packages using pnpm. Include '@better-agent/client' for typed frontends.

```bash
pnpm add @better-agent/core @better-agent/providers
```

--------------------------------

### Initialize Better Agent Server

Source: https://www.better-agent.com/docs/get-started/installation

Basic server-side setup importing core components and the OpenAI provider.

```typescript
import { betterAgent, defineAgent } from "@better-agent/core";
import { createOpenAI } from "@better-agent/providers/openai";

const openai = createOpenAI()
```

--------------------------------

### Nuxt.js Page Example

Source: https://www.better-agent.com/docs/integrations/full-stack/nuxt

An example of a Nuxt.js page demonstrating the integration of Better Agent client.

```vue
<template>
  <p>Hello</p>
</template>

<script setup lang="ts">
import type app from "@better-agent/client";
import type app from "./server";

const client = createClient<typeof app>({
  baseURL: "http://localhost:3000",
});

const { data, error, isLoading } = await client.chat.completions.use({
  messages: [{ role: "user", content: "Hello" }],
});
</script>
```

--------------------------------

### Install Core Packages with yarn

Source: https://www.better-agent.com/llms-full.txt

Install the core Better Agent packages using yarn. Include '@better-agent/client' for typed frontends.

```bash
yarn add @better-agent/core @better-agent/providers
```

--------------------------------

### Connect UI Frameworks

Source: https://www.better-agent.com/docs/get-started/usage

Examples for integrating the agent client into various frontend frameworks.

```typescript
import { useState } from "react";
import { useAgent } from "@better-agent/client/react";
import { client } from "./client";

export default function Page() {
  const [input, setInput] = useState("");

  const { messages, status, sendMessage } = useAgent(client, {
    agent: "helloAgent",
  });

  return (
    <div>
      <form
        onSubmit={async (event) => {
          event.preventDefault();
          if (!input.trim()) return;
          await sendMessage({ input });
          setInput("");
        }}
      >
        <input value={input} onChange={(event) => setInput(event.target.value)} />
        <button type="submit">Send</button>
      </form>

      <p>Status: {status}</p>
      <ul>
        {messages.map((message) => (
          <li key={message.localId}>
            {message.role}: {message.parts.map((part) => part.type === "text" ? part.text : "").join("")}
          </li>
        ))}
      </ul>
    </div>
  );
}
```

```vue
<script setup lang="ts">
import { ref } from "vue";
import { useAgent } from "@better-agent/client/vue";
import { client } from "./client";

const agent = useAgent(client, {
  agent: "helloAgent",
});

const input = ref("");
</script>

<template>
  <div>
    <form @submit.prevent="input.trim() && agent.sendMessage({ input }).then(() => (input = ''))">
      <input v-model="input" />
      <button type="submit">Send</button>
    </form>

    <p>Status: {{ agent.status.value }}</p>
    <ul>
      <li v-for="message in agent.messages.value" :key="message.localId">
        {{ message.role }}:
        {{ message.parts.map((part) => part.type === "text" ? part.text : "").join("") }}
      </li>
    </ul>
  </div>
</template>
```

```svelte
<script lang="ts">
  import { createAgentChat } from "@better-agent/client/svelte";
  import { client } from "./client";

  const chat = createAgentChat(client, {
    agent: "helloAgent",
  });

  let input = "";
</script>

<div>
  <form
    on:submit|preventDefault={async () => {
      if (!input.trim()) return;
      await chat.sendMessage({ input });
      input = "";
    }}
  >
    <input bind:value={input} />
    <button type="submit">Send</button>
  </form>

  <p>Status: {$chat.status}</p>
  <ul>
    {#each $chat.messages as message (message.localId)}
      <li>
        {message.role}: {message.parts.map((part) => part.type === "text" ? part.text : "").join("")}
      </li>
    {/each}
  </ul>
</div>
```

```typescript
import { useAgent } from "@better-agent/client/solid";
import { For, createSignal } from "solid-js";
import { client } from "./client";

export default function Page() {
  const { messages, status, sendMessage } = useAgent(client, {
    agent: "helloAgent",
  });

  const [input, setInput] = createSignal("");

  return (
    <div>
      <form
        onSubmit={async (event) => {
          event.preventDefault();
          if (!input().trim()) return;
          await sendMessage({ input: input() });
          setInput("");
        }}
      >
        <input value={input()} onInput={(event) => setInput(event.currentTarget.value)} />
        <button type="submit">Send</button>
      </form>

      <p>Status: {status()}</p>
      <ul>
        <For each={messages()}>
          {(message) => (
            <li>
              {message.role}: {message.parts.map((part) => part.type === "text" ? part.text : "").join("")}
            </li>
          )}
        </For>
      </ul>
    </div>
  );
}
```

```typescript
import { useState } from "preact/hooks";
import { useAgent } from "@better-agent/client/preact";
import { client } from "./client";

export default function App() {
  const { messages, status, sendMessage } = useAgent(client, {
    agent: "helloAgent",
  });
```

--------------------------------

### Vue Component Setup with Better Agent

Source: https://www.better-agent.com/docs/integrations/full-stack/nuxt

Demonstrates the basic setup for a Vue.js component using Better Agent's `useAgent` hook. Ensure the client is correctly imported from '@better-agent/client/vue'.

```vue
<script setup lang="ts" src="@better-agent/client/vue"></script>

import { useAgent } from "@better-agent/client/vue";
import { client } from "~~/lib/better-agent/client";

const {
  agent
} = useAgent();

```

--------------------------------

### Install Better Agent CLI with npm

Source: https://www.better-agent.com/docs/get-started/installation

Use this command to install the Better Agent CLI using npm. Ensure you have npm installed and configured.

```bash
npm create better-agent
```

--------------------------------

### Integrate and Start Fastify Server

Source: https://www.better-agent.com/docs/integrations/backend/fastify

Use toFastifyHandler to wrap the agent application and start the server on the specified port.

```typescript
"/api/*", toFastifyHandler(agentApp));
await app.listen({ port: 3000 });
```

--------------------------------

### Install Better-Agent Core Packages

Source: https://www.better-agent.com/docs/get-started/installation

Use pnpm, yarn, or bun to add the core and provider packages for Better-Agent.

```bash
pnpm add @better-agent/core @better-agent/providers
```

```bash
yarn add @better-agent/core @better-agent/providers
```

```bash
bun add @better-agent/core @better-agent/providers
```

--------------------------------

### Initialize Better Agent

Source: https://www.better-agent.com/docs/get-started/usage

Basic setup for initializing a betterAgent instance with a model and system instructions.

```javascript
const app = betterAgent({
  agents: {
    text("gpt-5-mini"),
    instruction: "You are a friendly assistant. Keep answers short.",
  });
```

--------------------------------

### Initialize Better Agent in Vue

Source: https://www.better-agent.com/docs/get-started/usage

Setup the agent client within a Vue component using the setup script and TypeScript.

```typescript
<script setup lang="ts">
import { ref } from "vue";
import { useAgent } from "@better-agent/client/vue";
```

--------------------------------

### Server Function Configuration Example

Source: https://www.better-agent.com/docs/concepts/hil

Example of configuring a server function with timeout and meta properties. The timeout is set to 300,000 milliseconds and meta includes a 'risk' level of 'high'.

```javascript
timeoutMs: 300_000,
  meta: {
    risk: "high"
  }
})
```

--------------------------------

### SvelteKit Page Component Example

Source: https://www.better-agent.com/docs/integrations/full-stack/sveltekit

An example of a SvelteKit page component demonstrating the use of the chat store and actions. Read state via $$chat and call actions on chat.

```svelte
<script lang="ts">
  import type { PageData } from './$types';

  export let data: PageData;
</script>

<div class="flex flex-col gap-4">
  <h2 class="text-2xl font-bold">Build a basic chat</h2>
  <p>
    In SvelteKit, use the Svelte adapter store. Read state through `$$chat` and call actions on `chat`.
  </p>
</div>
```

--------------------------------

### Install Better Agent Core Packages

Source: https://www.better-agent.com/docs/get-started/installation

Install the core Better Agent packages and the client package for typed frontends. This is required for building your agent application.

```bash
npm install @better-agent/core @better-agent/providers
```

--------------------------------

### Vue Setup with Better Agent

Source: https://www.better-agent.com/docs/integrations/full-stack/nuxt

This snippet demonstrates the initial setup for using the Better Agent client within a Vue.js application. It imports essential functions like `ref` and `useAgent`.

```typescript
import { ref } from "vue";
import { useAgent } from "@better-agent/client/vue";
import { client } from "~~/lib/better-agent/client";

const input = ref(
```

--------------------------------

### Create TypeScript Project

Source: https://www.better-agent.com/docs/get-started/installation

Initialize a new TypeScript project and configure the TypeScript compiler. Ensure you have Node.js and npm installed.

```bash
mkdir my-agent && cd my-agent
npm init -y
npm install typescript -D
npx tsc --init
```

--------------------------------

### Initialize Better Agent

Source: https://www.better-agent.com/docs/integrations/full-stack/tanstack-start

Initializes the betterAgent application. This is a core setup step for using the library.

```javascript
const app = betterAgent({
  agents: [
    assistant
  ],
  baseURL: "/agents",
  secret: "dev-secret",
});
```

--------------------------------

### Initialize Agent with Client

Source: https://www.better-agent.com/docs/integrations/full-stack/remix

Initializes an agent using the provided client. This is a common setup for agents that interact with external services or APIs.

```javascript
const agent = useAgent(client, {
  agent: "assistant",
, 
  initialMessages: [
 {
    role: "assistant",
    parts: [{
      type: "text",
      text: "Welcome back."
    }]
 },
]
})
```

--------------------------------

### Importing Hono server dependencies

Source: https://www.better-agent.com/docs/integrations/backend/hono

Initial setup for the Hono node server integration.

```typescript
import { serve } from "@hono/node-server";
```

--------------------------------

### Initialize Logging Plugin

Source: https://www.better-agent.com/llms-full.txt

Basic setup for the logging plugin to track requests, events, and model calls.

```ts
import { loggingPlugin } from "@better-agent/plugins";

const plugin = loggingPlugin();
```

--------------------------------

### Initialize a new project

Source: https://www.better-agent.com/docs/get-started/installation

Create a new directory and initialize the project using Bun.

```bash
mkdir my-agent && cd my-agent
bun init
```

--------------------------------

### Billing Page Component (Vue.js)

Source: https://www.better-agent.com/docs/integrations/full-stack/nuxt

Example of a Vue.js component for a billing page, including script setup and import statements.

```vue
<script setup lang="ts">
import { useAgent } from "@/lib/agent"

```

--------------------------------

### Initialize Agent Project with bun

Source: https://www.better-agent.com/docs/get-started/installation

Use these commands to set up a new agent project with bun. It includes creating a directory, changing into it, and initializing the project.

```bash
bun init -y
```

--------------------------------

### Initialize project with pnpm

Source: https://www.better-agent.com/docs/get-started/installation

Commands to create a directory and initialize a project using pnpm.

```bash
mkdir my-agent && cd my-agent
pnpm init
```

--------------------------------

### Optimistic UI Update Example

Source: https://www.better-agent.com/docs/integrations/full-stack/tanstack-start

This TypeScript code snippet demonstrates an optimistic UI update. It assumes a function `text` that generates LLM output and `instruction` for guiding the LLM. The UI is updated immediately with the LLM's response.

```typescript
import { text } from "@ai-sdk/react";

const result = await text({ model: "gpt-5-mini" }, [
  instruction: "You are a concise assistant. Keep replies short and natural.",
]);
```

--------------------------------

### Create the Better Agent server module

Source: https://www.better-agent.com/docs/integrations/full-stack/remix

Initial setup for a Better Agent server module in a Remix application.

```typescript
import { Agent } from "@better-agent/sdk";

export const agent = new Agent({
  // ... configuration
});
```

--------------------------------

### App Route Component with Shiki Syntax Highlighting

Source: https://www.better-agent.com/docs/integrations/full-stack/remix

This code defines a route component for an application, likely a Remix or React Router setup. It utilizes Shiki for syntax highlighting with customizable light and dark themes, and includes a tabbed interface for different code examples.

```tsx
export default
```

--------------------------------

### List and Call MCP Tools

Source: https://www.better-agent.com/llms-full.txt

Demonstrates how to initialize an MCP client and perform tool operations.

```ts
const client = await createMCPClient({
  transport: { type: "http", url: "https://mcp.example.com/mcp" },
});

const { tools } = await client.listTools();
const result = await client.callTool({
  name: "search",
  arguments: { query: "agent frameworks" },
});
```

--------------------------------

### Install Better Agent CLI with yarn

Source: https://www.better-agent.com/docs/get-started/installation

Use this command to install the Better Agent CLI using yarn. Ensure you have yarn installed and configured.

```bash
yarn create better-agent
```

--------------------------------

### Initialize Agent Chat in Svelte

Source: https://www.better-agent.com/llms-full.txt

Basic setup for creating an agent chat instance with context and streaming enabled.

```svelte
  import { createAgentChat } from "@better-agent/client/svelte";
  import { client } from "$lib/better-agent/client";

  const chat = createAgentChat(client, {
    agent: "assistant",
    context: {
      userId: "user_123",
      plan: "pro",
    },
    modelOptions: {
      reasoningEffort: "medium",
    },
    delivery: "stream",
  });
</script>

<button onclick={() => chat.sendMessage("Summarize my plan.")}>
  Ask
</button>
```

--------------------------------

### Install Better Agent CLI with pnpm

Source: https://www.better-agent.com/docs/get-started/installation

Use this command to install the Better Agent CLI using pnpm. Ensure you have pnpm installed and configured.

```bash
pnpm create better-agent
```

--------------------------------

### Scaffold a new Better Agent project

Source: https://www.better-agent.com/docs/get-started/installation

Use the CLI to initialize a new project. Choose between npm, yarn, or bun package managers.

```bash
yarn create better-agent
```

```bash
bun create better-agent
```

```bash
npm create better-agent
```

--------------------------------

### Export GET Handler Constant

Source: https://www.better-agent.com/docs/integrations/full-stack/nextjs

Exports a constant named GET, likely representing a handler for GET requests. Ensure the 'handle' function is correctly defined elsewhere.

```javascript
export const GET = handle;
```

--------------------------------

### Run Agent Command

Source: https://www.better-agent.com/docs/integrations/full-stack/sveltekit

This snippet shows how to initiate a command to run an agent. It's a basic entry point for agent execution.

```bash
$" Run"
```

--------------------------------

### Initialize Agent with Context and Model Options

Source: https://www.better-agent.com/llms-full.txt

Use this to set up an agent with specific user context, plan, model parameters, and delivery method.

```tsx
import { createFileRoute } from "@tanstack/react-router";
import { useAgent } from "@better-agent/client/react";
import { client } from "../better-agent/client";

export const Route = createFileRoute("/billing")({
  component: BillingPage,
});

function BillingPage() {
  const agent = useAgent(client, {
    agent: "assistant",
    context: {
      userId: "user_123",
      plan: "pro",
    },
    modelOptions: {
      reasoningEffort: "medium",
    },
    delivery: "stream",
  });

  return <button onClick={() => agent.sendMessage("Summarize my plan.")}>Ask</button>;
}
```

--------------------------------

### Initializing Agent with Observability

Source: https://www.better-agent.com/docs/integrations/full-stack/tanstack-start

This code demonstrates how to initialize the agent, passing the client and configuration options. It includes the use of the 'useAgent' hook.

```javascript
useAgent(client, {
  agent: "assistant",
  onResponse: (response) => {
    console.log("HTTP status");
```

--------------------------------

### Initialize Better Agent Client

Source: https://www.better-agent.com/docs/integrations/full-stack/nextjs

Sets up the agent client with a specified role. This is the initial step to establish communication with the LLM.

```javascript
import { useAgent } from "@/better-agent/client";

const { agent } = useAgent(client, { 
  agent: "assistant",
, 
  toolHandlers: { 
    toolHandlers: { 
      show_confetti: async ({ color }) => {
        console.log(color)
      }
    }
  }
});
```

--------------------------------

### Install Better Agent Dependencies

Source: https://www.better-agent.com/docs/get-started/installation

Command to install the core Better Agent packages using the Bun package manager.

```bash
bun add @better-agent/core @better-agent/providers/openai
```

--------------------------------

### Initialize TypeScript Project with pnpm

Source: https://www.better-agent.com/llms-full.txt

Manually set up a new TypeScript project using pnpm. This includes creating a directory, initializing pnpm, installing TypeScript, and initializing the TypeScript compiler.

```bash
mkdir my-agent && cd my-agent
pnpm init
pnpm add typescript -D
pnpm exec tsc --init
```

--------------------------------

### Initialize TypeScript Project with yarn

Source: https://www.better-agent.com/llms-full.txt

Manually set up a new TypeScript project using yarn. This includes creating a directory, initializing yarn, installing TypeScript, and initializing the TypeScript compiler.

```bash
mkdir my-agent && cd my-agent
yarn init -y
yarn add typescript -D
yarn tsc --init
```

--------------------------------

### Complex Message Structure Example

Source: https://www.better-agent.com/docs/integrations/full-stack/tanstack-start

An example demonstrating a more complex message structure, potentially for advanced use cases or specific formatting requirements.

```json
{
  "type": "message",
  "role": "user",
  "content": "Hello!"
}
```

--------------------------------

### Import Express and Initialize App

Source: https://www.better-agent.com/docs/integrations/backend/express

This snippet shows how to import the Express library and create a new Express application instance. Ensure Express is installed in your project.

```javascript
import agentApp from "./server";

const app = express();
```

--------------------------------

### Initialize Agent with Client

Source: https://www.better-agent.com/docs/integrations/full-stack/remix

Initializes an agent using a provided client. This is a foundational step for agent-based LLM interactions.

```javascript
const agent = useAgent(client, {
  // ...
});
```

--------------------------------

### Initialize xAI Provider with Better Agent

Source: https://www.better-agent.com/llms-full.txt

Set up the xAI provider and define an assistant agent. Ensure your XAI_API_KEY is set in the environment variables.

```typescript
import { betterAgent, defineAgent } from "@better-agent/core";
import { createXAI } from "@better-agent/providers/xai";

const xai = createXAI({
  apiKey: process.env.XAI_API_KEY,
});

const assistant = defineAgent({
  name: "assistant",
  model: xai.text("grok-4"),
  instruction: "You are a concise assistant. Keep replies short and natural.",
});

const app = betterAgent({
  agents: [assistant],
});
```

--------------------------------

### Vue.js Script Setup for Agent Persistence

Source: https://www.better-agent.com/docs/integrations/full-stack/nuxt

This Vue.js script setup demonstrates how to configure a component for agent persistence. It includes importing necessary modules and setting up the script tag with TypeScript.

```vue
<script setup lang="ts">
import { 
```

--------------------------------

### Better Agent Server Module Setup

Source: https://www.better-agent.com/docs/integrations/full-stack/nextjs

Sets up a Better Agent server module using the core library and the OpenAI provider. Requires OPENAI_API_KEY environment variable.

```typescript
import { betterAgent, defineAgent } from "@better-agent/core";
import { createOpenAI } from "@better-agent/providers/openai";

const openai = createOpenAI({
  apiKey: process.env.OPENAI_API_KEY,
});

const assistant = defineAgent({
  name: "assistant",

```

--------------------------------

### GET /loadConversation

Source: https://www.better-agent.com/llms-full.txt

Loads stored conversation history from the server.

```APIDOC
## GET /loadConversation

### Description
Load stored conversation history from the server.

### Method
GET

### Endpoint
/loadConversation

### Parameters
#### Path Parameters
- **agent** (string) - Required - Agent name.
- **conversationId** (string) - Required - Conversation ID.

### Response
#### Success Response (200)
- **items** (array) - List of ConversationItem objects.

#### Response Example
{
  "items": []
}
```

--------------------------------

### Create App

Source: https://www.better-agent.com/llms-full.txt

Use `betterAgent()` to initialize an application with agents, base URL, and secret for authentication.

```APIDOC
## Create App

Use `betterAgent()` to create an app with a programmatic API (`run`, `stream`) and an HTTP handler. The handler is a standard `Request -> Response` function, so you can mount it in any framework that gives you a `Request` object.

### Configuration Fields

| Field         | Description                                                                                              |
| ------------- | -------------------------------------------------------------------------------------------------------- |
| `agents`      | Agents registered in the app. Required, at least one.                                                    |
| `baseURL`     | Base path for the built-in HTTP routes. The pathname is used as the route prefix.                        |
| `secret`      | Bearer token for built-in HTTP routes. When set, requests must include `Authorization: Bearer <secret>`. |
| `plugins`     | Cross-agent plugins for auth, logging, rate limiting, and more. See [Plugins](/docs/concepts/plugins).   |
| `persistence` | Conversation, stream, and runtime state stores. See [Persistence](/docs/concepts/persistence).           |
| `tools`       | Shared tools available to all agents in the app.                                                         |
| `advanced`    | Runtime and HTTP behavior. See [Advanced Configuration](#advanced-configuration).                        |

### Request Example

```ts
import { betterAgent } from "@better-agent/core";
import { assistantAgent } from "./agents";

export const app = betterAgent({
  agents: [assistantAgent],
  baseURL: "/api",
  secret: process.env.BETTER_AGENT_SECRET,
});
```
```

--------------------------------

### Capability Gating Example

Source: https://www.better-agent.com/llms-full.txt

Define an agent with structured output enabled.

```ts
const textAgent = defineAgent({
  name: "text",
  model: openai.model("gpt-4o"),
  outputSchema: { schema: z.object({ answer: z.string() }) }, // ✓
});
```

--------------------------------

### get method

Source: https://www.better-agent.com/docs/concepts/persistence

Retrieves the conversation runtime state for a specific conversation and agent.

```APIDOC
## GET /get

### Description
Retrieves the `ConversationRuntimeState` for a given conversation ID and agent name.

### Method
GET

### Parameters
#### Request Body
- **conversationId** (string) - Required - The unique identifier for the conversation.
- **agentName** (string) - Required - The name of the agent.

### Response
#### Success Response (200)
- **ConversationRuntimeState | null** - Returns the runtime state object if found, otherwise null.
```

--------------------------------

### Basic Better Agent Server Setup in SolidStart

Source: https://www.better-agent.com/docs/integrations/full-stack/solidstart

Defines a basic Better Agent server module in SolidStart, including importing necessary functions and setting up an OpenAI provider.

```typescript
import { betterAgent, defineAgent } from "@better-agent/core";
import { createOpenAI } from "@better-agent/providers/openai";

const openai = createOpenAI({
  apiKey: process.env.OPENAI_API_KEY,
});

const assistant = defineAgent({

```

--------------------------------

### Get Weather Tool

Source: https://www.better-agent.com/docs/concepts/tools

Defines a server-side tool for fetching weather information.

```APIDOC
## GET /weather

### Description
This endpoint is a server tool designed to fetch weather information. It uses the `getWeather` function and is configured to run on the server.

### Method
GET

### Endpoint
`/weather`

### Parameters
#### Path Parameters
Not specified

#### Query Parameters
Not specified

#### Request Body
Not specified

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **location** (string) - The location for which to fetch weather information.

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Initialize Agent with Options

Source: https://www.better-agent.com/docs/integrations/full-stack/remix

Initialize the agent within the OptimisticPage function. This example shows how to configure the agent with specific settings like agent type, optimistic user messages, and error handling.

```javascript
const agent = useAgent(
  "client",
  { 
    agent: "assistant", 
    optimisticUserMessage: { 
      enabled: true 
    }, 
    onError: "remove"
  }
);
```

--------------------------------

### GET /health

Source: https://www.better-agent.com/docs/concepts/plugins

A health check endpoint used to verify the status of the service.

```APIDOC
## GET /health

### Description
Checks the health status of the application.

### Method
GET

### Endpoint
/health
```

--------------------------------

### Configure Agent Context and Options

Source: https://www.better-agent.com/docs/integrations/full-stack/tanstack-start

This snippet demonstrates how to initialize an agent with specific context, including user ID, plan type, and model reasoning effort.

```javascript
 = useAgent(client, {
  agent: "assistant",
  context: {
    userId: "user_123",
    plan: "pro",
    modelOptions: {
      reasoningEffort: "medium"
    },
    delivery
```

--------------------------------

### Define a Basic Plugin

Source: https://www.better-agent.com/docs/concepts/plugins

A simple example of defining a plugin with a unique ID.

```typescript
import { definePlugin } from "@better-agent/core";

export const myPlugin = definePlugin({
  id: "my-plugin",
});
```

--------------------------------

### Initialize Better Agent with OpenAI Provider

Source: https://www.better-agent.com/docs/integrations/backend/fastify

Set up a Better Agent instance using the OpenAI provider. Ensure the OPENAI_API_KEY environment variable is set.

```typescript
import { betterAgent, defineAgent } from "@better-agent/core";
import { createOpenAI } from "@better-agent/providers/openai";

const openai = createOpenAI({
  apiKey: process.env.OPENAI_API_KEY,
});

const assistant = defineAgent({
  name: "assistant",
  model: openai.text("gpt-5-mini"),

```

--------------------------------

### Initialize Agent Project with pnpm

Source: https://www.better-agent.com/docs/get-started/installation

Use this command to create a new agent directory, change into it, and add TypeScript as a development dependency using pnpm.

```bash
pnpm add typescript -D
```

```bash
pnpm tsc --init
```

--------------------------------

### Configure LLM Model and Instructions

Source: https://www.better-agent.com/docs/integrations/full-stack/nuxt

This snippet demonstrates how to configure the LLM model and provide instructions for the agent. It includes setting the model name (e.g., 'gpt-5-mini') and defining a system instruction to guide the agent's behavior.

```javascript
text("gpt-5-mini"),
instruction("You are a concise assistant. Keep replies short and natural.")
);
```

--------------------------------

### Define a sensitive filter plugin

Source: https://www.better-agent.com/docs/concepts/plugins

Example of defining a plugin with an ID and event configuration.

```typescript
const sensitiveFilter = definePlugin({
  id: "sensitive-filter",
  events: {
```

--------------------------------

### Importing hook options in billing.tsx

Source: https://www.better-agent.com/docs/integrations/full-stack/tanstack-start

Example of importing necessary modules in the billing route file.

```typescript
import { 










```

--------------------------------

### Initialize Better Agent Client

Source: https://www.better-agent.com/docs/integrations/full-stack/remix

Use createClient to instantiate the client with a specific app type and base URL configuration.

```typescript
import type app from "./server";

export const client = createClient<typeof app>({
 baseURL: "@better-agent/client";
```

--------------------------------

### Handle Approvals in Svelte

Source: https://www.better-agent.com/docs/integrations/full-stack/sveltekit

Example of importing createAgentChat in a Svelte component for managing agent interactions.

```svelte
<script lang="ts">
 import { createAgentChat } 
```

--------------------------------

### JavaScript Conditional Logic

Source: https://www.better-agent.com/docs/integrations/full-stack/remix

Example of conditional logic in JavaScript, checking if a part of a string is 'text'.

```javascript
part === "text" ? "text" : ""
).join("")
```

--------------------------------

### Initialize Client-Side Tool

Source: https://www.better-agent.com/docs/concepts/tools

Initializes a client-side tool instance.

```javascript
const showConfettiTool = showConfetti.client();
```

--------------------------------

### Define Message Structure

Source: https://www.better-agent.com/docs/integrations/full-stack/nextjs

Example of a message object structure including role and content parts.

```json
role: "assistant",
parts: [{ type: "text", text: "Welcome back." }]
```

--------------------------------

### Create a Better Agent Client

Source: https://www.better-agent.com/llms-full.txt

Initializes the client using either the server app type or a generated type from the CLI.

```ts
import { createClient } from "@better-agent/client";
import type { app } from "./server";

const client = createClient<typeof app>({
  baseURL: "https://api.example.com",
  secret: process.env.BETTER_AGENT_SECRET!,
});
```

```ts
import { createClient } from "@better-agent/client";
import type { BAClientApp } from "./better-agent.types";

const client = createClient<BAClientApp>({
  baseURL: "https://api.example.com",
  secret: process.env.BETTER_AGENT_SECRET!,
});
```

--------------------------------

### Supported Schema Libraries

Source: https://www.better-agent.com/llms-full.txt

Examples of defining output schemas using different validation libraries.

```ts
outputSchema: {
  schema: z.object({
    summary: z.string(),
    wordCount: z.number(),
  }),
}
```

```ts
import * as v from "valibot";

outputSchema: {
  schema: v.object({
    summary: v.string(),
    wordCount: v.number(),
  }),
}
```

```ts
import { type } from "arktype";

outputSchema: {
  schema: type({
    summary: "string",
    wordCount: "number",
  }),
}
```

```ts
outputSchema: {
  schema: {
    type: "object",
    properties: {
      summary: { type: "string" },
      wordCount: { type: "number" },
    },
    required: ["summary", "wordCount"],
  },
}
```

--------------------------------

### Configure Agent with LLM

Source: https://www.better-agent.com/docs/integrations/full-stack/nuxt

This snippet shows how to initialize an agent with a specific LLM, client, and initial messages. Ensure the 'agent' and 'client' variables are properly defined before use.

```javascript
agent = "assistant",
client,
initialMessages: [
  {
    role: "assistant"
  }
]
```

--------------------------------

### Initialize Better Agent Application

Source: https://www.better-agent.com/docs/integrations/backend/express

Configure the agent with instructions and base settings before exporting the application instance.

```typescript
    instruction: "You are a concise assistant. Keep replies short and natural.",
    });
    
    const agentApp = betterAgent({
      agents: [assistant],
      baseURL: "/api",
      secret: "dev-secret",
    });
    
    export default agentApp;
```

--------------------------------

### Usage Tracker Plugin

Source: https://www.better-agent.com/docs/concepts/plugins

Example of defining a usage tracker plugin using the definePlugin interface.

```APIDOC
## definePlugin

### Description
Defines a new plugin for the agent system. The example shows a 'usage-tracker' plugin that hooks into the model call lifecycle.

### Request Example
```javascript
definePlugin({
  id: "usage-tracker",
  onAfterModelCall: async (ctx) => {
    const usage = ctx.response.usage;
  }
})
```
```

--------------------------------

### Initialize Better-Agent Client

Source: https://www.better-agent.com/docs/concepts/cli

Import necessary types and functions to create a client instance. Ensure the correct types are imported from './types/server' and the client creation function from '@better-agent/client'.

```typescript
import type { BAClientApp } from "./types/server";
import { createClient } from "@better-agent/client";

const client = createClient<BAClientApp>({
  baseURL:

```

--------------------------------

### Example Agent sendMessage Call

Source: https://www.better-agent.com/docs/integrations/full-stack/astro

Demonstrates calling the `sendMessage` function on an agent instance with a specific message. Ensure the agent is properly initialized before this call.

```javascript
agent.sendMessage("Summarize my plan.")
```

--------------------------------

### Define an asynchronous action function

Source: https://www.better-agent.com/docs/integrations/full-stack/remix

An example of an exported async function that handles requests and returns a Promise.

```typescript
export async function action({ request }: ActionFunctionArgs): Promise<Response> { return app.handler(request); }
```

--------------------------------

### Importing and Using useAgent in SolidJS

Source: https://www.better-agent.com/docs/integrations/full-stack/solidstart

Demonstrates how to import the client and useAgent hook to initialize an agent within a component.

```javascript
import { useAgent } from "@better-agent/client/solid";
import { client } from "../better-agent/client";

export default function ToolsPage() {
 const agent = useAgent(client, {
 agent: "assistant",

```

--------------------------------

### Import and Initialize Server Module

Source: https://www.better-agent.com/docs/concepts/agent

This snippet shows the import statement for the server module and the beginning of its initialization. It includes setting up the Shiki highlighter with light and dark themes.

```typescript
import
```

--------------------------------

### Accessing Structured Agent Results

Source: https://www.better-agent.com/docs/concepts/structured-output

Examples of logging structured data fields from an agent result object.

```javascript
console.log(result.structured.wordCount);
```

```javascript
console.log(result.structured.summary);
```

--------------------------------

### Basic SolidJS Component Structure with useAgent

Source: https://www.better-agent.com/docs/get-started/usage

Demonstrates a basic SolidJS component structure that utilizes the `useAgent` hook. This example shows how to import and call the hook within a component's scope.

```javascript
d1:["$","span",null,{"className":"line","children":[["$","span",null,{"style":{"--shiki-light":"#383A42","--shiki-dark":"#ABB2BF"},"children":" <"}] ,["$","span",null,{"style":{"--shiki-light":"#E45649","--shiki-dark":"#E06C75"},"children":"li"}] ,["$","span",null,{"style":{"--shiki-light":"#383A42","--shiki-dark":"#ABB2BF"},"children":" >"}] ]}]
d2:["$","span",null,{"className":"line","children":[["$","span",null,{"style":{"--shiki-light":"#383A42","--shiki-dark":"#ABB2BF"},"children":" {/"}] ,["$","span",null,{"style":{"--shiki-light":"#A626A4","--shiki-dark":"#C678DD"},"children":"each"}] ,["$","span",null,{"style":{"--shiki-light":"#383A42","--shiki-dark":"#ABB2BF"},"children":"}"}] ]}]
d3:["$","span",null,{"className":"line","children":[["$","span",null,{"style":{"--shiki-light":"#383A42","--shiki-dark":"#ABB2BF"},"children":" </"}] ,["$","span",null,{"style":{"--shiki-light":"#E45649","--shiki-dark":"#E06C75"},"children":"ul"}] ,["$","span",null,{"style":{"--shiki-light":"#383A42","--shiki-dark":"#ABB2BF"},"children":" >"}] ]}]
d4:["$","span",null,{"className":"line","children":[["$","span",null,{"style":{"--shiki-light":"#383A42","--shiki-dark":"#ABB2BF"},"children":"</"}] ,["$","span",null,{"style":{"--shiki-light":"#E45649","--shiki-dark":"#E06C75"},"children":"div"}] ,["$","span",null,{"style":{"--shiki-light":"#383A42","--shiki-dark":"#ABB2BF"},"children":" >"}] ]}]
d6:["$","span",null,{"style":{"--shiki-light":"#383A42","--shiki-dark":"#ABB2BF"},"children":" { "}]
d7:["$","span",null,{"style":{"--shiki-light":"#E45649","--shiki-dark":"#E06C75"},"children":"useAgent"}]
d8:["$","span",null,{"style":{"--shiki-light":"#383A42","--shiki-dark":"#ABB2BF"},"children":" } "}]
d9:["$","span",null,{"style":{"--shiki-light":"#A626A4","--shiki-dark":"#C678DD"},"children":"from"}]
da:["$","span",null,{"style":{"--shiki-light":"#50A14F","--shiki-dark":"#98C379"},"children":" \"@better-agent/client/solid\""}]
db:["$","span",null,{"style":{"--shiki-light":"#383A42","--shiki-dark":"#ABB2BF"},"children":";"}]
dc:["$","span",null,{"className":"line","children":[["$","span",null,{"style":{"--shiki-light":"#A626A4","--shiki-dark":"#C678DD"},"children":"import"}] ,["$","span",null,{"style":{"--shiki-light":"#383A42","--shiki-dark":"#ABB2BF"},"children":" { "}] ,["$","span",null,{"style":{"--shiki-light":"#E45649","--shiki-dark":"#E06C75"},"children":"For"}] ,["$","span",null,{"style":{"--shiki-light":"#383A42","--shiki-dark":"#ABB2BF"},"children":", "}] ,["$",
```

--------------------------------

### Defining an ArkType Schema

Source: https://www.better-agent.com/docs/concepts/structured-output

Example of how to define an object schema with summary and wordCount fields using ArkType.

```APIDOC
## ArkType Schema Definition

### Description
Defines a data schema object using ArkType, specifying types for summary and wordCount fields.

### Schema Structure
- **summary** (string) - A brief summary of the content.
- **wordCount** (number) - The total count of words in the content.

### Example
```javascript
const schema = v.object({
  summary: v.string(),
  wordCount: v.number()
});
```
```

--------------------------------

### Define a Valibot Schema

Source: https://www.better-agent.com/docs/concepts/structured-output

Example of importing Valibot and defining an object schema with string and number fields.

```typescript
import * as v from "valibot";
```

--------------------------------

### Create Better Agent Server Module

Source: https://www.better-agent.com/docs/integrations/full-stack/solidstart

Start by creating a standard Better Agent server module. This serves as the foundation for your SolidStart integration.

```typescript
import { Agent } from "@better-agent/agent";

export const agent = new Agent();

agent.addFunction(
  "add",
  (a: number, b: number) => a + b,
  {
    description: "Adds two numbers",
    parameters: {
      type: "object",
      properties: {
        a: {
          type: "number",
          description: "The first number",
        },
        b: {
          type: "number",
          description: "The second number",
        },
      },
      required: ["a", "b"],
    },
  }
);

```

--------------------------------

### Array Concatenation Example

Source: https://www.better-agent.com/llms-full.txt

Shows array concatenation, which might be an unsupported operation if type semantics cannot be preserved.

```javascript
tools.concat(otherTools)
```