SORACOM MCP Server

SORACOM MCP Server

SORACOM MCP Server 是一款 Model Context Protocol (MCP) 服务，可与 SORACOM API（部分）无缝集成。

安装

1. 构建 Docker 镜像

git clone {THIS_REPOSITORY_URL}
cd soracom-mcp-server
docker build -t soracom-mcp-server:latest .

2. 设置 VSCode

{
  "mcp": {
    "inputs": [
        {
            "type": "promptString",
            "id": "soracom_auth_key",
            "description": "SORACOM Auth Key",
            "password": true
        },
        {
            "type": "promptString",
            "id": "soracom_auth_key_id",
            "description": "SORACOM Auth Key ID",
            "password": true
         }
    ],
    "servers": {
      "soracom": {
        "command": "docker",
        "args": [
          "run",
          "-i",
          "--rm",
          "-e",
          "SORACOM_AUTH_KEY",
          "-e",
          "SORACOM_AUTH_KEY_ID",
          "soracom-mcp-server:latest"
        ],
        "env": {
          "SORACOM_AUTH_KEY": "${input:soracom_auth_key}",
          "SORACOM_AUTH_KEY_ID": "${input:soracom_auth_key_id}"
        }
      }
    }
  }
}

有关在 VS Code 中使用 MCP 服务工具的更多信息，请参阅 Agent 模式文档。

工具

提供的工具如下。这些工具支持部分 SORACOM API，主要用于检索信息。 调用所有 API 的服务类（截至 2025 年 4 月 15 日）位于 src/generated，因此你可以参考文件 src/handlers/toolsMap 添加更多工具。

账单工具

• getBillingHistory：按月检索已确认的历史账单。
• getBilling：检索指定月份已确认的账单。
• getBillingPerDay：检索指定月份的每日账单。
• exportBilling：将历史账单详情导出为 CSV 并存储。
• getLatestBilling：检索本月最新账单。
• exportLatestBilling：将最新账单详情导出为 CSV 并存储。
• getBillingSummaryOfBillItems：检索过去 4 个月按账单项目汇总的账单信息。
• getBillingSummaryOfSims：检索过去 4 个月按 SIM 汇总的账单信息。

日志工具

• getLogs：获取目标的日志。

订单工具

• listOrders：列出所有订单。
• getOrder：获取订单详情。
• listOrderedSubscribers：列出指定订单中的订购用户。
• listProducts：检索可用产品列表。
• listAvailableDiscounts：检索可用的长期折扣列表。

SIM 工具

• listSims：列出所有 SIM。
• getSim：获取 SIM 详情。

Soralet 工具

• listSoralets：检索 Soralet 列表。
• getSoralet：检索 Soralet 详情。
• getSoraletLogs：检索 Soralet 日志。
• testSoralet：使用参数测试 Soralet。
• listSoraletVersions：检索 Soralet 版本列表。

用户工具

• listSubscribers：列出所有用户。
• getSubscriber：获取用户详情。

SoraCam 工具

• listSoraCamDevices：获取 SoraCam 设备列表。
• getSoraCamDevice：获取 SoraCam 设备的详细信息。
• getSoraCamDeviceAtomCamSettingsMotion：获取运动检测设置。
• getSoraCamDeviceAtomCamSettingsMotionSensitivity：获取运动检测灵敏度设置。
• getSoraCamDeviceAtomCamSettingsNightVision：获取夜视模式设置。
• getSoraCamDeviceAtomCamSettingsQuality：获取图像质量设置。
• getSoraCamDeviceAtomCamSettingsRotation：获取图像旋转设置。
• getSoraCamDeviceAtomCamSettingsSound：获取声音检测设置。
• getSoraCamDeviceAtomCamSettingsSoundSensitivity：获取声音检测灵敏度设置。
• getSoraCamDeviceAtomCamSettingsStatusLight：获取状态指示灯设置。
• getSoraCamDeviceAtomCamSettingsTimestamp：获取时间戳显示设置。
• listSoraCamDeviceEventsForDevice：获取指定 SoraCam 设备的事件列表。
• getSoraCamDeviceExportUsage：获取 SoraCam 设备的导出用量。
• listSoraCamDeviceImageExportsForDevice：获取指定 SoraCam 设备的图像导出状态列表。
• exportSoraCamDeviceRecordedImage：从 SoraCam 设备的录制视频中导出静态图像。
• getSoraCamDeviceExportedImage：获取 SoraCam 设备的图像导出状态。
• getSoraCamDeviceName：获取 SoraCam 设备的名称。
• getSoraCamDevicePowerState：获取 SoraCam 设备的电源状态。
• listSoraCamDeviceRecordingsAndEvents：获取 SoraCam 设备的录制时段和事件列表。
• getSoraCamDeviceStreamingVideo：获取 SoraCam 设备的流媒体视频信息。
• listSoraCamDeviceVideoExportsForDevice：获取指定 SoraCam 设备的视频导出状态列表。
• getSoraCamDeviceExportedVideo：获取 SoraCam 设备的视频导出状态。
• exportSoraCamDeviceRecordedVideo：导出 SoraCam 设备的录制视频。
• listSoraCamDeviceAtomCamFirmwareUpdates：获取可进行固件更新的 SoraCam 设备列表。
• listSoraCamDeviceEvents：获取所有 SoraCam 设备的事件列表。
• listSoraCamDeviceImageExports：获取所有 SoraCam 设备的图像导出状态列表。
• listSoraCamDeviceVideoExports：获取所有 SoraCam 设备的视频导出状态列表。
• listSoraCamLicensePacks：获取 SoraCam 的许可证包列表。

DataEntryService 工具

• getDataEntries：获取指定资源中的数据条目列表。
• getDataEntry：根据资源 ID 和时间戳获取指定数据条目的详细信息。
• listDataSourceResources：列出操作员的所有数据源资源。