Skip to main content

VikingDB Multi-modal Search MCP Server using FastMCP

Project description

VikingDB Multi-modal Search MCP Server

这是一个使用 Python FastMCP 框架开发的 MCP Server,用于在火山引擎 VikingDB 向量数据库中进行多模态检索。

功能介绍

提供 search_multi_modal 工具,支持:

  • 文本搜索
  • 图片搜索 (TOS 或 HTTP 链接)
  • 视频搜索 (TOS 或 HTTP 链接)
  • 多模态组合搜索

安装依赖

pip install -r requirements.txt

配置

复制 .env.example.env 并填入您的火山引擎凭证:

cp .env.example .env

并在 .env 中设置以下变量:

  • VOLC_AK: 火山引擎 Access Key
  • VOLC_SK: 火山引擎 Secret Key
  • VIKINGDB_HOST: VikingDB 域名 (默认: api-vikingdb.vikingdb.cn-beijing.volces.com)
  • VIKINGDB_REGION: 区域 (默认: cn-beijing)

运行

python server.py

MCP 工具说明

search_multi_modal

参数:

  • collection_name (str): 集合名称
  • index_name (str): 索引名称
  • text (str, 可选): 检索文本
  • image (str, 可选): 图片链接
  • video_url (str, 可选): 视频链接
  • video_fps (float, 可选): 视频采样频率
  • need_instruction (bool): 是否启用 Instruction (默认为 True)
  • output_fields (list, 可选): 返回字段列表
  • limit (int): 返回结果数量 (默认 10)

发布到 PyPI

如果您希望将此项目发布到 PyPI,可以使用我们提供的自动化脚本:

  1. 安装必要工具(仅需一次):

    pip install build twine
    
  2. 运行发布脚本

    ./publish.sh
    

    该脚本会自动执行以下步骤:

    • 检查当前版本并建议/手动确认新版本。
    • 自动更新 pyproject.toml
    • 清理旧的构建文件。
    • 构建新的分发包。
    • 调用 twine 上传至 PyPI。

    注意:在上传时,您需要输入 PyPI 的 API Token。建议提前在 ~/.pypirc 中配置好 Token 以实现完全自动化。

本地开发安装

可以使用开发模式安装,以便直接运行命令:

pip install -e .
vinehoo-search

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

vinehoo_vector_products_search_mcp-0.1.6.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

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

File details

Details for the file vinehoo_vector_products_search_mcp-0.1.6.tar.gz.

File metadata

File hashes

Hashes for vinehoo_vector_products_search_mcp-0.1.6.tar.gz
Algorithm Hash digest
SHA256 4971dac82367ef62e35220e56e4affbb050c076599c86c3ac7b2bf6fa831cf35
MD5 2889ae5829dde284ad57f8f704b45992
BLAKE2b-256 02a1fa0f0525cafe48d9466fbeb4f369c60a94b6d6f2b3eb574e19ad10d0a387

See more details on using hashes here.

File details

Details for the file vinehoo_vector_products_search_mcp-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for vinehoo_vector_products_search_mcp-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3820f3934bf4e49650172be229ffd9dd502471ef7f59051013f3a271bd6d78d3
MD5 3716b0d7746022774a41a92a0a0abebb
BLAKE2b-256 c789d4141d0500e0e7903a47a77c2620d306e3578d53cf34c28bb8b86cb01e88

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