Skip to main content

visual-understanding

PyPI version Python versions License

多提供商视觉理解工具——MCP 服务器 + CLI 双模式。通过统一的接口调用 智谱 GLM-V、OpenAI GPT-4o、Anthropic Claude 或任何 OpenAI 兼容端点, 完成图片/视频/文档的多模态理解与目标定位。

  • 🚀 零安装uvx visual-understanding <command> 直接运行(已发布 PyPI
  • 🔌 双模式:MCP 服务器(serve)+ CLI(analyze/ground/list-providers
  • 🌐 多提供商:Zhipu / OpenAI / Anthropic / 任意 OpenAI 兼容端点,YAML 配置即插即用
  • 👁️ 核心能力:图片/视频/文档理解 + 目标定位(bounding box)

功能

能力 说明 支持的输入
多模态理解 (vision_analyze) 图片描述、OCR、视觉问答、文档解读、多图对比 图片 URL/路径/base64、视频 URL、文档 URL
目标定位 (vision_ground) 定位图像中的目标,输出归一化坐标,可选画框可视化 图片 URL/路径/base64
提供商查询 (list_providers) 查看已配置的提供商、模型、能力

快速开始

安装

方式一:uvx 运行(推荐,零安装) —— 已发布到 PyPI:

# 直接运行,无需安装(uv 自动缓存)
uvx visual-understanding list-providers

# 如果默认镜像(如清华 TUNA)尚未同步新包,可临时指定官方索引:
uvx --default-index https://pypi.org/simple visual-understanding list-providers

方式二:本地安装

cd mcp-servers/visual-understanding
pip install -e .

配置 API Key

至少设置一个提供商的 API Key(环境变量):

# 智谱(推荐——支持原生定位、视频、文件)
export ZHIPU_API_KEY="your_key"       # https://bigmodel.cn/usercenter/proj-mgmt/apikeys

# OpenAI
export OPENAI_API_KEY="your_key"      # https://platform.openai.com/api-keys

# Anthropic
export ANTHROPIC_API_KEY="your_key"   # https://console.anthropic.com/settings/keys

验证安装

visual-understanding list-providers

模式一:MCP 服务器

在 ZCode / Claude Desktop / Cursor 等 MCP 客户端中注册:

ZCode (~/.zcode/cli/config.json):

{
  "mcpServers": {
    "visual-understanding": {
      "command": "uvx",
      "args": ["visual-understanding", "serve"]
    }
  }
}

💡 如果默认 PyPI 镜像(清华/中科大等)尚未同步最新版本,加上官方索引参数:

{ "command": "uvx", "args": ["--default-index", "https://pypi.org/simple", "visual-understanding", "serve"] }

Claude Desktop (claude_desktop_config.json):

{
  "mcpServers": {
    "visual-understanding": {
      "command": "visual-understanding",
      "args": ["serve"]
    }
  }
}

注册后即可在对话中直接使用 vision_analyzevision_groundlist_providers 工具。

模式二:CLI / Skill

# 描述图片
visual-understanding analyze --images photo.jpg

# OCR 文字提取
visual-understanding analyze --images scan.png --prompt "Extract all text"

# 视觉问答
visual-understanding analyze --images photo.jpg --prompt "What color is the car?"

# 目标定位 + 画框
visual-understanding ground --image photo.jpg --prompt "all people" --visualize --save-path result.png

# 使用特定提供商/模型
visual-understanding analyze --images photo.jpg --provider openai --model gpt-4o

Agent 可通过 SKILL.md 中的指引调用 CLI。两种模式共享同一套核心逻辑。

提供商配置

内置默认

不创建配置文件时,内置三个提供商:

提供商 类型 模型 视频 文件 原生定位
zhipu OpenAI 兼容 GLM-V 系列
openai OpenAI 兼容 GPT-4o 系列
anthropic Anthropic Claude 系列

自定义配置

# 方式一:环境变量指定路径
export VISUAL_UNDERSTANDING_CONFIG=/path/to/config.yaml

# 方式二:默认路径
mkdir -p ~/.config/visual-understanding
cp config.example.yaml ~/.config/visual-understanding/config.yaml

配置文件格式见 config.example.yaml

添加自定义 OpenAI 兼容端点

任何 OpenAI 兼容的视觉模型服务都可以添加(vLLM、Ollama、Together、Azure 等):

providers:
  my-vlm:
    type: openai_compat
    api_key_env: MY_API_KEY              # 环境变量名
    base_url: http://localhost:8080/v1   # API 地址
    chat_models: [qwen-vl-max]
    default_chat_model: qwen-vl-max
    max_images: 10

然后:

export MY_API_KEY="your_key_or_dummy"
visual-understanding analyze --images photo.jpg --provider my-vlm

架构

                    ┌─────────────┐
                    │   config    │  YAML / env vars
                    └──────┬──────┘
                           │
              ┌────────────┼────────────┐
              ▼            ▼            ▼
        ┌──────────┐ ┌──────────┐ ┌──────────┐
        │ ops.py   │ │ ops.py   │ │ ops.py   │   ← 共享业务逻辑
        │ do_analyze│ │ do_ground│ │ do_list  │
        └────┬─────┘ └────┬─────┘ └──────────┘
             │             │
     ┌───────┴──────┐     │
     ▼              ▼     ▼
 ┌────────┐   ┌────────┐ ┌──────────┐
 │server.py│  │ cli.py │ │grounding │
 │ (MCP)  │   │ (CLI)  │ │  .py     │
 └───┬────┘   └────────┘ └──────────┘
     │
     ▼
 ┌──────────────────────────────────┐
 │         providers/               │
 │  ┌────────────┐ ┌────────────┐  │
 │  │openai_compat│ │ anthropic  │  │
 │  │(OpenAI/智谱)│ │ (Claude)   │  │
 │  └────────────┘ └────────────┘  │
 └──────────────────────────────────┘
  • config.py — Pydantic 配置模型 + YAML 加载(三级查找)
  • media.py — 输入解析(URL/路径/base64 归一化 + SSRF 防护)
  • providers/ — 提供商抽象 + 实现(OpenAI 兼容、Anthropic)
  • grounding.py — 定位 prompt 构造、坐标解析、Pillow 画框
  • ops.py — 共享操作逻辑(MCP 工具与 CLI 子命令的唯一调用入口)
  • server.py — FastMCP 服务器(3 个 MCP 工具)
  • cli.py — CLI 入口(4 个子命令:analyze / ground / list-providers / serve)

安全设计

  • API 密钥始终通过环境变量名引用(api_key_env),配置文件中不出现明文密钥
  • base_url 仅在配置中指定,工具参数不接受覆盖(防止密钥泄露到恶意端点)
  • URL 输入仅允许 http/https 公网地址,拒绝 localhost/内网 IP(防 SSRF)
  • .gitignore 排除 config.yaml.env

技术栈

  • MCP Python SDK (FastMCP v1.x)
  • httpx 异步 HTTP
  • pydantic 配置校验
  • pyyaml 配置文件
  • pillow grounding 画框可视化

License

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

visual_understanding-0.1.1.tar.gz (25.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

visual_understanding-0.1.1-py3-none-any.whl (28.2 kB view details)

Uploaded Python 3

File details

Details for the file visual_understanding-0.1.1.tar.gz.

File metadata

  • Download URL: visual_understanding-0.1.1.tar.gz
  • Upload date:
  • Size: 25.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.13

File hashes

Hashes for visual_understanding-0.1.1.tar.gz
Algorithm Hash digest
SHA256 7ea872fde2cff410942266734aed99053f04058f508ded46887e3d0af2695917
MD5 6b7b3d04726d928ce6edf69114159e24
BLAKE2b-256 54fa3d1cabd87e21e93e5c41a3865ae3edd8b35958f63b94b5d4f7a6dfb8e9db

See more details on using hashes here.

File details

Details for the file visual_understanding-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for visual_understanding-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b546f3e670321941af89b225e674ac2f9bca50ec64194ace9cf50e5fa9e8d0ce
MD5 c1d6751314a31a0e2d7c6b93adcbbb21
BLAKE2b-256 df52304d2b56dcdd0da065c858eb7e82238026ef563d7bdb01712562ad710a53

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page