@opperai/agents 0.1.0 → 0.1.1

package/README.md

@@ -8,54 +8,30 @@ Type‑safe, composable agents for Opper AI in TypeScript using: generics, Zod s
 - Hooks for observability and custom behavior
 - Tools: function, decorator, MCP provider, or other agents via `.asTool()`
 
-## Install
-
-Prerequisites: Node.js 20+ and pnpm (recommended).
-
-```bash
-pnpm add @opperai/agents zod
-```
-
-Set your Opper key:
+## Installation
 
 ```bash
-export OPPER_API_KEY="<your-key>"
+npm install @opperai/agents
+# or
+yarn add @opperai/agents
+# or
+pnpm add @opperai/agents
 ```
 
-## Use Locally
+**Prerequisites:** Node.js 20+
 
-Two quick ways to consume this package from a local checkout:
-
-1. Live symlink (best for active development)
+**Set your Opper API key:**
 
 ```bash
-# In the app that will consume the SDK
-pnpm link ../opperai-agent-sdk-node
+export OPPER_API_KEY="your-api-key"
 ```
 
-```ts
-// Then import normally
-import { Agent } from "@opperai/agents";
-```
-
-2. Local file dependency (copied on install)
-
-```json
-// app/package.json
-{
-  "dependencies": {
-    "@opperai/agents": "file:../opperai-agent-sdk-node"
-  }
-}
-```
-
-Notes:
-
-- Build the SDK first (and optionally watch) so `dist/` is up to date: `pnpm build` or `pnpm dev`.
-- With `link`, changes in this repo are reflected in your app after rebuild.
+Get your API key from the [Opper Dashboard](https://platform.opper.ai).
 
 ## Quick Start
 
+To get started we recommend navigating to the [examples/01_getting_started](./examples/01_getting_started/). They are designed to walk you through the different features of this SDK.
+
 Minimal agent that returns structured JSON:
 
 ```ts
@@ -81,11 +57,7 @@ const result = await agent.process("Say hi to Ada");
 Define tools with Zod schemas. Results are discriminated unions that never throw.
 
 ```ts
-import {
-  createFunctionTool,
-  ToolResultFactory,
-  Agent,
-} from "@opperai/agents";
+import { createFunctionTool, ToolResultFactory, Agent } from "@opperai/agents";
 import { z } from "zod";
 
 const add = createFunctionTool(

package/dist/index.cjs

@@ -1087,6 +1087,20 @@ var ToolExecutionSummarySchema = zod.z.object({
    */
   error: zod.z.string().optional()
 });
+
+// package.json
+var package_default = {
+  version: "0.1.1"};
+
+// src/utils/version.ts
+var SDK_NAME = "@opperai/agents";
+var SDK_VERSION = package_default.version;
+var SDK_PLATFORM = "ts";
+function getUserAgent() {
+  return `${SDK_NAME}-${SDK_PLATFORM}/${SDK_VERSION}`;
+}
+
+// src/opper/client.ts
 var isPlainRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
 var isZodSchema = (value) => typeof value === "object" && value !== null && "_def" in value && typeof value.parse === "function";
 var readTokenCount = (usage, key) => {
@@ -1123,7 +1137,8 @@ var OpperClient = class {
   retryConfig;
   constructor(apiKey, options = {}) {
     this.client = new opperai.Opper({
-      httpBearer: apiKey ?? process.env["OPPER_HTTP_BEARER"] ?? ""
+      httpBearer: apiKey ?? process.env["OPPER_HTTP_BEARER"] ?? "",
+      userAgent: getUserAgent()
     });
     this.logger = options.logger ?? getDefaultLogger();
     this.retryConfig = {