init
This commit is contained in:
38
common/README.md.j2
Normal file
38
common/README.md.j2
Normal file
@@ -0,0 +1,38 @@
|
||||
# {{ node_name }}
|
||||
|
||||
파이썬 프로젝트 템플릿
|
||||
|
||||
---
|
||||
|
||||
## requirements.txt 작성 안내
|
||||
|
||||
배포 시 필요한 라이브러리 설치를 위해 **`requirements.txt`를 반드시 작성**해 주세요.
|
||||
|
||||
> ⚠️ 주의
|
||||
> 이 프로젝트는 **import 이름과 pip 설치 이름이 다른 라이브러리**가 포함될 수 있어
|
||||
> `pipreqs` 같은 자동 생성 도구 결과는 누락/오탐이 날 수 있습니다.
|
||||
> (예: `import fitz` → `PyMuPDF`)
|
||||
|
||||
### 권장 작성 방법
|
||||
1. 프로젝트가 정상 실행되는 가상환경(venv)에서 설치를 완료한 뒤
|
||||
2. 아래 명령으로 생성하세요.
|
||||
|
||||
```bash
|
||||
pip freeze > requirements.txt
|
||||
```
|
||||
## MCP Tool 작성 안내
|
||||
|
||||
MCP(Custom Tool)로 노드를 구현하는 경우, 툴 함수에 설명(docstring)을 반드시 작성해야 합니다.
|
||||
설명이 없으면 Dify/Tool Registry에서 노드가 정상적으로 노출되지 않거나 동작이 제한될 수 있습니다.
|
||||
|
||||
아래 형식을 지켜 주세요:
|
||||
```
|
||||
@mcp.tool()
|
||||
def 함수명(...):
|
||||
"""
|
||||
설명 작성 필수
|
||||
- 이 툴이 무엇을 하는지
|
||||
- 입력 파라미터 의미
|
||||
- 반환값 의미
|
||||
"""
|
||||
```
|
||||
Reference in New Issue
Block a user