MCP server for image reader using OpenAI vision API (gpt-4o-mini)
Project description
English
gucken-image-reader is an MCP (Model Context Protocol) server that leverages OpenAI’s Vision API to generate detailed descriptions of images. It exposes a single describe_image tool over stdio transport, allowing any MCP‐compatible host (e.g., Claude, custom apps) to request an image path and receive a textual description.
Installation
-
Install UV (if you haven’t already)
-
macOS / Linux
curl -LsSf https://astral.sh/uv/install.sh | sh
-
Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
-
Configuration
Create a .env file in the working directory (or export the variable directly):
OPENAI_API_KEY=your_openai_api_key_here
Integration with MCP host
Add an entry to your claude_desktop_config.json (or other MCP‐compatible host config):
{
"mcpServers": {
"image-recognition": {
"command": "uvx",
"args": [
"gucken-image-reader"
],
"env": {
"OPENAI_API_KEY": "your_openai_api_key_here"
}
}
}
}
- command:
uvx - args: the console script name
gucken-image-reader - env: ensure
OPENAI_API_KEYis set
Usage
-
Install and configure as above.
-
Start or restart your MCP host (e.g., Claude app); it will launch the server on stdio.
-
Send a JSON‐RPC or MCP request invoking the
describe_imagetool with a local image file path:{ "jsonrpc": "2.0", "method": "describe_image", "params": ["./path/to/image.jpg"], "id": 1 }
-
Receive a response with the model’s textual description.
License
MIT
한국어
gucken-image-reader은 OpenAI Vision API를 활용해 이미지에 대한 상세 설명을 생성하는 MCP(Model Context Protocol) 서버입니다. describe_image 툴을 stdio 방식으로 사용해, 이미지를 텍스트로 설명해줍니다
설치
-
UV 설치 (아직 설치하지 않으셨다면)
-
macOS / Linux
curl -LsSf https://astral.sh/uv/install.sh | sh
-
Windows (PowerShell)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
-
설정
다음 내용을 담은 .env 파일을 작업 디렉터리에 생성하거나, 환경 변수를 직접 설정하세요:
OPENAI_API_KEY=your_openai_api_key_here
MCP 호스트 통합
claude_desktop_config.json(또는 다른 MCP 호환 호스트 설정)에 다음 항목을 추가하세요:
{
"mcpServers": {
"image-reader": {
"command": "uvx",
"args": [
"gucken-image-reader"
],
"env": {
"OPENAI_API_KEY": "your_openai_api_key_here"
}
}
}
}
- command:
uvx - args: 콘솔 스크립트 이름
gucken-image-reader - env:
OPENAI_API_KEY설정 필수
사용 방법
-
위 설치·설정 과정을 완료합니다.
-
MCP 호스트(예: Claude 앱)를 실행하거나 재시작하면 서버가 stdio로 구동됩니다.
-
describe_image툴을 호출하며 로컬 이미지 파일 경로를 전송합니다:{ "jsonrpc": "2.0", "method": "describe_image", "params": ["./path/to/image.jpg"], "id": 1 }
-
모델이 생성한 이미지 묘사 텍스트를 응답으로 받습니다.
라이선스
MIT
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gucken_image_reader-1.1.1.tar.gz.
File metadata
- Download URL: gucken_image_reader-1.1.1.tar.gz
- Upload date:
- Size: 4.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
89d6a3985ee9cbd1b0f912e656206e09e84a26f97c7aabb5d7dd00e85f736bac
|
|
| MD5 |
45eeb3a7a0697e7c1bf9e674305722f6
|
|
| BLAKE2b-256 |
f11c95395815926852b5bce239117e30cb2506aa2498b1a9839f1a8a2ee7824e
|
File details
Details for the file gucken_image_reader-1.1.1-py3-none-any.whl.
File metadata
- Download URL: gucken_image_reader-1.1.1-py3-none-any.whl
- Upload date:
- Size: 5.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7311f3c001fbc9352089b7ddba64655fc154750abc9b803a7a61416133bdad4c
|
|
| MD5 |
7a9a3ba9250b9fd43df9d57f4f3826be
|
|
| BLAKE2b-256 |
5a8d5da8ad2ef6edbce706d61f60ad3959b606eef7aa822f78d61a4cad50fed2
|