Skip to main content

Tools for AI agents

Project description


ToolFuse

A common protocol for AI agent tools
Explore the docs »

View Demo · Report Bug · Request Feature


ToolFuse provides a common protocol for AI agent tools, use them with your favorite agent framework or model.

Installation

pip install toolfuse

Usage

A simple weather logger tool

from toolfuse import Tool, action, observation
from selenium import webdriver


class WeatherLogger(Tool):
  """A simple weather logger."""

    @action
    def log(self, message: str) -> None:
        """Logs a message to the log file."""

        with open("weather.txt", "a") as file:
            file.write("***\n" + message + "\n")

    @observation
    def weather(self, location: str) -> str:
        """Checks the current weather from the internet using wttr.in."""

        weather_api_url = f"http://wttr.in/{location}?format=%l:+%C+%t"
        response = requests.get(weather_api_url)
        response.raise_for_status()
        return response.text

The functions to be made available to the agent as

  • @action if they mutate the environment
  • @observation if they are read only.

Use the tool in a prompt

weather_logger = WeatherLogger()

msg = f"Please select the appropriate action from {weather_logger.json_schema()}"

Create a tool from an existing class

from toolfuse import tool

class Foo:
  def echo(self, txt: str) -> str:
    return txt


foo_tool = tool(Foo())

Create a tool from an existing function

from toolfuse import tool

def echo(txt: str) -> str:
  return txt

echo_tool = tool(echo)

Function Calling

Use a tool with OpenAI function calling

from openai import OpenAI

client = OpenAI()

weatherlogger = WeatherLogger()
schemas = weatherlogger.json_schema()

messages = []
messages.append({"role": "system", "content": "Don't make assumptions about what values to plug into functions. Ask for clarification if a user request is ambiguous."})
messages.append({"role": "user", "content": "What is the weather in Paris?"})

headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer " + openai.api_key,
}
json_data = {"model": model, "messages": messages, "tools": schemas}
response = requests.post(
    "https://api.openai.com/v1/chat/completions",
    headers=headers,
    json=json_data,
)

assistant_message = response.json()["choices"][0]["message"]
messages.append(assistant_message)
assistant_message
{
  "role": "assistant",
  "tool_calls": [
    {
      "id": "call_RYXaDjxpUCfWmpXU7BZEYVqS",
      "type": "function",
      "function": {
        "name": "weather",
        "arguments": "{\n  \"location\": \"Paris\"}"
      }
    }
  ]
}

Then to use this action

for tool in assistant_message["tool_calls"]:
    action = weatherlogger.find_action(tool["function"]["name"])
    args = json.loads(tool["function"]["arguments"])
    resp = weatherlogger.use(action, **args)

MultiTool

Combine tools with MultiTool

from toolfuse import Tool, MultiTool

class Chat(Tool):
  """A simple chat tool"""

    @action
    def send_message(self, message: str) -> None:
        """Logs a message to the log file."""

        with open("chat.txt", "a") as file:
            file.write("***\n" + message + "\n")


multitool = MultiTool(tools=[WeatherLogger(), Chat()])
multitool.json_schema()

Merge one tools actions into another

chat_tool = Chat()
chat_tool.merge(WeatherLogger())

Add an action to a tool

def echo(txt: str) -> str:
  return txt

weather_tool = WeatherLogger()
weather_tool.add_action(echo)

Available Tools

:computer: AgentDesk provides AI agents with a full GUI desktop locally or in the cloud.

:wrench: AgentUtils provides some basic utilities for agentic tool use

Roadmap

  • Integrate with langchain
  • Integrate with babyagi
  • Integrate with autogen
  • Integrate with llamaindex

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

toolfuse-0.1.22.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

toolfuse-0.1.22-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file toolfuse-0.1.22.tar.gz.

File metadata

  • Download URL: toolfuse-0.1.22.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.1 Darwin/22.6.0

File hashes

Hashes for toolfuse-0.1.22.tar.gz
Algorithm Hash digest
SHA256 47a6cb3f777b9bd4ee3957477a82a11c76ca08956a747973ed532658b4bb6d83
MD5 157fb1e62f2f4a9d871eae21dcd2be2b
BLAKE2b-256 0cabc116c55efa78fa7fef0af55b581dc06c26802c79a855aa22313c4b78beb2

See more details on using hashes here.

File details

Details for the file toolfuse-0.1.22-py3-none-any.whl.

File metadata

  • Download URL: toolfuse-0.1.22-py3-none-any.whl
  • Upload date:
  • Size: 11.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.1 Darwin/22.6.0

File hashes

Hashes for toolfuse-0.1.22-py3-none-any.whl
Algorithm Hash digest
SHA256 d481148f311ee7088fd1f4134dbda87f3770d328617f419e6534687cfa159e9d
MD5 f9581e92732505434c70d430d3434705
BLAKE2b-256 b8d4b70cd92534faaf4ac659ff87a7bc82527f0b9635dca551c6621e373f7644

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page