groundlight-mcp-server

groundlight-mcp-server，由 <img src=resources/images/gl_logo.png height=25> 提供

概述

一个用于与 Groundlight 交互的模型上下文协议（MCP）服务。此服务提供用于创建、列出和自定义 Detector，提交和列出 ImageQuery，创建、列出和删除 Alert，以及查看 Detector 评估指标的工具。

随着我们持续开发和改进此服务，其功能和可用工具可能会发生变化并扩展。

工具

Groundlight MCP 服务提供以下工具：

1. create_detector

   • 描述：根据指定的配置创建 Detector。支持三种模式：

     1. 二元：针对图像中的自然语言查询回答“是”或“否”。
     2. 多类别：根据自然语言查询，将图像分类到预定义类别中。
     3. 计数：使用自然语言描述，统计图像中指定对象出现的次数。

     所有 Detector 都会分析图像以回答自然语言查询，并返回置信度分数以表明结果的可靠性。如果置信度低于指定阈值，查询将升级为人工审核。Detector 会通过持续学习反馈和更多示例不断改进。

   • 输入：config（DetectorConfig 对象，包含 name、query、confidence_threshold、mode 及特定模式的配置）

   • 返回：Detector 对象

2. get_detector

   • 描述：根据 ID 获取 Detector。
   • 输入：detector_id（字符串）
   • 返回：Detector 对象

3. list_detectors

   • 描述：列出与当前用户关联的所有 Detector。
   • 输入：无
   • 返回：Detector 对象列表

4. submit_image_query

   • 描述：向指定的 Detector 提交图像以获取回答。图像可以通过文件路径、URL 或原始字节数据提供。Detector 将返回包含标签和置信度分数的响应。
   • 输入：detector_id（字符串），image（字符串或字节数据）
   • 返回：ImageQuery 对象

5. get_image_query

   • 描述：根据 ID 获取现有的图像查询。
   • 输入：image_query_id（字符串）
   • 返回：ImageQuery 对象

6. list_image_queries

   • 描述：列出与指定 Detector 关联的所有图像查询。请注意，结果数量可能很大。
   • 输入：detector_id（字符串）
   • 返回：ImageQuery 对象列表

7. get_image

   • 描述：根据 ID 获取与图像查询关联的图像。如果有可用的边界框，可选择在图像上标注。
   • 输入：image_query_id（字符串），annotate（布尔值，默认值：false）
   • 返回：Image 对象

8. create_alert

   • 描述：为 Detector 创建警报，在满足特定条件时触发操作。
   • 输入：config（AlertConfig 对象，包含 name、detector_id、condition，以及可选的 webhook_action、email_action、text_action、enabled 和 human_review_required 字段）
   • 返回：Rule 对象

9. list_alerts

   • 描述：列出系统中的所有警报（规则）。（注意：当前实现不会按 Detector 筛选。）
   • 输入：page（整数，默认值：1），page_size（整数，默认值：100）
   • 返回：Rule 对象列表

10. delete_alert

    • 描述：根据警报 ID 删除警报（规则）。
    • 输入：alert_id（字符串）
    • 返回：无

11. add_label

    • 描述：为图像查询提供标签（标注）。此功能用于训练检测器或修正结果。对于计数检测器，可以选择提供感兴趣区域。
    • 输入：image_query_id（字符串）、label（整数或字符串）、rois（可选列表）
    • 返回：无

12. get_detector_evaluation_metrics

    • 描述：获取检测器的详细评估指标，包括混淆矩阵和示例。
    • 输入：detector_id（字符串）
    • 返回：评估指标字典

13. update_detector_confidence_threshold

    • 描述：更新检测器的置信度阈值。
    • 输入：detector_id（字符串）、confidence_threshold（浮点数）
    • 返回：无

14. update_detector_escalation_type

    • 描述：更新检测器的升级类型。此设置决定何时将查询发送给人工审核。选项：'STANDARD'（根据置信度阈值升级）或 'NO_HUMAN_LABELING'（永不升级）。
    • 输入：detector_id（字符串）、escalation_type（字符串，可为 "STANDARD" 或 "NO_HUMAN_LABELING"）
    • 返回：无

配置

与 Claude Desktop 搭配使用

将以下内容添加到 claude_desktop_config.json：

"mcpServers": {
  "groundlight": {
    "command": "docker",
    "args": ["run", "--rm", "-i", "-e", "GROUNDLIGHT_API_TOKEN", "groundlight/groundlight-mcp-server"],
    "env": {
        "GROUNDLIGHT_API_TOKEN": "YOUR_API_TOKEN_HERE"
    }
  }
}

与 Zed 搭配使用

将以下内容添加到 settings.json：

{
  "context_servers": {
    "groundlight": {
      "command": {
        "path": "docker",
        "args": [
          "run",
          "--rm",
          "-i",
          "-e",
          "GROUNDLIGHT_API_TOKEN",
          "groundlight/groundlight-mcp-server"
        ],
        "env": {
          "GROUNDLIGHT_API_TOKEN": "YOUR_API_TOKEN_HERE"
        }
      }
    }
  }
}

开发

在本地构建 Docker 镜像：

make build-docker

在本地运行 Docker 镜像：

make run-docker

[Groundlight Internal] 将 Docker 镜像推送到 Docker Hub（需要 DockerHub 凭据）：

make push-docker

s