@isdk/ai-tool 0.8.2 → 0.9.0

package/docs/api/interfaces/MailboxClientOptions.md

@@ -0,0 +1,74 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / MailboxClientOptions
+
+# Interface: MailboxClientOptions
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:505
+
+Configuration options for the MailboxClientTransport.
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+Additional transport-specific options.
+
+## Properties
+
+### ~~apiRoot?~~
+
+> `optional` **apiRoot**: `string`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:520
+
+The root path for the API (logical placeholder). Default is '/'.
+
+#### Deprecated
+
+Use serverAddress for the physical endpoint.
+
+***
+
+### clientAddress?
+
+> `optional` **clientAddress**: `string`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:525
+
+The client's own physical address to receive asynchronous responses.
+This address must be unique and subscribable.
+
+***
+
+### mailbox?
+
+> `optional` **mailbox**: `Mailbox`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:510
+
+The Mailbox instance to use for communication.
+If not provided, a new Mailbox instance will be created.
+
+***
+
+### serverAddress?
+
+> `optional` **serverAddress**: `string`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:515
+
+The server's physical address (gateway/RPC entry point).
+E.g., 'mem://api@server/api'.
+
+***
+
+### timeout?
+
+> `optional` **timeout**: `number` \| \{ `keepAliveOnTimeout?`: `boolean`; `streamIdleTimeout?`: `number`; `value`: `number`; \}
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:529
+
+Request timeout. Can be a number (milliseconds) or an object. Default is 30000 (30 seconds).

package/docs/api/interfaces/MailboxServerOptions.md

@@ -0,0 +1,69 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / MailboxServerOptions
+
+# Interface: MailboxServerOptions
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:575
+
+Configuration options for the MailboxServerTransport.
+
+## Indexable
+
+\[`key`: `string`\]: `any`
+
+Additional transport-specific options.
+
+## Properties
+
+### address?
+
+> `optional` **address**: `string`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:585
+
+The unique physical address this server listens on (e.g., 'mem://api@server/api').
+This address is used for mailbox subscription or fetching.
+
+***
+
+### apiRoot?
+
+> `optional` **apiRoot**: `string`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:589
+
+The root path for the API. Default is '/'.
+
+***
+
+### mailbox?
+
+> `optional` **mailbox**: `Mailbox`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:580
+
+The Mailbox instance to use for communication.
+If not provided, a new Mailbox instance will be created.
+
+***
+
+### mode?
+
+> `optional` **mode**: `"push"` \| `"pull"`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:593
+
+Transport mode: 'push' (subscribe) or 'pull' (fetch). Default is 'push'.
+
+***
+
+### pullInterval?
+
+> `optional` **pullInterval**: `number`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:597
+
+Fetch interval in milliseconds for 'pull' mode. Default is 1000ms.

package/docs/api/interfaces/ProbabilityItem.md

