Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.upsonic.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Function tools are the simplest way to create custom tools. Decorate any Python function with @tool to make it available to your agents.

​
Example

from upsonic import Agent, Task
from upsonic.tools import tool

@tool
def sum_tool(a: float, b: float) -> float:
    """
    Add two numbers together.

    Args:
        a: First number
        b: Second number

    Returns:
        The sum of a and b
    """
    return a + b

# Create task with the tool
task = Task(
    description="Calculate 15 + 27",
    tools=[sum_tool]
)

# Create agent
agent = Agent(model="anthropic/claude-sonnet-4-5", name="Calculator Agent")

# Execute
result = agent.print_do(task)
print("Result:", result)

​
Async Functions

Async functions are fully supported for I/O-bound operations: 
from upsonic import Agent, Task
from upsonic.tools import tool
import httpx

@tool
async def fetch_weather(city: str) -> dict:
    """
    Fetch current weather for a city.
    
    Args:
        city: City name (e.g., "London", "New York")
    
    Returns:
        Weather data including temperature and conditions
    """
    async with httpx.AsyncClient() as client:
        response = await client.get(
            f"https://api.weather.com/v1/current?city={city}"
        )
        return response.json()

task = Task(
    description="What's the weather in Tokyo?",
    tools=[fetch_weather]
)

agent = Agent(model="anthropic/claude-sonnet-4-5")
result = await agent.do_async(task)  # Use do_async for async tools
print(result)

​
Sync and Async Versions

For libraries that need both sync and async support, create both versions: 
from upsonic.tools import tool

@tool
def search(query: str) -> list:
    """
    Search for items (sync version).
    
    Args:
        query: Search query string
    
    Returns:
        List of matching results
    """
    # Sync implementation
    return sync_search(query)

@tool
async def asearch(query: str) -> list:
    """
    Search for items (async version).
    
    Args:
        query: Search query string
    
    Returns:
        List of matching results
    """
    # Async implementation
    return await async_search(query)

​
Tool Configuration

Configure tool behavior using decorator parameters: 
from upsonic.tools import tool

@tool(
    requires_confirmation=True,  # Ask user before executing
    timeout=30,                  # 30 second timeout
    max_retries=3,               # Retry up to 3 times on failure
    cache_results=True           # Cache results
)
def expensive_operation(data: str) -> str:
    """Perform an expensive operation that should be cached."""
    return process(data)
See Tool Attributes for all configuration options.