Skip to content

docs(crews): replace nonexistent tool in direct-code example - #9024

Open
liunianxuxie wants to merge 1 commit into
crewAIInc:mainfrom
liunianxuxie:docs/fix-crew-example-tool-import
Open

liunianxuxie wants to merge 1 commit into
crewAIInc:mainfrom
liunianxuxie:docs/fix-crew-example-tool-import

Conversation

@liunianxuxie

@liunianxuxie liunianxuxie commented Nov 4, 2026 •

Copy link
Copy Markdown

Related issue

Related to #8944 — fixes the YourCustomTool placeholder 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_tools does not export YourCustomTool. Use the existing FileReadTool instead, 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

  • Reproduced the original example's ImportError using the real installed workspace packages on Windows / Python 3.12.13.
  • Extracted and executed each of the four updated MDX code blocks: imports succeed, YourCrewName().crew() constructs two agents and two tasks, and the first agent has a FileReadTool.
  • Blocked socket connections during the smoke check; no kickoff or model calls were executed.
  • Verified the four localized custom-tool links resolve to existing pages.
  • git diff --check passed.
  • Docs-only change; full runtime tests and Mintlify rendering were not run.

Additional context

AI disclosure: Codex authored this change and ran the checks above. The required llm-generated label 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 by crewai_tools) is replaced with FileReadTool, 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 kickoff one-liner, aligned with the other locales. Changes are limited to live docs/edge/ Crew concept pages.

Reviewed by Cursor Bugbot for commit 7c539cf. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Nov 4, 2026

Copy link
Copy Markdown

Preview approval required

This pull request comes from a fork, so Mintlify won't build a preview until someone with write access approves commit 7c539cf.

Approve preview

@strix-security

strix-security Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

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 summary

Docs-only change across the four localized Crews guides. The direct-code example's placeholder YourCustomTool import is replaced with the real FileReadTool, with accompanying prose explaining the file path requirement and linking to the custom-tool guide. The additions are plain prose and fenced Python sample blocks — no JSX, script, dynamic HTML, or untrusted interpolation was introduced, all links are relative in-site paths, and no security-relevant runtime code or control was modified. No vulnerabilities found.

Review 1 on this PR · 7c539cf · requested Nov 4 03:11 UTC when the PR was opened


Reviewed by Strix
Re-run review · Configure security review settings

This branch has not been deployed

No deployments
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.

1 participant