Skip to content

Docs: clarify community tool sharing#6460

Open
kmishra1204 wants to merge 1 commit into
crewAIInc:mainfrom
kmishra1204:docs/community-tool-sharing
Open

Docs: clarify community tool sharing#6460
kmishra1204 wants to merge 1 commit into
crewAIInc:mainfrom
kmishra1204:docs/community-tool-sharing

Conversation

@kmishra1204

@kmishra1204 kmishra1204 commented Jul 4, 2026

Copy link
Copy Markdown

Summary

  • add guidance for sharing community-maintained CrewAI tool packages after publishing to PyPI
  • clarify that the package README should remain the primary source of truth
  • list the information maintainers can ask for when evaluating a docs mention

This addresses the documentation path question without adding a third-party tool catalog or documenting any one external package directly.

Closes #6458.

Validation

  • git diff --check -- docs/edge/en/guides/tools/publish-custom-tools.mdx

AI assistance / label note

  • AI assistance was used while drafting and reviewing this documentation-only change.
  • CrewAI's contributing guide says AI-assisted PRs require the llm-generated label. I attempted to apply it, but this account does not have label permission on the upstream repository.

@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This PR adds a new "Sharing Community Tools" documentation subsection to the custom tools publishing guide. It provides guidance on maintaining the package README as the primary reference and specifies details needed when requesting a CrewAI docs mention for community tools.

Changes

Documentation Update

Layer / File(s) Summary
Sharing Community Tools guidance
docs/edge/en/guides/tools/publish-custom-tools.mdx
Adds a new subsection instructing authors to keep the README as the primary reference and to include links, supported versions, installation steps, minimal usage snippet, required environment variables, and maintenance/security notes when requesting a docs mention, plus guidance on avoiding duplication and following the standard contribution process for official inclusion.

Compact Diff Overview: +18/-0 lines, low review effort.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly summarizes the documentation change about community tool sharing.
Description check ✅ Passed The description accurately matches the doc update and its purpose.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@kmishra1204

Copy link
Copy Markdown
Author

I checked .github/CONTRIBUTING.md and saw the required llm-generated label for AI-assisted contributions. I tried to apply llm-generated, but GitHub returned a permissions error for AddLabelsToLabelable. I added a note to the PR body as well; maintainers, please apply the label if needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: preferred way to list an externally-published community tool package (crewai-perseus-vault)?

1 participant