article
README
🚀 MCP 开源项目
MCP 是一个强大的开源图像分析工具项目。它允许用户通过简单的 API 调用对图像进行详细分析,支持多种输入格式和高级自定义选项,为图像分析提供了极大便利。
🚀 快速开始
MCP 项目旨在提供便捷的图像分析服务,你可根据以下指引开展图像分析工作。
✨ 主要特性
- 提供简单的 API 调用,方便用户进行图像详细分析。
- 支持多种输入格式,如 Base64 编码字符串、URL 链接和文件路径。
- 具备高级自定义选项,如基于 Base64 的输入和自定义系统提示。
📦 安装指南
安装依赖
pip install mcp-openvision
💻 使用示例
基础用法
# 分析来自 URL 的图像
result = await image_analysis(
image="https://example.com/image.jpg",
query="描述此图像"
)
# 从本地文件分析图像
result = await image_analysis(
image="path/to/local/image.jpg",
query="识别街道场景中的所有交通标志并解释其对驾驶员的意义"
)
高级用法
基于 Base64 的输入
# 使用 Base64 编码的图像数据
result = await image_analysis(
image="SGVsbG8gV29ybGQ=...", # Base64 数据
query="分析此产品包装设计,强调可以改进的部分以提高可见性和品牌识别度"
)
自定义系统提示
# 添加自定义系统提示以进行专业分析
result = await image_analysis(
image="path/to/local/image.jpg",
query="分析这幅画的构成和艺术技巧,重点介绍它们如何产生情感影响",
system_prompt="你是一位专业的艺术史学家,拥有对绘画技术的深厚知识。专注于形式分析,关注构图、颜色、笔触和风格元素。"
)
输入类型
image_analysis 工具支持以下图像输入格式:
- Base64 编码字符串
- URL 链接 - 必须以
http://或https://开头 - 文件路径:
- 绝对路径:从根目录开始的完整路径(Unix)或驱动器号(Windows)
- 相对路径:相对于当前工作目录的路径
- 带项目根的相对路径:使用
project_root参数指定一个基目录
使用相对路径
当使用相对文件路径时,有两种选择:
- 路径必须相对于运行服务器的当前工作目录。
- 可以指定
project_root参数:
# 示例:使用相对路径和 project_root 参数
result = await image_analysis(
image="examples/image.jpg",
project_root="/path/to/your/project",
query="此图像中包含哪些内容?"
)
这对于在不可预测的工作目录的应用程序或希望使用相对于特定目录的文件引用非常有用。
🔧 技术细节
开发环境
初始化开发环境
# 克隆仓库
git clone https://github.com/modelcontextprotocol/mcp-openvision.git
cd mcp-openvision
# 安装开发依赖项
pip install -e ".[dev]"
代码格式化
该项目使用 Black 进行代码自动格式化。格式化在 GitHub Actions 中强制执行:
- 所有提交到仓库的代码都会自动用 Black 格式化。
- 来自协作仓库的拉取请求(PR)分支会直接将格式化后的代码提交到 PR 分支。
- 来自外部仓库的 PR 会保留原有格式。
测试方法
# 运行测试套件
python -m pytest tests/
发布流程
打包项目
# 创建源发行版
python setup.py sdist bdist_wheel
# 安装并测试发布工具
pip install twine
twine check dist/*
# 发布到 PyPI
twine upload --repository-url https://upload.pypi.org/username/ dist/*
📄 许可证
赞助
项目接受来自个人和企业的赞助,以支持持续开发和维护。
许可证详情
MCP 开源项目遵循 MIT 许可证。点击 此处 查看完整许可证内容。
给开发者的一句话
如果你在使用 MCP 时遇到任何问题或有改进建议,请随时通过 GitHub Issues 提交问题或提出反馈!
扫码联系在线客服