mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-09 08:08:32 +00:00
113 lines
2.8 KiB
Markdown
113 lines
2.8 KiB
Markdown
<div align="center">
|
|
|
|
|
|
|
|
<div align="left">
|
|
|
|
# CrewAI Tools
|
|
|
|
Empower your CrewAI agents with powerful, customizable tools to elevate their capabilities and tackle sophisticated, real-world tasks.
|
|
|
|
CrewAI Tools provide the essential functionality to extend your agents, helping you rapidly enhance your automations with reliable, ready-to-use tools or custom-built solutions tailored precisely to your needs.
|
|
|
|
---
|
|
|
|
## Quick Links
|
|
|
|
[Homepage](https://www.crewai.com/) | [Documentation](https://docs.crewai.com/) | [Examples](https://github.com/crewAIInc/crewAI-examples) | [Community](https://community.crewai.com/)
|
|
|
|
---
|
|
|
|
## Available Tools
|
|
|
|
CrewAI provides an extensive collection of powerful tools ready to enhance your agents:
|
|
|
|
- **File Management**: `FileReadTool`, `FileWriteTool`
|
|
- **Web Scraping**: `ScrapeWebsiteTool`, `SeleniumScrapingTool`
|
|
- **Database Integrations**: `PGSearchTool`, `MySQLSearchTool`
|
|
- **API Integrations**: `SerperApiTool`, `EXASearchTool`
|
|
- **AI-powered Tools**: `DallETool`, `VisionTool`
|
|
|
|
And many more robust tools to simplify your agent integrations.
|
|
|
|
---
|
|
|
|
## Creating Custom Tools
|
|
|
|
CrewAI offers two straightforward approaches to creating custom tools:
|
|
|
|
### Subclassing `BaseTool`
|
|
|
|
Define your tool by subclassing:
|
|
|
|
```python
|
|
from crewai.tools import BaseTool
|
|
|
|
class MyCustomTool(BaseTool):
|
|
name: str = "Tool Name"
|
|
description: str = "Detailed description here."
|
|
|
|
def _run(self, *args, **kwargs):
|
|
# Your tool logic here
|
|
```
|
|
|
|
### Using the `tool` Decorator
|
|
|
|
Quickly create lightweight tools using decorators:
|
|
|
|
```python
|
|
from crewai import tool
|
|
|
|
@tool("Tool Name")
|
|
def my_custom_function(input):
|
|
# Tool logic here
|
|
return output
|
|
```
|
|
|
|
---
|
|
|
|
## Why Use CrewAI Tools?
|
|
|
|
- **Simplicity & Flexibility**: Easy-to-use yet powerful enough for complex workflows.
|
|
- **Rapid Integration**: Seamlessly incorporate external services, APIs, and databases.
|
|
- **Enterprise Ready**: Built for stability, performance, and consistent results.
|
|
|
|
---
|
|
|
|
## Contribution Guidelines
|
|
|
|
We welcome contributions from the community!
|
|
|
|
1. Fork and clone the repository.
|
|
2. Create a new branch (`git checkout -b feature/my-feature`).
|
|
3. Commit your changes (`git commit -m 'Add my feature'`).
|
|
4. Push your branch (`git push origin feature/my-feature`).
|
|
5. Open a pull request.
|
|
|
|
---
|
|
|
|
## Developer Quickstart
|
|
|
|
```shell
|
|
pip install crewai[tools]
|
|
```
|
|
|
|
### Development Setup
|
|
|
|
- Install dependencies: `uv sync`
|
|
- Run tests: `uv run pytest`
|
|
- Run static type checking: `uv run pyright`
|
|
- Set up pre-commit hooks: `pre-commit install`
|
|
|
|
---
|
|
|
|
## Support and Community
|
|
|
|
Join our rapidly growing community and receive real-time support:
|
|
|
|
- [Discourse](https://community.crewai.com/)
|
|
- [Open an Issue](https://github.com/crewAIInc/crewAI/issues)
|
|
|
|
Build smarter, faster, and more powerful AI solutions—powered by CrewAI Tools.
|
|
|