andre/crewAI
1
0
Fork 0
mirror of https://github.com/crewAIInc/crewAI.git synced 2026-01-11 00:58:30 +00:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

Merge pull request #96 from crewAIInc/docs_update

Browse Source 
Updated GitHub repo links and readme.md
This commit is contained in:
Rip&Tear
2024-08-31 12:32:52 +08:00
committed by GitHub
parent 91c394ffce 5957573625
commit d19bba72b0
1 changed files with 28 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@@ -5,7 +5,7 @@
<div align="left"> <div align="left">
# **crewAI Tools** # **crewAI Tools**
This document provides a comprehensive guide for setting up sophisticated tools for [crewAI](https://github.com/joaomdmoura/crewai) agents, facilitating the creation of bespoke tooling to empower your AI solutions. Welcome to crewAI Tools! This repository provides a comprehensive guide for setting up sophisticated tools for [crewAI](https://github.com/crewAIInc/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. 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.
@@ -13,7 +13,7 @@ In the realm of CrewAI agents, tools are pivotal for enhancing functionality. Th
<h3> <h3>
[Homepage](https://www.crewai.io/) | [Documentation](https://docs.crewai.com/) | [Chat with Docs](https://chatg.pt/DWjSBZn) | [Examples](https://github.com/joaomdmoura/crewai-examples) | [Discord](https://discord.com/invite/X4JWnZnxPb) [Homepage](https://www.crewai.io/) | [Documentation](https://docs.crewai.com/) | [Chat with Docs](https://chatg.pt/DWjSBZn) | [Examples](https://github.com/crewAIInc/crewAI-examples) | [Discord](https://discord.com/invite/X4JWnZnxPb)
</h3> </h3>
@@ -27,6 +27,19 @@ In the realm of CrewAI agents, tools are pivotal for enhancing functionality. Th
- [Contribution Guidelines](#contribution-guidelines) - [Contribution Guidelines](#contribution-guidelines)
- [Development Setup](#development-setup) - [Development Setup](#development-setup)
## 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 ## Creating Your Tools
Tools are always expect to return strings, as they are meant to be used by the agents to generate responses. Tools are always expect to return strings, as they are meant to be used by the agents to generate responses.
@@ -68,14 +81,15 @@ The `tool` decorator simplifies the process, transforming functions into tools w
## Contribution Guidelines ## Contribution Guidelines
We eagerly welcome contributions to enrich this toolset. To contribute: We welcome contributions! Here's how you can help:
1. **Fork the Repository:** Begin with forking the repository to your GitHub account. 1. Fork the repository
2. **Feature Branch:** Create a new branch in your fork for the feature or improvement. 2. Create a feature branch (`git checkout -b feature/AmazingFeature`)
3. **Implement Your Feature:** Add your contribution to the new branch. 3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. **Pull Request:** Submit a pull request from your feature branch to the main repository. 4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
Your contributions are greatly appreciated and will help enhance this project. Please ensure your code adheres to our coding standards and includes appropriate tests.
## **Development Setup** ## **Development Setup**
@@ -122,3 +136,9 @@ 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. 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](https://discord.com/invite/X4JWnZnxPb) or open an issue in this repository.