crewAI-tools

crewAI-tools

None

Stars: 549

Visit
 screenshot

This repository provides a guide for setting up tools for crewAI agents to enhance functionality. It offers steps to equip agents with ready-to-use tools and create custom ones. Tools are expected to return strings for generating responses. Users can create tools by subclassing BaseTool or using the tool decorator. Contributions are welcome to enrich the toolset, and guidelines are provided for contributing. The development setup includes installing dependencies, activating virtual environment, setting up pre-commit hooks, running tests, static type checking, packaging, and local installation. The goal is to empower AI solutions through advanced tooling.

README:

Logo of crewAI, two people rowing on a boat

crewAI Tools

Welcome to crewAI Tools! This repository provides a comprehensive guide for setting up sophisticated tools for crewAI agents, empowering your AI solutions with bespoke tooling.

In the realm of CrewAI agents, tools are pivotal for enhancing functionality. This guide outlines the steps to equip your agents with an arsenal of ready-to-use tools and the methodology to craft your own.

Homepage | Documentation | Chat with Docs | Examples | Discord

Table of contents

Available Tools

crewAI Tools provides a wide range of pre-built tools, including:

  • File operations (FileWriterTool, FileReadTool)
  • Web scraping (ScrapeWebsiteTool, SeleniumScrapingTool)
  • Database interactions (PGSearchTool, MySQLSearchTool)
  • API integrations (SerperApiTool, EXASearchTool)
  • AI-powered tools (DallETool, VisionTool)
  • And many more!

For a complete list and detailed documentation of each tool, please refer to the individual tool README files in the repository.

Creating Your Tools

Tools are always expect to return strings, as they are meant to be used by the agents to generate responses.

There are three ways to create tools for crewAI agents:

Subclassing BaseTool

from crewai_tools import BaseTool

class MyCustomTool(BaseTool):
    name: str = "Name of my tool"
    description: str = "Clear description for what this tool is useful for, you agent will need this information to use it."

    def _run(self, argument: str) -> str:
        # Implementation goes here
        pass

Define a new class inheriting from BaseTool, specifying name, description, and the _run method for operational logic.

Utilizing the tool Decorator

For a simpler approach, create a Tool object directly with the required attributes and a functional logic.

from crewai_tools import tool
@tool("Name of my tool")
def my_tool(question: str) -> str:
    """Clear description for what this tool is useful for, you agent will need this information to use it."""
    # Function logic here

The tool decorator simplifies the process, transforming functions into tools with minimal overhead.

Contribution Guidelines

We welcome contributions! Here's how you can help:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Please ensure your code adheres to our coding standards and includes appropriate tests.

Development Setup

Installing Dependencies:

poetry install

Activating Virtual Environment:

poetry shell

Setting Up Pre-commit Hooks:

pre-commit install

Running Tests:

poetry run pytest

Static Type Checking:

poetry run pyright

Packaging:

poetry build

Local Installation:

pip install dist/*.tar.gz

Thank you for your interest in enhancing the capabilities of AI agents through advanced tooling. Your contributions make a significant impact.

Contact

For questions or support, please join our Discord community or open an issue in this repository.

For Tasks:

Click tags to check more tools for each tasks

For Jobs:

Alternative AI tools for crewAI-tools

Similar Open Source Tools

For similar tasks

For similar jobs