Skip to content

Docs: clarify community tool sharing #6460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kmishra1204 wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −0
Open

Docs: clarify community tool sharing #6460

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/edge/en/guides/tools/publish-custom-tools.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,3 +303,21 @@ agent = Agent(
# ...
)
```

### Sharing Community Tools

Keep the package README as the primary source of truth for installation, setup, security notes, and usage examples.
This lets users evaluate the package from PyPI or its source repository without needing a CrewAI docs release.

If you want to propose a CrewAI docs mention for a community-maintained tool, open a docs issue or PR with:

- Package name and PyPI link.
- Source repository link and license.
- Supported CrewAI versions.
- Installation command.
- Minimal usage snippet that imports the package and attaches the tool to an agent.
- Required environment variables or external services.
- Maintenance status, known limitations, and any data handling or security considerations.

Prefer a concise pointer to the external package over duplicating full package documentation in the CrewAI docs.
If the tool should ship as part of the official `crewai_tools` package instead, follow the repository's normal contribution process.