개요
CrewAI의 도구 시스템은 확장 가능하도록 설계되었습니다. 다른 사용자에게도 유용한 도구를 만들었다면, 독립적인 Python 라이브러리로 패키징하여 PyPI에 게시하고 모든 CrewAI 사용자가 사용할 수 있도록 할 수 있습니다. CrewAI 저장소에 PR을 보낼 필요가 없습니다. 이 가이드에서는 도구 계약 구현, 패키지 구조화, PyPI 게시까지의 전체 과정을 안내합니다.프로젝트 내에서만 사용할 커스텀 도구가 필요하다면 커스텀 도구 생성 가이드를 참고하세요.
도구 계약
모든 CrewAI 도구는 다음 두 가지 인터페이스 중 하나를 충족해야 합니다:옵션 1: BaseTool 서브클래싱
crewai.tools.BaseTool을 서브클래싱하고 _run 메서드를 구현합니다. name, description, 그리고 선택적으로 입력 검증을 위한 args_schema를 정의합니다.
옵션 2: @tool 데코레이터 사용
간단한 도구의 경우, @tool 데코레이터로 함수를 CrewAI 도구로 변환할 수 있습니다. 함수에는 반드시 독스트링(도구 설명으로 사용됨)과 타입 어노테이션이 있어야 합니다.
핵심 요구사항
어떤 방식을 사용하든, 도구는 다음을 충족해야 합니다:name— 짧고 설명적인 식별자.description— 에이전트에게 도구를 언제, 어떻게 사용할지 알려줍니다. 에이전트가 도구를 얼마나 잘 활용하는지에 직접적으로 영향을 미치므로 명확하고 구체적으로 작성하세요._run(BaseTool) 또는 함수 본문 (@tool) 구현 — 동기 실행 로직.- 모든 매개변수와 반환 값에 타입 어노테이션 사용.
- 문자열 결과를 반환 (또는 의미 있게 문자열로 변환 가능한 값).
선택사항: 비동기 지원
I/O 바운드 작업을 수행하는 도구의 경우 비동기 실행을 위해_arun을 구현합니다:
선택사항: args_schema를 통한 입력 검증
Pydantic 모델을 args_schema로 정의하면 자동 입력 검증과 명확한 에러 메시지를 받을 수 있습니다. 제공하지 않으면 CrewAI가 _run 메서드의 시그니처에서 추론합니다.
선택사항: 환경 변수
도구에 API 키나 기타 설정이 필요한 경우,env_vars로 선언하여 사용자가 무엇을 설정해야 하는지 알 수 있도록 합니다:
패키지 구조
프로젝트를 표준 Python 패키지로 구성합니다. 권장 레이아웃:pyproject.toml
crewai를 의존성으로 선언합니다.
__init__.py
사용자가 직접 import할 수 있도록 도구 클래스를 re-export합니다:
명명 규칙
- 패키지 이름:
crewai-접두사를 사용합니다 (예:crewai-geolocate). PyPI에서 검색할 때 도구를 쉽게 찾을 수 있습니다. - 모듈 이름: 밑줄을 사용합니다 (예:
crewai_geolocate). - 도구 클래스 이름:
Tool로 끝나는 PascalCase를 사용합니다 (예:GeolocateTool).
