> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-sdk-testing-latest.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# クラス: Tool

> TypeScript SDK リファレンス

[weave](../) / Tool

ツール呼び出しを表します。ツール名、
JSON エンコードされた引数、ツール呼び出し ID、および結果を含む
`execute_tool` span を生成します。

`weave.startTool()` (または `turn.startTool()`、あるいは
`llm.startTool()`) によって作成され、`end()` で終了します。span にツールの出力を記録するには、
`end()` を呼び出す前に `result` を設定してください。

`例`

```ts theme={null}
const tool = weave.startTool({
  name: tc.function.name,
  args: tc.function.arguments,
  toolCallId: tc.id,
});
try {
  tool.result = await wikipediaSearch(JSON.parse(tc.function.arguments));
} finally {
  tool.end();
}
```

<div id="table-of-contents">
  ## 目次
</div>

<div id="properties">
  ### プロパティ
</div>

* [args](./tool#args)
* [name](./tool#name)
* [result](./tool#result)
* [toolCallId](./tool#toolcallid)

<div id="methods">
  ### メソッド
</div>

* [end](./tool#end)
* [create](./tool#create)

## プロパティ

<div id="args">
  ### args
</div>

• `Readonly` **args**: `string`

<div id="defined-in">
  #### 定義元
</div>

[genai/tool.ts:52](https://github.com/wandb/weave/blob/6538626556c93d6f31ae725fdefe4e6b8b71bc2c/sdks/node/src/genai/tool.ts#L52)

***

<div id="name">
  ### 名
</div>

• `Readonly` **name**: `string`

<div id="defined-in">
  #### 定義元
</div>

[genai/tool.ts:51](https://github.com/wandb/weave/blob/6538626556c93d6f31ae725fdefe4e6b8b71bc2c/sdks/node/src/genai/tool.ts#L51)

***

<div id="result">
  ### result
</div>

• `Optional` **result**: `string`

文字列形式のツール出力です。`end()` で `gen_ai.tool.call.result` に記録されます。

<div id="defined-in">
  #### 定義元
</div>

[genai/tool.ts:45](https://github.com/wandb/weave/blob/6538626556c93d6f31ae725fdefe4e6b8b71bc2c/sdks/node/src/genai/tool.ts#L45)

***

<div id="toolcallid">
  ### toolCallId
</div>

• `Readonly` **toolCallId**: `string`

<div id="defined-in">
  #### 定義元
</div>

[genai/tool.ts:53](https://github.com/wandb/weave/blob/6538626556c93d6f31ae725fdefe4e6b8b71bc2c/sdks/node/src/genai/tool.ts#L53)

## メソッド

<div id="end">
  ### end
</div>

▸ **end**(`opts?`): `void`

`result` を span にフラッシュしてから閉じます。冪等です。`error` を渡すと、
span は失敗としてマークされます。

<div id="parameters">
  #### パラメーター
</div>

| 名             | タイプ      |
| :------------ | :------- |
| `opts?`       | `Object` |
| `opts.error?` | `Error`  |

<div id="returns">
  #### 戻り値
</div>

`void`

<div id="defined-in">
  #### 定義元
</div>

[genai/tool.ts:83](https://github.com/wandb/weave/blob/6538626556c93d6f31ae725fdefe4e6b8b71bc2c/sdks/node/src/genai/tool.ts#L83)

***

<div id="create">
  ### create
</div>

▸ **create**(`opts`): [`Tool`](./tool)

<div id="parameters">
  #### パラメーター
</div>

| 名      | タイプ                                                       |
| :----- | :-------------------------------------------------------- |
| `opts` | [`ToolInit`](../interfaces/toolinit) & `ChildSpanContext` |

<div id="returns">
  #### 戻り値
</div>

[`Tool`](./tool)

<div id="defined-in">
  #### 定義元
</div>

[genai/tool.ts:56](https://github.com/wandb/weave/blob/6538626556c93d6f31ae725fdefe4e6b8b71bc2c/sdks/node/src/genai/tool.ts#L56)