# `vllm_mlx.tool_parsers.auto_tool_parser`

Auto-detecting tool call parser for vllm-mlx.

[View the complete module source at #L1-L414](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/vllm_mlx/tool_parsers/auto_tool_parser.py#L1-L414).

## API details

Each callable below includes its exact signature, type annotations, inputs, defaults, return contract, documented exceptions, implementation source, and parsed docstring sections when the source provides them.

::: vllm_mlx.tool_parsers.auto_tool_parser
    options:
      members:
        - generate_tool_id
        - AutoToolParser
      filters: []
      show_if_no_docstring: true

## Complete contract reference

Expand any definition for its exact inputs, annotations, defaults, return contract, directly raised exceptions, source-grounded behavior, and immutable line link. This section includes private and nested definitions that ordinary API generators omit.

<details class="api-contract" id="contract-vllm_mlx.tool_parsers.auto_tool_parser.generate_tool_id" markdown="1">
<summary><code>vllm_mlx.tool_parsers.auto_tool_parser.generate_tool_id</code> · function</summary>

```python
vllm_mlx.tool_parsers.auto_tool_parser.generate_tool_id() -> str
```

Generate a unique tool call ID.

**Parameters**

This callable has no explicit inputs.

**Returns**

- Type: `str`
- Direct return expressions: `f'call_{uuid.uuid4().hex[:8]}'`

**Exceptions and behavior**

Function `generate_tool_id` calls `uuid.uuid4`; returns `f'call_{uuid.uuid4().hex[:8]}'`.
No direct `raise` statement appears in this definition.

[View source #L22-L24](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/vllm_mlx/tool_parsers/auto_tool_parser.py#L22-L24).

</details>

<details class="api-contract" id="contract-vllm_mlx.tool_parsers.auto_tool_parser.AutoToolParser" markdown="1">
<summary><code>vllm_mlx.tool_parsers.auto_tool_parser.AutoToolParser</code> · class</summary>

```python
vllm_mlx.tool_parsers.auto_tool_parser.AutoToolParser()
```

Auto-detecting tool call parser.

**Parameters**

This callable has no explicit inputs.

**Returns**

- Constructs: `vllm_mlx.tool_parsers.auto_tool_parser.AutoToolParser`

**Exceptions and behavior**

Class `AutoToolParser` derives from `ToolParser` and declares 3 direct member(s).
No direct `raise` statement appears in this definition.

[View source #L28-L414](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/vllm_mlx/tool_parsers/auto_tool_parser.py#L28-L414).

</details>

<details class="api-contract" id="contract-vllm_mlx.tool_parsers.auto_tool_parser.AutoToolParser.extract_tool_calls" markdown="1">
<summary><code>vllm_mlx.tool_parsers.auto_tool_parser.AutoToolParser.extract_tool_calls</code> · method</summary>

```python
vllm_mlx.tool_parsers.auto_tool_parser.AutoToolParser.extract_tool_calls(model_output: str, request: dict[str, Any] | None = None) -> ExtractedToolCallInformation
```

Extract tool calls by trying all known formats.

**Parameters**

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `model_output` | `str` | `yes` | `none` | Required positional or keyword input. |
| `request` | `dict[str, Any] \| None` | `no` | `None` | Optional positional or keyword input; defaults to `None`. |

**Returns**

- Type: `ExtractedToolCallInformation`
- Direct return expressions: `result`; `ExtractedToolCallInformation(tools_called=True, tool_calls=tool_calls, content=content if content else None)`; `ExtractedToolCallInformation(tools_called=True, tool_calls=tool_calls, content=cleaned_text if cleaned_text else None)`; `ExtractedToolCallInformation(tools_called=False, tool_calls=[], content=model_output)`

**Exceptions and behavior**

Method `AutoToolParser.extract_tool_calls` calls `Gemma4ToolParser`, `gemma_parser.extract_tool_calls`, `model_output.split`, `parts[0].strip`; has 4 explicit return paths.
No direct `raise` statement appears in this definition.

[View source #L61-L268](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/vllm_mlx/tool_parsers/auto_tool_parser.py#L61-L268).

</details>

<details class="api-contract" id="contract-vllm_mlx.tool_parsers.auto_tool_parser.AutoToolParser._parse_raw_json_tool_calls" markdown="1">
<summary><code>vllm_mlx.tool_parsers.auto_tool_parser.AutoToolParser._parse_raw_json_tool_calls</code> · method</summary>

```python
vllm_mlx.tool_parsers.auto_tool_parser.AutoToolParser._parse_raw_json_tool_calls(text: str) -> list[dict[str, Any]]
```

Parse raw JSON tool calls from text.

**Parameters**

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `text` | `str` | `yes` | `none` | Required positional or keyword input. |

**Returns**

- Type: `list[dict[str, Any]]`
- Direct return expressions: `[]`; `tool_calls`

**Exceptions and behavior**

Method `AutoToolParser._parse_raw_json_tool_calls` calls `text.strip`, `text.startswith`, `json.loads`, `isinstance`; has 2 explicit return paths.
No direct `raise` statement appears in this definition.

[View source #L270-L350](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/vllm_mlx/tool_parsers/auto_tool_parser.py#L270-L350).

</details>

<details class="api-contract" id="contract-vllm_mlx.tool_parsers.auto_tool_parser.AutoToolParser.extract_tool_calls_streaming" markdown="1">
<summary><code>vllm_mlx.tool_parsers.auto_tool_parser.AutoToolParser.extract_tool_calls_streaming</code> · method</summary>

```python
vllm_mlx.tool_parsers.auto_tool_parser.AutoToolParser.extract_tool_calls_streaming(previous_text: str, current_text: str, delta_text: str, previous_token_ids: Sequence[int] | None = None, current_token_ids: Sequence[int] | None = None, delta_token_ids: Sequence[int] | None = None, request: dict[str, Any] | None = None) -> dict[str, Any] | None
```

Extract tool calls from streaming model output.

**Parameters**

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `previous_text` | `str` | `yes` | `none` | Required positional or keyword input. |
| `current_text` | `str` | `yes` | `none` | Required positional or keyword input. |
| `delta_text` | `str` | `yes` | `none` | Required positional or keyword input. |
| `previous_token_ids` | `Sequence[int] \| None` | `no` | `None` | Optional positional or keyword input; defaults to `None`. |
| `current_token_ids` | `Sequence[int] \| None` | `no` | `None` | Optional positional or keyword input; defaults to `None`. |
| `delta_token_ids` | `Sequence[int] \| None` | `no` | `None` | Optional positional or keyword input; defaults to `None`. |
| `request` | `dict[str, Any] \| None` | `no` | `None` | Optional positional or keyword input; defaults to `None`. |

**Returns**

- Type: `dict[str, Any] | None`
- Direct return expressions: `None`; `{'content': delta_text}`; `{'tool_calls': [{'index': i, 'id': tc['id'], 'type': 'function', 'function': {'name': tc['name'], 'arguments': tc['argu…`

**Exceptions and behavior**

Method `AutoToolParser.extract_tool_calls_streaming` calls `any`, `self.BARE_BRACKET_PARTIAL_PATTERN.search`, `self.BARE_BRACKET_PATTERN.search`, `self.extract_tool_calls`; has 3 explicit return paths.
No direct `raise` statement appears in this definition.

[View source #L352-L414](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/vllm_mlx/tool_parsers/auto_tool_parser.py#L352-L414).

</details>

## Complete symbol map

This map also includes private definitions and nested helpers. The signature column exposes every explicit input even when an internal helper has no dedicated parameter prose.

| Symbol | Kind | Signature and inputs | What it does | Source |
| --- | --- | --- | --- | --- |
| [`generate_tool_id`](#contract-vllm_mlx.tool_parsers.auto_tool_parser.generate_tool_id) | function | `generate_tool_id() -> str` | Generate a unique tool call ID. | [#L22-L24](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/vllm_mlx/tool_parsers/auto_tool_parser.py#L22-L24) |
| [`AutoToolParser`](#contract-vllm_mlx.tool_parsers.auto_tool_parser.AutoToolParser) | class | `AutoToolParser()` | Auto-detecting tool call parser. | [#L28-L414](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/vllm_mlx/tool_parsers/auto_tool_parser.py#L28-L414) |
| [`AutoToolParser.extract_tool_calls`](#contract-vllm_mlx.tool_parsers.auto_tool_parser.AutoToolParser.extract_tool_calls) | method | `AutoToolParser.extract_tool_calls(model_output: str, request: dict[str, Any] \| None = None) -> ExtractedToolCallInformation` | Extract tool calls by trying all known formats. | [#L61-L268](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/vllm_mlx/tool_parsers/auto_tool_parser.py#L61-L268) |
| [`AutoToolParser._parse_raw_json_tool_calls`](#contract-vllm_mlx.tool_parsers.auto_tool_parser.AutoToolParser._parse_raw_json_tool_calls) | method | `AutoToolParser._parse_raw_json_tool_calls(text: str) -> list[dict[str, Any]]` | Parse raw JSON tool calls from text. | [#L270-L350](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/vllm_mlx/tool_parsers/auto_tool_parser.py#L270-L350) |
| [`AutoToolParser.extract_tool_calls_streaming`](#contract-vllm_mlx.tool_parsers.auto_tool_parser.AutoToolParser.extract_tool_calls_streaming) | method | `AutoToolParser.extract_tool_calls_streaming(previous_text: str, current_text: str, delta_text: str, previous_token_ids: Sequence[int] \| None = None, current_token_ids: Sequence[int] \| None = None, delta_token_ids: Sequence[int] \| None = None, request: dict[str, Any] \| None = None) -> dict[str, Any] \| None` | Extract tool calls from streaming model output. | [#L352-L414](https://github.com/waybarrios/vllm-mlx/blob/a69d47912bcb21d8fe04d48f75fa896b620ffcfa/vllm_mlx/tool_parsers/auto_tool_parser.py#L352-L414) |