数据分析协议服务器

SORACOM提供的数据分析协议服务器,用于获取和分析Harvest Data、Harvest Files及SoraCam数据。

  • by leaveanest
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 leaveanest/alt-soracom-data-reader-mcp

使用说明

SORACOM 数据分析MCP

SORACOM APIー活用ー分析向MCP(Model Context Protocol)服务器。

概要

SORACOM Harvest Data、Harvest Files、提供获取和分析索拉龟数据的工具。 认证包括:SAM使用用户的验证密钥。

対象API一覧

1. Harvest Data(传感器数据)📊

| API | 说明|模式| | ------------------------------------------------------ | --------------------------- | --------- | | GET /v1/data/subscribers/{imsi} 确定SIM的,之Harvest Data获得 harvest | | GET /v1/data/resources/{resource_type}/{resource_id} 以资源为单位获取数据 harvest |

2. Harvest Files(文件存储)📁

| API | 说明|模式| | ------------------------------ | --------------------------------------- | --------- | | GET /v1/files/{scope}/{path} 获取文件目录列表 harvest | | GET /v1/files/{scope}/{path} 下载文件(redirect=true) | harvest | | GET /v1/files/{scope}/_info 存储使用情况 harvest |

3.相机管理(SoraCam Devices)📹

| API | 说明|模式| | -------------------------------------- | ------------------ | --------- | | GET /v1/sora_cam/devices 获取相机列表 soracam | | GET /v1/sora_cam/devices/{device_id} 获取相机详细信息 soracam |

4.SoraCam Videos🎬

| API | 说明|模式| | ----------------------------------------------------------------- | --------------------- | --------- | | GET /v1/sora_cam/devices/{device_id}/videos |録画一覧取得| soracam | | POST /v1/sora_cam/devices/{device_id}/videos/exports 视频导出开始 soracam | | GET /v1/sora_cam/devices/{device_id}/videos/exports/{export_id} |确认导出状况| soracam | | POST /v1/sora_cam/devices/{device_id}/videos/images | 静止画取得 | soracam | | GET /v1/sora_cam/devices/{device_id}/stream 流式传输URL获取 soracam |

5.索拉龟事件检测(SoraCam Events)🔔

| API | 说明|模式| | -------------------------------------------------------- | ---------------- | --------- | | GET /v1/sora_cam/devices/{device_id}/events 获取事件列表 soracam | | GET /v1/sora_cam/devices/{device_id}/events/{event_id} 获取事件详细信息 soracam |

6. SIM・统计情报(Subscribers & Stats)📈

| API | 说明|模式| | -------------------------------------- | --------------------------- | ------- | | GET /v1/subscribers | SIM一覧取得 | stats | | GET /v1/subscribers/{imsi} |特定SIM情报取得| stats | | GET /v1/groups 获取组列表 stats | | GET /v1/stats/air/subscribers/{imsi} | SIM通信统计(数据使用量) stats | | GET /v1/stats/harvest/{imsi} | Harvest利用统计| stats |

设置身份验证

这MCP来修改标记元素的显示属性SORACOM SAM必须获取用户的验证密钥。

如何获取认证密钥

  1. SORACOM用户控制台 登录
  2. 右上角的帐户菜单→选择“安全性”
  3. 「SAM选择“用户”选项卡
  4. SAM创建用户(或选择现有用户)
  5. 生成验证密钥
  6. authKeyId 和 authKey 记录

所需权限

SAM用户必须具有以下权限:

  • harvest:getDataEntry - Harvest Data读取
  • files:getObject - Harvest Files读取
  • files:listObjects - Harvest Files一覧取得
  • SoraCam:* -按需缩放
  • subscriber:getSubscriber - SIM信息读取
  • stats:getAirStats -通信统计信息读取

用法

安装

# GitHubから直接インストール
uv tool install git+https://github.com/leaveanest/alt-soracom-data-reader-mcp.git

# 実行
soracom-data-mcp --mode harvest
# または、uvxで一時的に実行(インストール不要)
uvx --from git+https://github.com/leaveanest/alt-soracom-data-reader-mcp.git soracom-data-mcp --mode harvest

模式

模式|说明| | --------- | -------------------------- | | harvest | Harvest Data/Files取得 | | soracam 取得索拉龟影像·活动 | stats | SIM情报・通信统计取得| | all |所有工具(开发用)|

环境变数

export SORACOM_AUTH_KEY_ID="keyId-xxx"  # 必須
export SORACOM_AUTH_KEY="secret-xxx"    # 必須
export SORACOM_COVERAGE="jp"            # オプション(デフォルト: jp)

MCP设定例

uv tool install已安装

{
  "mcpServers": {
    "soracom-harvest": {
      "command": "soracom-data-mcp",
      "args": ["--mode", "harvest"],
      "env": {
        "SORACOM_AUTH_KEY_ID": "keyId-xxx",
        "SORACOM_AUTH_KEY": "secret-xxx"
      }
    }
  }
}

uvx的GitHub直接执行

{
  "mcpServers": {
    "soracom-harvest": {
      "command": "uvx",
      "args": [
        "--from", "git+https://github.com/leaveanest/alt-soracom-data-reader-mcp.git",
        "soracom-data-mcp", "--mode", "harvest"
      ],
      "env": {
        "SORACOM_AUTH_KEY_ID": "keyId-xxx",
        "SORACOM_AUTH_KEY": "secret-xxx"
      }
    }
  }
}

本地开发用

{
  "mcpServers": {
    "soracom-harvest": {
      "command": "uv",
      "args": ["run", "soracom-data-mcp", "--mode", "harvest"],
      "env": {
        "SORACOM_AUTH_KEY_ID": "keyId-xxx",
        "SORACOM_AUTH_KEY": "secret-xxx"
      }
    }
  }
}

注意事项

  • API有汇率限制
  • 索拉龟API我们需要索拉卡梅合同
  • Harvest Data/Files啊Harvest我们需要一份合同

参考链接