---
search:
  exclude: true
---
# ツール

ツールは エージェント がアクションを取るための手段です。具体的には、データ取得、コード実行、外部 API 呼び出し、さらにはコンピュータ操作まで行えます。Agents SDK には次の 3 つのツール クラスがあります。

-   Hosted ツール: これらは LLM サーバー上で AI モデルと並列に実行されます。OpenAI は retrieval、Web 検索、コンピュータ操作を Hosted ツールとして提供しています。  
-   Function Calling: 任意の Python 関数をツールとして利用できます。  
-   ツールとしての エージェント: エージェント をツールとして扱い、ハンドオフせずに他の エージェント を呼び出せます。  

## Hosted ツール

[`OpenAIResponsesModel`][agents.models.openai_responses.OpenAIResponsesModel] を使用する場合、OpenAI はいくつかの組み込みツールを提供しています。

-   [`WebSearchTool`][agents.tool.WebSearchTool] は エージェント に Web 検索を実行させます。  
-   [`FileSearchTool`][agents.tool.FileSearchTool] は OpenAI ベクトルストア から情報を取得します。  
-   [`ComputerTool`][agents.tool.ComputerTool] はコンピュータ操作タスクを自動化します。  
-   [`CodeInterpreterTool`][agents.tool.CodeInterpreterTool] は LLM がサンドボックス環境でコードを実行できるようにします。  
-   [`HostedMCPTool`][agents.tool.HostedMCPTool] はリモート MCP サーバーのツールをモデルへ公開します。  
-   [`ImageGenerationTool`][agents.tool.ImageGenerationTool] はプロンプトから画像を生成します。  
-   [`LocalShellTool`][agents.tool.LocalShellTool] はローカルマシンでシェルコマンドを実行します。  

```python
from agents import Agent, FileSearchTool, Runner, WebSearchTool

agent = Agent(
    name="Assistant",
    tools=[
        WebSearchTool(),
        FileSearchTool(
            max_num_results=3,
            vector_store_ids=["VECTOR_STORE_ID"],
        ),
    ],
)

async def main():
    result = await Runner.run(agent, "Which coffee shop should I go to, taking into account my preferences and the weather today in SF?")
    print(result.final_output)
```

## Function ツール

任意の Python 関数をツールとして利用できます。Agents SDK が自動でセットアップを行います。

-   ツール名は Python 関数名になります（または任意の名前を指定可能）  
-   ツールの説明は関数の docstring から取得されます（または任意の説明を指定可能）  
-   関数入力のスキーマは引数から自動生成されます  
-   各入力の説明は、無効化しない限り docstring から取得されます  

