Repository navigation
docs(crews): replace nonexistent tool in direct-code example - #9024
liunianxuxie wants to merge 1 commit into
Conversation
Preview approval requiredThis pull request comes from a fork, so Mintlify won't build a preview until someone with write access approves commit |
Strix Security Review✅ No open security findings. PR summary: Fixes the broken direct-code Crew example in the English, Korean, Brazilian Portuguese, and Arabic Crews documentation by importing the existing `FileReadTool` instead of the nonexistent `YourCustomTool`, and adds usage notes plus custom-tool links. Review summaryDocs-only change across the four localized Crews guides. The direct-code example's placeholder Review 1 on this PR · Reviewed by Strix |
Related issue
Related to #8944 — fixes the
YourCustomToolplaceholder import in the direct-code Crew example. This is a partial fix; the issue covers other tool references and should remain open.Summary
Copying the direct-code example from the Crews guide fails immediately because
crewai_toolsdoes not exportYourCustomTool. Use the existingFileReadToolinstead, explain that the task must identify the local data file, and link to the custom-tool guide for readers supplying their own implementation.Synchronize the change across English, Korean, Brazilian Portuguese, and Arabic. The Arabic direct-code section previously had no sample, so it now includes the corrected example. Only live
docs/edge/pages change.Verification
ImportErrorusing the real installed workspace packages on Windows / Python 3.12.13.YourCrewName().crew()constructs two agents and two tasks, and the first agent has aFileReadTool.git diff --checkpassed.Additional context
AI disclosure: Codex authored this change and ran the checks above. The required
llm-generatedlabel applies; if this contributor account cannot add it, please apply it.Existing PRs #8945, #8946, and #8633 cover different references from the issue; this change is limited to the direct-code Crew example.
Note
Low Risk
Documentation-only edits to example snippets and links; no runtime or application code changes.
Overview
Fixes the Direct Code Definition crew examples so copy-paste imports work:
YourCustomTool(not exported bycrewai_tools) is replaced withFileReadTool, and prose explains putting the data file path in the task description and points readers to the localized Create Custom Tools guide when they bring their own tool.English, Korean, and Brazilian Portuguese only update the existing sample and add that guidance. Arabic previously lacked a direct-code snippet; it now adds the same runnable example plus a
kickoffone-liner, aligned with the other locales. Changes are limited to livedocs/edge/Crew concept pages.Reviewed by Cursor Bugbot for commit 7c539cf. Bugbot is set up for automated code reviews on this repo. Configure here.