---
title: "Tools hooks"
description: "@aeontel-generated by packages/react/scripts/gen.ts
DO NOT EDIT BY HAND. Run `pnpm gen` to regenerate.
Source: packages/shared/src/manifest/tool.ts"
section: "Libraries"
group: "React hooks"
order: 460
---

## Hooks

### `useCreateTool` `mutation`

Create a tool.

```ts
useCreateTool(options?: MutationOpts<Tool, CreateToolParams>)
```

**Types:** [Tool](/types/tool) · [CreateToolParams](/types/create-tool-params)

### `useDeleteTool` `mutation`

Soft-delete a tool.

```ts
useDeleteTool(options?: MutationOpts<SuccessResponse, string>)
```

**Types:** [SuccessResponse](/types/success-response)

### `useListTools` `query`

List tools.

```ts
useListTools(params?: Omit<ListToolsParams, | > & { filter?: ToolFilter; orderBy?: ToolOrderBy[]; } & ToolShorthands, options?: QueryOpts<Page<Tool>>)
```

**Types:** [ListToolsParams](/types/list-tools-params) · [ToolFilter](/types/tool-filter) · [ToolOrderBy](/types/tool-order-by) · [ToolShorthands](/types/tool-shorthands) · [Page](/types/page) · [Tool](/types/tool)

### `usePurgeTool` `composite`

Permanently delete a soft-deleted tool.

```ts
usePurgeTool(options?: MutationOpts<SuccessResponse, PurgeToolParams>)
```

**Types:** [SuccessResponse](/types/success-response) · [PurgeToolParams](/types/purge-tool-params)

### `useRestoreTool` `composite`

Restore a soft-deleted tool.

```ts
useRestoreTool(options?: MutationOpts<Tool, string>)
```

**Types:** [Tool](/types/tool)

### `useRetrieveTool` `query`

Get a tool by ID.

```ts
useRetrieveTool(id: string, options?: QueryOpts<Tool>)
```

**Types:** [Tool](/types/tool)

### `useUpdateTool` `mutation`

Update a tool.

```ts
useUpdateTool(options?: MutationOpts<Tool, UpdateToolParams>)
```

**Types:** [Tool](/types/tool) · [UpdateToolParams](/types/update-tool-params)