Python の `inspect` モジュールで関数シグネチャを抽出し、[`griffe`](https://mkdocstrings.github.io/griffe/) で docstring を解析、`pydantic` でスキーマを作成します。

```python
import json

from typing_extensions import TypedDict, Any

from agents import Agent, FunctionTool, RunContextWrapper, function_tool


class Location(TypedDict):
    lat: float
    long: float

@function_tool  # (1)!
async def fetch_weather(location: Location) -> str:
    # (2)!
    """Fetch the weather for a given location.

    Args:
        location: The location to fetch the weather for.
    """
    # In real life, we'd fetch the weather from a weather API
    return "sunny"


@function_tool(name_override="fetch_data")  # (3)!
def read_file(ctx: RunContextWrapper[Any], path: str, directory: str | None = None) -> str:
    """Read the contents of a file.

    Args:
        path: The path to the file to read.
        directory: The directory to read the file from.
    """
    # In real life, we'd read the file from the file system
    return "<file contents>"


agent = Agent(
    name="Assistant",
    tools=[fetch_weather, read_file],  # (4)!
)

for tool in agent.tools:
    if isinstance(tool, FunctionTool):
        print(tool.name)
        print(tool.description)
        print(json.dumps(tool.params_json_schema, indent=2))
        print()

```

1.  引数には任意の Python 型を使用でき、関数は sync / async のいずれでも構いません。  
2.  docstring が存在する場合、説明および引数の説明を取得します。  
3.  関数は任意で `context` を最初の引数として受け取れます。また、ツール名や説明、docstring スタイルなどのオーバーライドも設定できます。  
4.  装飾済み関数をツールのリストに渡すだけで利用可能です。  

??? note "出力を表示"

    ```
    fetch_weather
    Fetch the weather for a given location.
    {
    "$defs": {
      "Location": {
        "properties": {
          "lat": {
            "title": "Lat",
            "type": "number"
          },
          "long": {
            "title": "Long",
            "type": "number"
          }
        },
        "required": [
          "lat",
          "long"
        ],
        "title": "Location",
        "type": "object"
      }
    },
    "properties": {
      "location": {
        "$ref": "#/$defs/Location",
        "description": "The location to fetch the weather for."
      }
    },
    "required": [
      "location"
    ],
    "title": "fetch_weather_args",
    "type": "object"
    }

    fetch_data
    Read the contents of a file.
    {
    "properties": {
      "path": {
        "description": "The path to the file to read.",
        "title": "Path",
        "type": "string"
      },
      "directory": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "default": null,
        "description": "The directory to read the file from.",
        "title": "Directory"
      }
    },
    "required": [
      "path"
    ],
    "title": "fetch_data_args",
    "type": "object"
    }
    ```

### カスタム Function ツール

Python 関数を使わない場合は、[`FunctionTool`][agents.tool.FunctionTool] を直接作成できます。必要項目は以下のとおりです。

-   `name`  
-   `description`  
-   `params_json_schema` : 引数用の JSON schema  
-   `on_invoke_tool` : [`ToolContext`][agents.tool_context.ToolContext] と JSON 文字列の引数を受け取り、ツール出力を文字列で返す async 関数  

```python
from typing import Any

from pydantic import BaseModel

from agents import RunContextWrapper, FunctionTool



def do_some_work(data: str) -> str:
    return "done"


class FunctionArgs(BaseModel):
    username: str
    age: int


async def run_function(ctx: RunContextWrapper[Any], args: str) -> str:
    parsed = FunctionArgs.model_validate_json(args)
    return do_some_work(data=f"{parsed.username} is {parsed.age} years old")


tool = FunctionTool(
    name="process_user",
    description="Processes extracted user data",
    params_json_schema=FunctionArgs.model_json_schema(),
    on_invoke_tool=run_function,
)
```

### 引数と docstring の自動解析

前述のとおり、関数シグネチャを自動解析してツール用スキーマを抽出し、docstring を解析してツールおよび各引数の説明を取得します。主なポイントは以下のとおりです。

1.  シグネチャ解析は `inspect` モジュールで行います。型アノテーションを用いて引数の型を把握し、Pydantic モデルを動的に構築します。Python の基本型、Pydantic モデル、TypedDict など大半の型をサポートします。  
2.  docstring 解析には `griffe` を使用します。対応フォーマットは `google`, `sphinx`, `numpy` です。フォーマットは自動検出を試みますが、`function_tool` 呼び出し時に明示設定も可能です。`use_docstring_info` を `False` にすると docstring 解析を無効化できます。  

スキーマ抽出のコードは [`agents.function_schema`][] にあります。

## ツールとしての エージェント

ワークフローによっては、制御を渡さずに中央の エージェント が専門 エージェント のネットワークをオーケストレーションしたい場合があります。その際には エージェント をツールとしてモデル化できます。

```python
from agents import Agent, Runner
import asyncio

spanish_agent = Agent(
    name="Spanish agent",
    instructions="You translate the user's message to Spanish",
)

french_agent = Agent(
    name="French agent",
    instructions="You translate the user's message to French",
)

orchestrator_agent = Agent(
    name="orchestrator_agent",
    instructions=(
        "You are a translation agent. You use the tools given to you to translate."
        "If asked for multiple translations, you call the relevant tools."
    ),
    tools=[
        spanish_agent.as_tool(
            tool_name="translate_to_spanish",
            tool_description="Translate the user's message to Spanish",
        ),
        french_agent.as_tool(
            tool_name="translate_to_french",
            tool_description="Translate the user's message to French",
        ),
    ],
)

async def main():
    result = await Runner.run(orchestrator_agent, input="Say 'Hello, how are you?' in Spanish.")
    print(result.final_output)
```

### ツールエージェントのカスタマイズ

`agent.as_tool` は エージェント を簡単にツールへ変換するためのヘルパーですが、すべての設定をサポートするわけではありません（例: `max_turns` は設定不可）。高度なユースケースでは、ツール実装内で `Runner.run` を直接使用してください。

```python
@function_tool
async def run_my_agent() -> str:
    """A tool that runs the agent with custom configs"""

    agent = Agent(name="My agent", instructions="...")

    result = await Runner.run(
        agent,
        input="...",
        max_turns=5,
        run_config=...
    )

    return str(result.final_output)
```

### カスタム出力抽出

場合によっては、ツールエージェントの出力を中央 エージェント へ返す前に加工したいことがあります。例えば次のようなケースです。

-   サブエージェントのチャット履歴から特定情報（例: JSON ペイロード）だけを抽出したい。  
-   エージェント の最終回答を変換・再フォーマットしたい（例: Markdown をプレーンテキストや CSV に変換）。  
-   出力を検証し、不足や不正の場合にフォールバック値を返したい。  

その場合は `as_tool` メソッドに `custom_output_extractor` 引数を渡してください。

```python
async def extract_json_payload(run_result: RunResult) -> str:
    # Scan the agent’s outputs in reverse order until we find a JSON-like message from a tool call.
    for item in reversed(run_result.new_items):
        if isinstance(item, ToolCallOutputItem) and item.output.strip().startswith("{"):
            return item.output.strip()
    # Fallback to an empty JSON object if nothing was found
    return "{}"


json_tool = data_agent.as_tool(
    tool_name="get_data_json",
    tool_description="Run the data agent and return only its JSON payload",
    custom_output_extractor=extract_json_payload,
)
```

## Function ツールのエラー処理

`@function_tool` で Function ツールを作成する際、`failure_error_function` を渡せます。これはツール呼び出しがクラッシュした際に LLM へ返すエラーレスポンスを生成する関数です。

-   既定では `default_tool_error_function` が実行され、LLM にエラー発生を伝えます。  
-   独自のエラー関数を渡すと、それが実行されて LLM へレスポンスが送信されます。  
-   明示的に `None` を渡した場合、ツール呼び出しエラーは再スローされます。モデルが無効な JSON を生成した場合は `ModelBehaviorError`、コードがクラッシュした場合は `UserError` などになります。  

`FunctionTool` オブジェクトを手動で作成する場合は、`on_invoke_tool` 内でエラー処理を行う必要があります。