@@ -6,7 +6,7 @@
 
 # Interface: ProbabilityItem
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:1](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/calc-perplexity.ts#L1)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:1](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/calc-perplexity.ts#L1)
 
 ## Properties
 
@@ -14,7 +14,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:1](htt
 
 > `optional` **id**: `number`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:5](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/calc-perplexity.ts#L5)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:5](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/calc-perplexity.ts#L5)
 
 The id of the token.
 
@@ -24,7 +24,7 @@ The id of the token.
 
 > **probability**: `number`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:16](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/calc-perplexity.ts#L16)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:16](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/calc-perplexity.ts#L16)
 
 The natural logarithm of the probability (log probability) assigned to this token.
 Using log probabilities helps prevent numerical underflow when multiplying
@@ -36,6 +36,6 @@ many small probabilities together in language model calculations.
 
 > **token**: `string`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:9](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/calc-perplexity.ts#L9)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:9](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/calc-perplexity.ts#L9)
 
 The token string being analyzed

package/docs/api/interfaces/PromptExampleSelectorOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: PromptExampleSelectorOptions
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:5](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/prompt/prompt-example-selector.ts#L5)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:5](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/prompt/prompt-example-selector.ts#L5)
 
 ## Indexable
 
@@ -18,7 +18,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-sel
 
 > `optional` **maxLength**: `number`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:9](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/prompt/prompt-example-selector.ts#L9)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:9](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/prompt/prompt-example-selector.ts#L9)
 
 The maximum count of the selected examples, or `undefined` if no limit.
 
@@ -28,7 +28,7 @@ The maximum count of the selected examples, or `undefined` if no limit.
 
 > `optional` **threshold**: `number` \| `boolean`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:14](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/prompt/prompt-example-selector.ts#L14)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:14](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/prompt/prompt-example-selector.ts#L14)
 
 The threshold probability (0-1) at which a sample is selected.
 If `true`, defaults to 0.5; if `false`, disable it.

package/docs/api/interfaces/PromptTemplateOptions.md

@@ -58,6 +58,14 @@ Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:17
 
 ***
 
+### raw?
+
+> `optional` **raw**: `boolean`
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:21
+
+***
+
 ### template?
 
 > `optional` **template**: `string`

package/docs/api/interfaces/PubSubClientStream.md

@@ -6,7 +6,7 @@
 
 # Interface: PubSubClientStream
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:11](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/transports/pubsub/client.ts#L11)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/transports/pubsub.d.ts:19
 
 Represents the client-side stream for a PubSub connection.
 
@@ -21,7 +21,7 @@ and managing the connection state.
 
 > `optional` **addEventListener**: (`event`, `listener`) => `any`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:66](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/transports/pubsub/client.ts#L66)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/transports/pubsub.d.ts:67
 
 Optional alias for the `on` method for compatibility with the
 standard `EventTarget` interface.
@@ -46,7 +46,7 @@ standard `EventTarget` interface.
 
 > **clientId**: `string`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:17](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/transports/pubsub/client.ts#L17)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/transports/pubsub.d.ts:25
 
 A unique identifier for this specific stream instance.
 This ID is typically generated by the client transport and sent to the
@@ -58,7 +58,7 @@ server to establish a stable session identity.
 
 > **close**: () => `void`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:50](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/transports/pubsub/client.ts#L50)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/transports/pubsub.d.ts:53
 
 Closes the connection stream.
 
@@ -72,7 +72,7 @@ Closes the connection stream.
 
 > **off**: (`event`, `listener`) => `void`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:45](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/transports/pubsub/client.ts#L45)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/transports/pubsub.d.ts:49
 
 Removes a previously registered event listener.
 
@@ -100,7 +100,7 @@ The listener function to remove.
 
 > **on**: (`event`, `listener`) => `any`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:38](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/transports/pubsub/client.ts#L38)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/transports/pubsub.d.ts:43
 
 Registers a listener for a specific event from the server.
 
@@ -129,7 +129,7 @@ The callback function to execute when the event is received.
 
 > **protocol**: `string`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:22](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/transports/pubsub/client.ts#L22)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/transports/pubsub.d.ts:29
 
 The protocol being used for this stream (e.g., 'sse', 'ws', 'ipc').
 
@@ -139,7 +139,7 @@ The protocol being used for this stream (e.g., 'sse', 'ws', 'ipc').
 
 > `optional` **readyState**: `number`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:30](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/transports/pubsub/client.ts#L30)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/transports/pubsub.d.ts:36
 
 Optional. Represents the state of the connection.
 This is provided for compatibility with the `EventSource.readyState`
@@ -152,7 +152,7 @@ and `WebSocket.readyState` properties.
 
 > `optional` **removeEventListener**: (`event`, `listener`) => `void`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:72](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/transports/pubsub/client.ts#L72)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/transports/pubsub.d.ts:72
 
 Optional alias for the `off` method for compatibility with the
 standard `EventTarget` interface.
@@ -177,7 +177,7 @@ standard `EventTarget` interface.
 
 > `optional` **send**: (`event`, `data`, `ctx?`) => `void`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:60](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/transports/pubsub/client.ts#L60)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/transports/pubsub.d.ts:62
 
 Optional. Sends a message from the client to the server.
 This method is only available for bidirectional transports like WebSockets or IPC.
@@ -199,7 +199,7 @@ The payload for the event.
 
 ##### ctx?
 
-[`PubSubCtx`](../type-aliases/PubSubCtx.md)
+[`PubSubCtx`](../type-aliases/PubSubCtx.md)\<`any`\>
 
 Optional context for the PubSub operation.
 

package/docs/api/interfaces/PubSubServerSession.md

@@ -6,7 +6,7 @@
 
 # Interface: PubSubServerSession
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:14](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/transports/pubsub/server.ts#L14)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/transports/pubsub.d.ts:116
 
 Represents an active client connection session on the server.
 This object provides a standardized way for the `EventServer` to interact
@@ -18,7 +18,7 @@ with a connection, regardless of the underlying transport protocol.
 
 > `optional` **clientId**: `string`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:22](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/transports/pubsub/server.ts#L22)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/transports/pubsub.d.ts:124
 
 The unique identifier for the client associated with this session.
 
@@ -28,7 +28,7 @@ The unique identifier for the client associated with this session.
 
 > **close**: () => `void`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:37](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/transports/pubsub/server.ts#L37)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/transports/pubsub.d.ts:139
 
 Closes the connection for this session.
 
@@ -42,7 +42,7 @@ Closes the connection for this session.
 
 > **id**: `string`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:18](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/transports/pubsub/server.ts#L18)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/transports/pubsub.d.ts:120
 
 A unique identifier for the session, typically generated by the transport layer upon connection.
 
@@ -52,7 +52,7 @@ A unique identifier for the session, typically generated by the transport layer
 
 > **protocol**: `string`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:26](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/transports/pubsub/server.ts#L26)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/transports/pubsub.d.ts:128
 
 The protocol being used for this session (e.g., 'sse', 'ws', 'ipc').
 
@@ -62,7 +62,7 @@ The protocol being used for this session (e.g., 'sse', 'ws', 'ipc').
 
 > `optional` **raw**: `any`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:43](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/transports/pubsub/server.ts#L43)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/transports/pubsub.d.ts:145
 
 A reference to the raw, underlying connection object or handle
 (e.g., a Node.js `ServerResponse` for SSE, or a WebSocket instance).
@@ -74,7 +74,7 @@ Use with caution as it is transport-specific.
 
 > **send**: (`event`, `data`, `ctx?`) => `void`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:33](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/transports/pubsub/server.ts#L33)
+Defined in: @isdk/ai-tools/packages/tool-event/dist/transports/pubsub.d.ts:135
 
 Sends an event and data to the client associated with this session.
 
@@ -94,7 +94,7 @@ The payload for the event.
 
 ##### ctx?
 
-[`PubSubCtx`](../type-aliases/PubSubCtx.md)
+[`PubSubCtx`](../type-aliases/PubSubCtx.md)\<`any`\>
 
 Optional context for the PubSub operation.
 

package/docs/api/interfaces/RegisterOptions.md

@@ -0,0 +1,298 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / RegisterOptions
+
+# Interface: RegisterOptions
+
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:323
+
+Options for registering a tool function.
+
+## Extends
+
+- [`FuncItem`](FuncItem.md)
+
+## Properties
+
+### alias?
+
+> `optional` **alias**: `string` \| `string`[]
+
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:258
+
+Optional aliases for the function name.
+
+#### Inherited from
+
+[`FuncItem`](FuncItem.md).[`alias`](FuncItem.md#alias)
+
+***
+
+### allowOverride?
+
+> `optional` **allowOverride**: `boolean` \| \{ `alias?`: `boolean`; `name?`: `boolean`; \}
+
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:330
+
+Optional override behavior:
+- `true`: Allows overwriting an existing function with the same name.
+- `{ name: true }`: Same as `true`.
+- `{ alias: true }`: Allows stealing existing aliases from other functions.
+
+***
+
+### asyncFeatures?
+
+> `optional` **asyncFeatures**: `number`
+
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:272
+
+A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
+This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
+
+#### See
+
+AsyncFeatureBits from `@src/utils/cancelable-ability.ts`
+
+#### Example
+
+```ts
+import { AsyncFeatures } from './utils';
+const func = new ToolFunc({
+  name: 'cancellableTask',
+  asyncFeatures: AsyncFeatures.Cancelable | AsyncFeatures.MultiTask,
+  // ...
+});
+```
+
+#### Inherited from
+
+[`FuncItem`](FuncItem.md).[`asyncFeatures`](FuncItem.md#asyncfeatures)
+
+***
+
+### depends?
+
+> `optional` **depends**: `object`
+
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:295
+
+A map of dependencies this function has on other tool functions.
+Declaring dependencies ensures that they are automatically registered when this function is registered.
+This is crucial for building modular functions that rely on each other without needing to manage registration order manually.
+
+#### Index Signature
+
+\[`name`: `string`\]: [`ToolFunc`](../classes/ToolFunc.md)
+
+#### Example
+
+```ts
+const helperFunc = new ToolFunc({ name: 'helper', func: () => 'world' });
+const mainFunc = new ToolFunc({
+  name: 'main',
+  depends: {
+    helper: helperFunc,
+  },
+  func() {
+    // We can now safely run the dependency
+    const result = this.runSync('helper');
+    return `Hello, ${result}`;
+  }
+});
+// When mainFunc is registered, helperFunc will be registered automatically.
+mainFunc.register();
+```
+
+#### Inherited from
+
+[`FuncItem`](FuncItem.md).[`depends`](FuncItem.md#depends)
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:302
+
+A detailed description of what the function does.
+
+#### Inherited from
+
+[`FuncItem`](FuncItem.md).[`description`](FuncItem.md#description)
+
+***
+
+### func?
+
+> `optional` **func**: [`TFunc`](../type-aliases/TFunc.md)
+
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:318
+
+The implementation of the tool function.
+
+#### Inherited from
+
+[`FuncItem`](FuncItem.md).[`func`](FuncItem.md#func)
+
+***
+
+### isApi?
+
+> `optional` **isApi**: `boolean`
+
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:247
+
+If true, indicates that this function should be treated as a server-side API.
+
+#### Inherited from
+
+[`FuncItem`](FuncItem.md).[`isApi`](FuncItem.md#isapi)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:204
+
+The unique name of the function.
+
+#### Inherited from
+
+[`FuncItem`](FuncItem.md).[`name`](FuncItem.md#name)
+
+***
+
+### params?
+
+> `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
+
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:209
+
+Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
+
+#### Inherited from
+
+[`FuncItem`](FuncItem.md).[`params`](FuncItem.md#params)
+
+***
+
+### result?
+
+> `optional` **result**: `string` \| `Record`\<`string`, `any`\>
+
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:214
+
+The expected return type of the function, described as a string or a JSON schema object.
+
+#### Inherited from
+
+[`FuncItem`](FuncItem.md).[`result`](FuncItem.md#result)
+
+***
+
+### scope?
+
+> `optional` **scope**: `any`
+
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:219
+
+The execution scope or context (`this`) for the function.
+
+#### Inherited from
+
+[`FuncItem`](FuncItem.md).[`scope`](FuncItem.md#scope)
+
+***
+
+### setup()?
+
+> `optional` **setup**: (`this`, `options?`) => `void`
+
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:242
+
+A lifecycle hook called once during the `ToolFunc` instance's initialization.
+It allows for initial setup, state configuration, or property modification on the instance
+before it is used or registered. The `this` context is the `ToolFunc` instance itself.
+
+#### Parameters
+
+##### this
+
+[`ToolFunc`](../classes/ToolFunc.md)
+
+##### options?
+
+[`FuncItem`](FuncItem.md)
+
+The configuration options for the function.
+
+#### Returns
+
+`void`
+
+#### Example
+
+```ts
+const myFunc = new ToolFunc({
+  name: 'myFunc',
+  customState: 'initial',
+  setup() {
+    // `this` is the myFunc instance
+    this.customState = 'configured';
+  }
+});
+console.log(myFunc.customState); // Outputs: 'configured'
+```
+
+#### Inherited from
+
+[`FuncItem`](FuncItem.md).[`setup`](FuncItem.md#setup)
+
+***
+
+### stream?
+
+> `optional` **stream**: `boolean`
+
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:253
+
+If true, indicates that the function has the *capability* to stream its output.
+Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
+
+#### Inherited from
+
+[`FuncItem`](FuncItem.md).[`stream`](FuncItem.md#stream)
+
+***
+
+### tags?
+
+> `optional` **tags**: `string` \| `string`[]
+
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:224
+
+Tags for grouping or filtering functions.
+
+#### Inherited from
+
+[`FuncItem`](FuncItem.md).[`tags`](FuncItem.md#tags)
+
+***
+
+### title?
+
+> `optional` **title**: `string`
+
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:307
+
+A concise, human-readable title for the function, often used in UI or by AI.
+
+#### Inherited from
+
+[`FuncItem`](FuncItem.md).[`title`](FuncItem.md#title)