🚀 빠른 시작
지엑스피1
📋 필수 조건
🔑 환경 변수
💻 NPX를 사용한 예시 사용
# Set your OpenAI API key
export OPENAI_API_KEY=sk-your-openai-api-key
# Optional: Set custom output directory
export GPT_IMAGE_OUTPUT_DIR=/home/username/Pictures/ai-generated-images
# Run the server with NPX
npx -y @cloudwerxlab/gpt-image-1-mcp
# Set your OpenAI API key
$env:OPENAI_API_KEY = "sk-your-openai-api-key"
# Optional: Set custom output directory
$env:GPT_IMAGE_OUTPUT_DIR = "C:\Users\username\Pictures\ai-generated-images"
# Run the server with NPX
npx -y @cloudwerxlab/gpt-image-1-mcp
:: Set your OpenAI API key
set OPENAI_API_KEY=sk-your-openai-api-key
:: Optional: Set custom output directory
set GPT_IMAGE_OUTPUT_DIR=C:\Users\username\Pictures\ai-generated-images
:: Run the server with NPX
npx -y @cloudwerxlab/gpt-image-1-mcp
🔌 MCP 클라이언트와의 통합
🛠️ MCP 클라이언트 설정
{
"mcpServers": {
"gpt-image-1": {
"command": "npx",
"args": [
"-y",
"@cloudwerxlab/gpt-image-1-mcp"
],
"env": {
"OPENAI_API_KEY": "PASTE YOUR OPEN-AI KEY HERE",
"GPT_IMAGE_OUTPUT_DIR": "OPTIONAL: PATH TO SAVE GENERATED IMAGES"
}
}
}
}
다양한 운영 체제에 대한 구성 예
{
"mcpServers": {
"gpt-image-1": {
"command": "npx",
"args": ["-y", "@cloudwerxlab/gpt-image-1-mcp"],
"env": {
"OPENAI_API_KEY": "sk-your-openai-api-key",
"GPT_IMAGE_OUTPUT_DIR": "C:\\Users\\username\\Pictures\\ai-generated-images"
}
}
}
}
{
"mcpServers": {
"gpt-image-1": {
"command": "npx",
"args": ["-y", "@cloudwerxlab/gpt-image-1-mcp"],
"env": {
"OPENAI_API_KEY": "sk-your-openai-api-key",
"GPT_IMAGE_OUTPUT_DIR": "/home/username/Pictures/ai-generated-images"
}
}
}
}
참고 : Windows 경로의 경우 JSON에서 백슬래시 문자를 이스케이프하려면 이중 백슬래시( \\
)를 사용하세요. Linux/macOS의 경우 슬래시( /
)를 사용하세요.
✨ 특징
💡 향상된 기능
🔄 작동 원리
📁 출력 디렉토리 동작
설치 및 사용
NPM 패키지
이 패키지는 npm에서 사용할 수 있습니다: @cloudwerxlab/gpt-image-1-mcp
전역적으로 설치할 수 있습니다:
npm install -g @cloudwerxlab/gpt-image-1-mcp
또는 빠른 시작 섹션에 표시된 대로 npx로 직접 실행합니다.
도구: create_image
텍스트 프롬프트를 기반으로 새로운 이미지를 생성합니다.
매개변수
매개변수 | 유형 | 필수의 | 설명 |
---|
prompt | 끈 | 예 | 생성할 이미지의 텍스트 설명(최대 32,000자) |
size | 끈 | 아니요 | 이미지 크기: "1024x1024"(기본값), "1536x1024" 또는 "1024x1536" |
quality | 끈 | 아니요 | 이미지 품질: "높음"(기본값), "중간" 또는 "낮음" |
n | 정수 | 아니요 | 생성할 이미지 수(1-10, 기본값: 1) |
background | 끈 | 아니요 | 배경 스타일: "투명", "불투명" 또는 "자동"(기본값) |
output_format | 끈 | 아니요 | 출력 형식: "png"(기본값), "jpeg" 또는 "webp" |
output_compression | 정수 | 아니요 | 압축 수준(0-100, 기본값: 0) |
user | 끈 | 아니요 | OpenAI 사용 추적을 위한 사용자 식별자 |
moderation | 끈 | 아니요 | 조정 수준: "낮음" 또는 "자동"(기본값) |
예
<use_mcp_tool>
<server_name>gpt-image-1</server_name>
<tool_name>create_image</tool_name>
<arguments>
{
"prompt": "A futuristic city skyline at sunset, digital art",
"size": "1024x1024",
"quality": "high",
"n": 1,
"background": "auto"
}
</arguments>
</use_mcp_tool>
응답
도구는 다음을 반환합니다.
- 생성된 이미지에 대한 세부 정보가 포함된 서식이 지정된 텍스트 메시지
- 이미지는 base64로 인코딩된 데이터입니다.
- 토큰 사용 및 파일 경로를 포함한 메타데이터
도구: create_image_edit
텍스트 프롬프트와 선택적 마스크를 기반으로 기존 이미지를 편집합니다.
매개변수
매개변수 | 유형 | 필수의 | 설명 |
---|
image | 문자열, 객체 또는 배열 | 예 | 편집할 이미지(base64 문자열 또는 파일 경로 객체) |
prompt | 끈 | 예 | 원하는 편집 내용에 대한 텍스트 설명(최대 32,000자) |
mask | 문자열 또는 객체 | 아니요 | 편집할 영역을 정의하는 마스크(base64 문자열 또는 파일 경로 객체) |
size | 끈 | 아니요 | 이미지 크기: "1024x1024"(기본값), "1536x1024" 또는 "1024x1536" |
quality | 끈 | 아니요 | 이미지 품질: "높음"(기본값), "중간" 또는 "낮음" |
n | 정수 | 아니요 | 생성할 이미지 수(1-10, 기본값: 1) |
background | 끈 | 아니요 | 배경 스타일: "투명", "불투명" 또는 "자동"(기본값) |
user | 끈 | 아니요 | OpenAI 사용 추적을 위한 사용자 식별자 |
Base64로 인코딩된 이미지의 예
<use_mcp_tool>
<server_name>gpt-image-1</server_name>
<tool_name>create_image_edit</tool_name>
<arguments>
{
"image": "BASE64_ENCODED_IMAGE_STRING",
"prompt": "Add a small robot in the corner",
"mask": "BASE64_ENCODED_MASK_STRING",
"quality": "high"
}
</arguments>
</use_mcp_tool>
파일 경로가 있는 예
<use_mcp_tool>
<server_name>gpt-image-1</server_name>
<tool_name>create_image_edit</tool_name>
<arguments>
{
"image": {
"filePath": "C:/path/to/your/image.png"
},
"prompt": "Add a small robot in the corner",
"mask": {
"filePath": "C:/path/to/your/mask.png"
},
"quality": "high"
}
</arguments>
</use_mcp_tool>
응답
도구는 다음을 반환합니다.
- 편집된 이미지에 대한 세부 정보가 포함된 서식이 지정된 텍스트 메시지
- 편집된 이미지는 base64로 인코딩된 데이터입니다.
- 토큰 사용 및 파일 경로를 포함한 메타데이터
🔧 문제 해결
🚨 일반적인 문제
🔍 오류 처리 및 보고
MCP 서버에는 오류 발생 시 자세한 정보를 제공하는 포괄적인 오류 처리 기능이 포함되어 있습니다. 오류 발생 시:
- 오류 형식 : 모든 오류는 다음과 같이 반환됩니다.
- 무엇이 잘못되었는지 설명하는 명확한 오류 메시지
- 특정 오류 코드 또는 유형
- 오류에 대한 추가 컨텍스트가 있는 경우
- AI 어시스턴트 동작 : 이 MCP 서버를 AI 어시스턴트와 함께 사용할 때:
- AI는 항상 문제 해결에 도움이 되도록 전체 오류 메시지를 보고합니다.
- AI는 오류의 원인을 일반 언어로 설명합니다.
- AI는 문제를 해결하기 위한 구체적인 단계를 제안합니다.
📄 라이센스
🙏 감사의 말