60e0ffc959
Upgrade checks / Notify on failure (push) Has been cancelled
Upgrade checks / Close issue on success (push) Has been cancelled
Schema Crash Test / Real-world schema crash test (232K schemas) (push) Has been cancelled
Run static analysis / static_analysis (push) Has been cancelled
Tests / Tests: Python 3.10 on ubuntu-latest (push) Has been cancelled
Tests / Tests: Python 3.13 on ubuntu-latest (push) Has been cancelled
Tests / Tests: Python 3.10 on windows-latest (push) Has been cancelled
Tests / Tests with lowest-direct dependencies (push) Has been cancelled
Tests / MCP conformance tests (push) Has been cancelled
Tests / Integration tests (push) Has been cancelled
Tests / Package install smoke (push) Has been cancelled
Upgrade checks / Static analysis (push) Has been cancelled
Upgrade checks / Tests: Python 3.10 on ubuntu-latest (push) Has been cancelled
Upgrade checks / Tests: Python 3.13 on ubuntu-latest (push) Has been cancelled
Upgrade checks / Tests: Python 3.10 on windows-latest (push) Has been cancelled
Upgrade checks / Integration tests (push) Has been cancelled
Update MCPServerConfig Schema / update-config-schema (push) Has been cancelled
Update SDK Documentation / update-sdk-docs (push) Has been cancelled
588 lines
22 KiB
Plaintext
588 lines
22 KiB
Plaintext
---
|
|
title: Sampling
|
|
sidebarTitle: Sampling
|
|
description: Request LLM text generation from the client or a configured provider through the MCP context.
|
|
icon: robot
|
|
---
|
|
|
|
import { VersionBadge } from "/snippets/version-badge.mdx"
|
|
|
|
<VersionBadge version="2.0.0" />
|
|
|
|
<Warning>
|
|
**Sampling is deprecated and will be removed in a future FastMCP release.**
|
|
|
|
`ctx.sample()` and `ctx.sample_step()` rely on server-initiated `createMessage`
|
|
requests, which MCP removed as of the 2026-07-28 protocol (SEP-2577). They work
|
|
only on session-based (handshake-era) connections; on a 2026-07-28 connection
|
|
they raise a clear error rather than reaching the client.
|
|
|
|
**Migration:** call an LLM directly from your server using your own API key and
|
|
provider SDK instead of borrowing the client's model. There is no drop-in
|
|
replacement on modern connections — this architectural shift is the intended
|
|
answer.
|
|
</Warning>
|
|
|
|
LLM sampling allows your MCP tools to request text generation from an LLM during execution. This enables tools to leverage AI capabilities for analysis, generation, reasoning, and more—without the client needing to orchestrate multiple calls.
|
|
|
|
By default, sampling requests are routed to the client's LLM. You can also configure a fallback handler to use a specific provider (like OpenAI) when the client doesn't support sampling, or to always use your own LLM regardless of client capabilities.
|
|
|
|
## Overview
|
|
|
|
The simplest use of sampling is passing a prompt string to `ctx.sample()`. The method sends the prompt to the LLM, waits for the complete response, and returns a `SamplingResult`. You can access the generated text through the `.text` attribute.
|
|
|
|
```python
|
|
from fastmcp import FastMCP, Context
|
|
|
|
mcp = FastMCP()
|
|
|
|
@mcp.tool
|
|
async def summarize(content: str, ctx: Context) -> str:
|
|
"""Generate a summary of the provided content."""
|
|
result = await ctx.sample(f"Please summarize this:\n\n{content}")
|
|
return result.text or ""
|
|
```
|
|
|
|
The `SamplingResult` also provides `.result` (identical to `.text` for plain text responses) and `.history` containing the full message exchange—useful if you need to continue the conversation or debug the interaction.
|
|
|
|
### System Prompts
|
|
|
|
System prompts let you establish the LLM's role and behavioral guidelines before it processes your request. This is useful for controlling tone, enforcing constraints, or providing context that shouldn't clutter the user-facing prompt.
|
|
|
|
````python
|
|
from fastmcp import FastMCP, Context
|
|
|
|
mcp = FastMCP()
|
|
|
|
@mcp.tool
|
|
async def generate_code(concept: str, ctx: Context) -> str:
|
|
"""Generate a Python code example for a concept."""
|
|
result = await ctx.sample(
|
|
messages=f"Write a Python example demonstrating '{concept}'.",
|
|
system_prompt=(
|
|
"You are an expert Python programmer. "
|
|
"Provide concise, working code without explanations."
|
|
),
|
|
temperature=0.7,
|
|
max_tokens=300
|
|
)
|
|
return f"```python\n{result.text}\n```"
|
|
````
|
|
|
|
The `temperature` parameter controls randomness—higher values (up to 1.0) produce more varied outputs, while lower values make responses more deterministic. The `max_tokens` parameter limits response length.
|
|
|
|
### Model Preferences
|
|
|
|
Model preferences let you hint at which LLM the client should use for a request. You can pass a single model name or a list of preferences in priority order. These are hints rather than requirements—the actual model used depends on what the client has available.
|
|
|
|
```python
|
|
from fastmcp import FastMCP, Context
|
|
|
|
mcp = FastMCP()
|
|
|
|
@mcp.tool
|
|
async def technical_analysis(data: str, ctx: Context) -> str:
|
|
"""Analyze data using a reasoning-focused model."""
|
|
result = await ctx.sample(
|
|
messages=f"Analyze this data:\n\n{data}",
|
|
model_preferences=["claude-opus-4-5", "gpt-5-2"],
|
|
temperature=0.2,
|
|
)
|
|
return result.text or ""
|
|
```
|
|
|
|
Use model preferences when different tasks benefit from different model characteristics. Creative writing might prefer faster models with higher temperature, while complex analysis might benefit from larger reasoning-focused models.
|
|
|
|
### Multi-Turn Conversations
|
|
|
|
For requests that need conversational context, construct a list of `SamplingMessage` objects representing the conversation history. Each message has a `role` ("user" or "assistant") and `content` (a `TextContent` object).
|
|
|
|
```python
|
|
from fastmcp.types import SamplingMessage, TextContent
|
|
from fastmcp import FastMCP, Context
|
|
|
|
mcp = FastMCP()
|
|
|
|
@mcp.tool
|
|
async def contextual_analysis(query: str, data: str, ctx: Context) -> str:
|
|
"""Analyze data with conversational context."""
|
|
messages = [
|
|
SamplingMessage(
|
|
role="user",
|
|
content=TextContent(type="text", text=f"Here's my data: {data}"),
|
|
),
|
|
SamplingMessage(
|
|
role="assistant",
|
|
content=TextContent(type="text", text="I see the data. What would you like to know?"),
|
|
),
|
|
SamplingMessage(
|
|
role="user",
|
|
content=TextContent(type="text", text=query),
|
|
),
|
|
]
|
|
result = await ctx.sample(messages=messages)
|
|
return result.text or ""
|
|
```
|
|
|
|
The LLM receives the full conversation thread and responds with awareness of the preceding context.
|
|
|
|
### Fallback Handlers
|
|
|
|
Client support for sampling is optional—some clients may not implement it. To ensure your tools work regardless of client capabilities, configure a `sampling_handler` that sends requests directly to an LLM provider.
|
|
|
|
FastMCP provides built-in handlers for [OpenAI and Anthropic APIs](/clients/sampling#built-in-handlers). These handlers support the full sampling API including tools, automatically converting your Python functions to each provider's format.
|
|
|
|
<Note>
|
|
Install handlers with `pip install fastmcp[openai]` or `pip install fastmcp[anthropic]`.
|
|
</Note>
|
|
|
|
```python
|
|
from fastmcp import FastMCP
|
|
from fastmcp.client.sampling.handlers.openai import OpenAISamplingHandler
|
|
|
|
server = FastMCP(
|
|
name="My Server",
|
|
sampling_handler=OpenAISamplingHandler(default_model="gpt-4o-mini"),
|
|
sampling_handler_behavior="fallback",
|
|
)
|
|
```
|
|
|
|
The `sampling_handler_behavior` parameter controls when the handler is used:
|
|
|
|
- **`"fallback"`** (default): Use the handler only when the client doesn't support sampling. This lets capable clients use their own LLM while ensuring your tools still work with clients that lack sampling support.
|
|
- **`"always"`**: Always use the handler, bypassing the client entirely. Use this when you need guaranteed control over which LLM processes requests—for cost control, compliance requirements, or when specific model characteristics are essential.
|
|
|
|
## Structured Output
|
|
|
|
<VersionBadge version="2.14.1" />
|
|
|
|
When you need validated, typed data instead of free-form text, use the `result_type` parameter. FastMCP ensures the LLM returns data matching your type, handling validation and retries automatically.
|
|
|
|
The `result_type` parameter accepts Pydantic models, dataclasses, and basic types like `int`, `list[str]`, or `dict[str, int]`. When you specify a result type, FastMCP automatically creates a `final_response` tool that the LLM calls to provide its response. If validation fails, the error is sent back to the LLM for retry.
|
|
|
|
```python
|
|
from pydantic import BaseModel
|
|
from fastmcp import FastMCP, Context
|
|
|
|
mcp = FastMCP()
|
|
|
|
class SentimentResult(BaseModel):
|
|
sentiment: str
|
|
confidence: float
|
|
reasoning: str
|
|
|
|
@mcp.tool
|
|
async def analyze_sentiment(text: str, ctx: Context) -> SentimentResult:
|
|
"""Analyze text sentiment with structured output."""
|
|
result = await ctx.sample(
|
|
messages=f"Analyze the sentiment of: {text}",
|
|
result_type=SentimentResult,
|
|
)
|
|
return result.result # A validated SentimentResult object
|
|
```
|
|
|
|
When you call this tool, the LLM returns a structured response that FastMCP validates against your Pydantic model. You access the validated object through `result.result`, while `result.text` contains the JSON representation.
|
|
|
|
### Structured Output with Tools
|
|
|
|
Combine structured output with tools for agentic workflows that return validated data. The LLM uses your tools to gather information, then returns a response matching your type.
|
|
|
|
```python
|
|
from pydantic import BaseModel
|
|
from fastmcp import FastMCP, Context
|
|
|
|
mcp = FastMCP()
|
|
|
|
def search(query: str) -> str:
|
|
"""Search the web for information."""
|
|
return f"Results for: {query}"
|
|
|
|
def fetch_url(url: str) -> str:
|
|
"""Fetch content from a URL."""
|
|
return f"Content from: {url}"
|
|
|
|
class ResearchResult(BaseModel):
|
|
summary: str
|
|
sources: list[str]
|
|
confidence: float
|
|
|
|
@mcp.tool
|
|
async def research(topic: str, ctx: Context) -> ResearchResult:
|
|
"""Research a topic and return structured findings."""
|
|
result = await ctx.sample(
|
|
messages=f"Research: {topic}",
|
|
tools=[search, fetch_url],
|
|
result_type=ResearchResult,
|
|
)
|
|
return result.result
|
|
```
|
|
|
|
<Note>
|
|
Structured output with automatic validation only applies to `sample()`. With `sample_step()`, you must manage structured output yourself.
|
|
</Note>
|
|
|
|
## Tool Use
|
|
|
|
<VersionBadge version="2.14.1" />
|
|
|
|
Sampling with tools enables agentic workflows where the LLM can call functions to gather information before responding. This implements [SEP-1577](https://github.com/modelcontextprotocol/modelcontextprotocol/issues/1577), allowing the LLM to autonomously orchestrate multi-step operations.
|
|
|
|
Pass Python functions to the `tools` parameter, and FastMCP handles the execution loop automatically—calling tools, returning results to the LLM, and continuing until the LLM provides a final response.
|
|
|
|
### Defining Tools
|
|
|
|
Define regular Python functions with type hints and docstrings. FastMCP extracts the function's name, docstring, and parameter types to create tool schemas that the LLM can understand.
|
|
|
|
```python
|
|
from fastmcp import FastMCP, Context
|
|
|
|
def search(query: str) -> str:
|
|
"""Search the web for information."""
|
|
return f"Results for: {query}"
|
|
|
|
def get_time() -> str:
|
|
"""Get the current time."""
|
|
from datetime import datetime
|
|
return datetime.now().strftime("%H:%M:%S")
|
|
|
|
mcp = FastMCP()
|
|
|
|
@mcp.tool
|
|
async def research(question: str, ctx: Context) -> str:
|
|
"""Answer questions using available tools."""
|
|
result = await ctx.sample(
|
|
messages=question,
|
|
tools=[search, get_time],
|
|
)
|
|
return result.text or ""
|
|
```
|
|
|
|
The LLM sees each function's signature and docstring, using this information to decide when and how to call them. Tool errors are caught and sent back to the LLM, allowing it to recover gracefully. An internal safety limit prevents infinite loops.
|
|
|
|
### Custom Tool Definitions
|
|
|
|
For custom names or descriptions, use `SamplingTool.from_function()`:
|
|
|
|
```python
|
|
from fastmcp.server.sampling import SamplingTool
|
|
|
|
tool = SamplingTool.from_function(
|
|
my_func,
|
|
name="custom_name",
|
|
description="Custom description"
|
|
)
|
|
|
|
result = await ctx.sample(messages="...", tools=[tool])
|
|
```
|
|
|
|
### Error Handling
|
|
|
|
By default, when a sampling tool raises an exception, the error message (including details) is sent back to the LLM so it can attempt recovery. To prevent sensitive information from leaking to the LLM, use the `mask_error_details` parameter:
|
|
|
|
```python
|
|
result = await ctx.sample(
|
|
messages=question,
|
|
tools=[search],
|
|
mask_error_details=True, # Generic error messages only
|
|
)
|
|
```
|
|
|
|
When `mask_error_details=True`, tool errors become generic messages like `"Error executing tool 'search'"` instead of exposing stack traces or internal details.
|
|
|
|
To intentionally provide specific error messages to the LLM regardless of masking, raise `ToolError`:
|
|
|
|
```python
|
|
from fastmcp.exceptions import ToolError
|
|
|
|
def search(query: str) -> str:
|
|
"""Search for information."""
|
|
if not query.strip():
|
|
raise ToolError("Search query cannot be empty")
|
|
return f"Results for: {query}"
|
|
```
|
|
|
|
`ToolError` messages always pass through to the LLM, making it the escape hatch for errors you want the LLM to see and handle.
|
|
|
|
### Concurrent Tool Execution
|
|
|
|
By default, tools execute sequentially — one at a time, in order. When your tools are independent (no shared state between them), you can execute them in parallel with `tool_concurrency`:
|
|
|
|
```python
|
|
result = await ctx.sample(
|
|
messages="Research these three topics",
|
|
tools=[search, fetch_url],
|
|
tool_concurrency=0, # Unlimited parallel execution
|
|
)
|
|
```
|
|
|
|
The `tool_concurrency` parameter controls how many tools run at once:
|
|
|
|
- **`None`** (default): Sequential execution
|
|
- **`0`**: Unlimited parallel execution
|
|
- **`N > 0`**: Execute at most N tools concurrently
|
|
|
|
For tools that must not run concurrently (file writes, shared state mutations, etc.), mark them as `sequential` when creating the `SamplingTool`:
|
|
|
|
```python
|
|
from fastmcp.server.sampling import SamplingTool
|
|
|
|
db_writer = SamplingTool.from_function(
|
|
write_to_db,
|
|
sequential=True, # Forces all tools in the batch to run sequentially
|
|
)
|
|
|
|
result = await ctx.sample(
|
|
messages="Process this data",
|
|
tools=[search, db_writer],
|
|
tool_concurrency=0, # Would be parallel, but db_writer forces sequential
|
|
)
|
|
```
|
|
|
|
<Note>
|
|
When any tool in a batch has `sequential=True`, the entire batch executes sequentially regardless of `tool_concurrency`. This is a conservative guarantee — if one tool needs ordering, all tools in that batch respect it.
|
|
</Note>
|
|
|
|
### Client Requirements
|
|
|
|
<Note>
|
|
Sampling with tools requires the client to advertise the `sampling.tools` capability. FastMCP clients do this automatically. For external clients that don't support tool-enabled sampling, configure a fallback handler with `sampling_handler_behavior="always"`.
|
|
</Note>
|
|
|
|
## Advanced Control
|
|
|
|
<VersionBadge version="2.14.1" />
|
|
|
|
While `sample()` handles the tool execution loop automatically, some scenarios require fine-grained control over each step. The `sample_step()` method makes a single LLM call and returns a `SampleStep` containing the response and updated history.
|
|
|
|
Unlike `sample()`, `sample_step()` is stateless—it doesn't remember previous calls. You control the conversation by passing the full message history each time. The returned `step.history` includes all messages up through the current response, making it easy to continue the loop.
|
|
|
|
Use `sample_step()` when you need to:
|
|
|
|
- Inspect tool calls before they execute
|
|
- Implement custom termination conditions
|
|
- Add logging, metrics, or checkpointing between steps
|
|
- Build custom agentic loops with domain-specific logic
|
|
|
|
### Basic Loop
|
|
|
|
By default, `sample_step()` executes any tool calls and includes the results in the history. Call it in a loop, passing the updated history each time, until a stop condition is met.
|
|
|
|
```python
|
|
from fastmcp.types import SamplingMessage
|
|
from fastmcp import FastMCP, Context
|
|
|
|
mcp = FastMCP()
|
|
|
|
def search(query: str) -> str:
|
|
return f"Results for: {query}"
|
|
|
|
def get_time() -> str:
|
|
return "12:00 PM"
|
|
|
|
@mcp.tool
|
|
async def controlled_agent(question: str, ctx: Context) -> str:
|
|
"""Agent with manual loop control."""
|
|
messages: list[str | SamplingMessage] = [question]
|
|
|
|
while True:
|
|
step = await ctx.sample_step(
|
|
messages=messages,
|
|
tools=[search, get_time],
|
|
)
|
|
|
|
if step.is_tool_use:
|
|
# Tools already executed (execute_tools=True by default)
|
|
for call in step.tool_calls:
|
|
print(f"Called tool: {call.name}")
|
|
|
|
if not step.is_tool_use:
|
|
return step.text or ""
|
|
|
|
messages = step.history
|
|
```
|
|
|
|
### SampleStep Properties
|
|
|
|
Each `SampleStep` provides information about what the LLM returned:
|
|
|
|
| Property | Description |
|
|
|----------|-------------|
|
|
| `step.is_tool_use` | True if the LLM requested tool calls |
|
|
| `step.tool_calls` | List of tool calls requested (if any) |
|
|
| `step.text` | The text content (if any) |
|
|
| `step.history` | All messages exchanged so far |
|
|
|
|
The contents of `step.history` depend on `execute_tools`:
|
|
- **`execute_tools=True`** (default): Includes tool results, ready for the next iteration
|
|
- **`execute_tools=False`**: Includes the assistant's tool request, but you add results yourself
|
|
|
|
### Manual Tool Execution
|
|
|
|
Set `execute_tools=False` to handle tool execution yourself. When disabled, `step.history` contains the user message and the assistant's response with tool calls—but no tool results. You execute the tools and append the results as a user message.
|
|
|
|
```python
|
|
from fastmcp.types import SamplingMessage, ToolResultContent, TextContent
|
|
from fastmcp import FastMCP, Context
|
|
|
|
mcp = FastMCP()
|
|
|
|
@mcp.tool
|
|
async def research(question: str, ctx: Context) -> str:
|
|
"""Research with manual tool handling."""
|
|
|
|
def search(query: str) -> str:
|
|
return f"Results for: {query}"
|
|
|
|
def get_time() -> str:
|
|
return "12:00 PM"
|
|
|
|
tools = {"search": search, "get_time": get_time}
|
|
messages: list[SamplingMessage] = [question]
|
|
|
|
while True:
|
|
step = await ctx.sample_step(
|
|
messages=messages,
|
|
tools=list(tools.values()),
|
|
execute_tools=False,
|
|
)
|
|
|
|
if not step.is_tool_use:
|
|
return step.text or ""
|
|
|
|
# Execute tools and collect results
|
|
tool_results = []
|
|
for call in step.tool_calls:
|
|
fn = tools[call.name]
|
|
result = fn(**call.input)
|
|
tool_results.append(
|
|
ToolResultContent(
|
|
type="tool_result",
|
|
tool_use_id=call.id,
|
|
content=[TextContent(type="text", text=result)],
|
|
)
|
|
)
|
|
|
|
messages = list(step.history)
|
|
messages.append(SamplingMessage(role="user", content=tool_results))
|
|
```
|
|
|
|
To report an error to the LLM, set `is_error=True` on the tool result:
|
|
|
|
```python
|
|
tool_result = ToolResultContent(
|
|
type="tool_result",
|
|
tool_use_id=call.id,
|
|
content=[TextContent(type="text", text="Permission denied")],
|
|
is_error=True,
|
|
)
|
|
```
|
|
|
|
## Method Reference
|
|
|
|
<Card icon="code" title="ctx.sample()">
|
|
<ResponseField name="ctx.sample" type="async method">
|
|
Request text generation from the LLM, running to completion automatically.
|
|
|
|
<Expandable title="Parameters">
|
|
<ResponseField name="messages" type="str | list[str | SamplingMessage]">
|
|
The prompt to send. Can be a simple string or a list of messages for multi-turn conversations.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="system_prompt" type="str | None" default="None">
|
|
Instructions that establish the LLM's role and behavior.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="temperature" type="float | None" default="None">
|
|
Controls randomness (0.0 = deterministic, 1.0 = creative).
|
|
</ResponseField>
|
|
|
|
<ResponseField name="max_tokens" type="int | None" default="512">
|
|
Maximum tokens to generate.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="model_preferences" type="str | list[str] | None" default="None">
|
|
Hints for which model the client should use.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="tools" type="list[Callable] | None" default="None">
|
|
Functions the LLM can call during sampling.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="result_type" type="type[T] | None" default="None">
|
|
A type for validated structured output. Supports Pydantic models, dataclasses, and basic types like `int`, `list[str]`, or `dict[str, int]`.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="mask_error_details" type="bool | None" default="None">
|
|
If True, mask detailed error messages from tool execution. When None (default), uses the global `settings.mask_error_details` value. Tools can raise `ToolError` to bypass masking and provide specific error messages to the LLM.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="tool_concurrency" type="int | None" default="None">
|
|
Controls parallel execution of tools. `None` (default) for sequential, `0` for unlimited parallel, or a positive integer for bounded concurrency. If any tool has `sequential=True`, all tools execute sequentially regardless.
|
|
</ResponseField>
|
|
|
|
</Expandable>
|
|
|
|
<Expandable title="Response">
|
|
<ResponseField name="SamplingResult[T]" type="dataclass">
|
|
- `.text`: The raw text response (or JSON for structured output)
|
|
- `.result`: The typed result—same as `.text` for plain text, or a validated Pydantic object for structured output
|
|
- `.history`: All messages exchanged during sampling
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
</Card>
|
|
|
|
<Card icon="code" title="ctx.sample_step()">
|
|
<ResponseField name="ctx.sample_step" type="async method">
|
|
Make a single LLM sampling call. Use this for fine-grained control over the sampling loop.
|
|
|
|
<Expandable title="Parameters">
|
|
<ResponseField name="messages" type="str | list[str | SamplingMessage]">
|
|
The prompt or conversation history.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="system_prompt" type="str | None" default="None">
|
|
Instructions that establish the LLM's role and behavior.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="temperature" type="float | None" default="None">
|
|
Controls randomness (0.0 = deterministic, 1.0 = creative).
|
|
</ResponseField>
|
|
|
|
<ResponseField name="max_tokens" type="int | None" default="512">
|
|
Maximum tokens to generate.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="tools" type="list[Callable] | None" default="None">
|
|
Functions the LLM can call during sampling.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="tool_choice" type="str | None" default="None">
|
|
Controls tool usage: `"auto"`, `"required"`, or `"none"`.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="execute_tools" type="bool" default="True">
|
|
If True, execute tool calls and append results to history. If False, return immediately with tool calls available for manual execution.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="mask_error_details" type="bool | None" default="None">
|
|
If True, mask detailed error messages from tool execution.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="tool_concurrency" type="int | None" default="None">
|
|
Controls parallel execution of tools. `None` (default) for sequential, `0` for unlimited parallel, or a positive integer for bounded concurrency.
|
|
</ResponseField>
|
|
</Expandable>
|
|
|
|
<Expandable title="Response">
|
|
<ResponseField name="SampleStep" type="dataclass">
|
|
- `.response`: The raw LLM response
|
|
- `.history`: Messages including input, assistant response, and tool results
|
|
- `.is_tool_use`: True if the LLM requested tool execution
|
|
- `.tool_calls`: List of tool calls (if any)
|
|
- `.text`: The text content (if any)
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
</Card>
|