@orkestrel/agent 0.0.34 → 0.0.36

package/README.md

@@ -8,7 +8,7 @@
 
 Build an agent with the `createAgent` function over a `ProviderInterface` implementation,
 seed the conversation through `agent.context.messages`, then run the turn as a one-shot
-`generate` or a live `stream`. Extend the `AgentProvider` class to reach a new wire, or
+`generate` or a live `stream`. Extend the `AgentProvider` class to reach another wire, or
 compose the `createRelayProvider` and `createRelay` functions to reach a model through your
 own server. Callable tools come from `@orkestrel/tool` and documents from
 `@orkestrel/workspace`. Part of the `@orkestrel` line.
@@ -25,7 +25,8 @@ npm install @orkestrel/agent
 
 The package targets the following runtime and module formats:
 
-- Node.js >= 22.12.0
+- Node.js >= 22.18.0
+- A browser that provides the APIs the Agent guide's inlet table note names, in a secure context
 - Dual ESM + CommonJS builds (`import` and `require` both supported)
 
 ## Usage
@@ -33,7 +34,8 @@ The package targets the following runtime and module formats:
 The following example builds an agent with one tool and streams a turn:
 
 ```ts
-import { createAgent } from '@orkestrel/agent'
+import { createAgent, createAuthority } from '@orkestrel/agent'
+import { numberShape, objectShape } from '@orkestrel/contract'
 import { createTool, createToolManager } from '@orkestrel/tool'
 
 const tools = createToolManager()
@@ -41,12 +43,18 @@ tools.add(
 	createTool({
 		name: 'add',
 		description: 'Add two numbers',
+		contract: objectShape({ a: numberShape(), b: numberShape() }),
 		execute: (args) => Number(args.a) + Number(args.b),
 	}),
 )
 
 // `provider` is your ProviderInterface implementation (see the guide)
-const agent = createAgent(provider, { system: 'You are concise.', tools })
+// Tools need an authority: this one allows every call; rules with a deny fallback make an allowlist.
+const agent = createAgent(provider, {
+	system: 'You are concise.',
+	tools,
+	authority: createAuthority({ fallback: { zone: 'default', verdict: 'allow' } }),
+})
 agent.context.messages.add({ role: 'user', content: 'Say hi.' })
 
 const stream = agent.stream()