@cavell/kit API
    Preparing search index...

    Function useRenderTool

    • Registers a wildcard ("*") renderer for tool calls.

      The wildcard renderer is used as a fallback when no exact name-matched renderer is registered for a tool call.

      Parameters

      • config: { agentId?: string; name: "*"; render: (props: any) => ReactElement }

        Wildcard renderer configuration.

      • Optionaldeps: readonly unknown[]

        Optional dependencies to refresh registration.

      Returns void

      useRenderTool(
        {
          name: "*",
          render: ({ name, status }) => (
            <div>
              {status === "complete" ? "✓" : "⏳"} {name}
            </div>
          ),
        },
        [],
      );

    • Registers a name-scoped renderer for tool calls.

      The provided parameters schema defines the typed shape of props.parameters in render for executing and complete states. Accepts any Standard Schema V1 compatible library (Zod, Valibot, ArkType, etc.).

      Type Parameters

      • S extends StandardSchemaV1<unknown, unknown>

        Schema type describing tool call parameters.

      Parameters

      • config: {
            agentId?: string;
            name: string;
            parameters: S;
            render: (props: RenderToolProps<S>) => ReactElement;
        }

        Named renderer configuration.

      • Optionaldeps: readonly unknown[]

        Optional dependencies to refresh registration.

      Returns void

      useRenderTool(
        {
          name: "searchDocs",
          parameters: z.object({ query: z.string() }),
          render: ({ status, parameters, result }) => {
            if (status === "inProgress") return <div>Preparing...</div>;
            if (status === "executing") return <div>Searching {parameters.query}</div>;
            return <div>{result}</div>;
          },
        },
        [],
      );

    Settings
    Member Visibility