@dexto/core 1.2.6 → 1.4.0

package/README.md

@@ -1,6 +1,6 @@
 # @dexto/core
 
-TypeScript SDK for building agentic applications programmatically. This package powers the Dexto CLI and lets you embed the same agent runtime in your own apps.
+The Dexto Agent SDK for building agentic applications programmatically. This package powers the Dexto CLI and lets you embed the same agent runtime in your own apps.
 
 ## Installation
 
@@ -8,6 +8,32 @@ TypeScript SDK for building agentic applications programmatically. This package
 npm install @dexto/core
 ```
 
+### Optional Dependencies
+
+Some features require additional packages. Install only what you need:
+
+```bash
+# Telemetry (OpenTelemetry distributed tracing)
+npm install @opentelemetry/sdk-node @opentelemetry/auto-instrumentations-node \
+  @opentelemetry/resources @opentelemetry/semantic-conventions \
+  @opentelemetry/sdk-trace-base @opentelemetry/exporter-trace-otlp-http
+
+# For gRPC telemetry export protocol
+npm install @opentelemetry/exporter-trace-otlp-grpc
+
+# Storage backends
+npm install better-sqlite3  # SQLite database
+npm install pg              # PostgreSQL database
+npm install ioredis         # Redis cache
+
+# TypeScript plugin support
+npm install tsx
+```
+
+If you configure a feature without its dependencies, you'll get a helpful error message with the exact install command.
+
+> **Note:** The `dexto` CLI package includes all optional dependencies. These are only needed when using `@dexto/core` directly as a library.
+
 ## Quick Start
 
 ```ts
@@ -23,19 +49,32 @@ const agent = new DextoAgent({
 });
 await agent.start();
 
-// Run tasks
-const response = await agent.run('List the 5 largest files in this repo');
-console.log(response);
+// Create a session for the conversation
+const session = await agent.createSession();
+
+// Use generate() for simple request/response
+const response = await agent.generate('What is TypeScript?', session.id);
+console.log(response.content);
 
-// Hold conversations
-await agent.run('Write a haiku about TypeScript');
-await agent.run('Make it funnier');
+// Conversations maintain context within a session
+await agent.generate('Write a haiku about it', session.id);
+await agent.generate('Make it funnier', session.id);
+
+// Multimodal: send images or files
+await agent.generate([
+  { type: 'text', text: 'Describe this image' },
+  { type: 'image', image: base64Data, mimeType: 'image/png' }
+], session.id);
+
+// Streaming for real-time UIs
+for await (const event of await agent.stream('Write a story', session.id)) {
+  if (event.name === 'llm:chunk') process.stdout.write(event.content);
+}
 
 await agent.stop();
 ```
 
-See the TypeScript SDK docs for full examples with MCP tools, sessions, and advanced features:
-https://docs.dexto.ai/api/category/typescript-sdk/
+See the [Dexto Agent SDK docs](https://docs.dexto.ai/docs/guides/dexto-sdk) for multimodal content, streaming, MCP tools, and advanced features.
 
 ---
 
@@ -49,7 +88,7 @@ await agent.start();
 
 // Create and manage sessions
 const session = await agent.createSession('user-123');
-await agent.run('Hello, how can you help me?', undefined, 'user-123');
+await agent.generate('Hello, how can you help me?', session.id);
 
 // List and manage sessions
 const sessions = await agent.listSessions();
@@ -115,15 +154,18 @@ Delegate tasks to other A2A-compliant agents using the built-in `delegate_to_url
 ```typescript
 const agent = new DextoAgent({
   llm: { /* ... */ },
-  internalTools: ['delegate_to_url'] // Enable delegation tool
+  internalTools: ['delegate_to_url'], // Enable delegation tool
+  toolConfirmation: { mode: 'auto-approve' }
 });
 await agent.start();
 
+const session = await agent.createSession();
+
 // Delegate via natural language
-await agent.run(`
+await agent.generate(`
   Please delegate this task to the PDF analyzer agent at http://localhost:3001:
   "Extract all tables from the Q4 sales report"
-`);
+`, session.id);
 
 // Or call the tool directly
 const tools = await agent.getAllTools();