Back to MCP directory
publicPublicdnsLocal runtime

soracom-mcp-server

SORACOM MCP Server是一个基于Model Context Protocol的服务器,提供与SORACOM API的无缝集成,支持多种工具用于查询账单、日志、订单、SIM卡、订阅者等信息。

article

README

🚀 SORACOM MCP 服务器

SORACOM MCP 服务器是一个基于 模型上下文协议 (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",
            "name": "SORACOM_AUTH_KEY",
            "description": "请输入您的 SORACOM 认证密钥。",
            "required": true
        }
    ],
    "outputs": [
        {
            "type": "command",
            "command": "shellCommand",
            "args": [
                "docker run -it --rm -e SORACOM_AUTH_KEY=${input:Soracom Auth Key} soracom-mcp-server:latest"
            ]
        }
    ]
  }
}

✨ 主要特性

以下是 MCP 服务器支持的所有工具及其功能描述:

计费相关工具

  • getBillingHistory:获取过去已确认的按月计费历史记录。
  • getBillingUsage:获取详细的计费使用情况。
  • exportBillingInformation:导出计费信息。

日志管理工具

  • .getLogEntries:检索特定资源的日志条目。
  • streamLogs:实时流式传输日志数据。
  • searchLogEvents:搜索符合条件的日志事件。

订单管理工具

  • createOrder:创建新的订单。
  • getOrderStatus:获取订单的状态信息。
  • cancelOrder:取消未完成的订单。

数据同步工具

  • syncData:同步资源之间的数据。
  • validateDataIntegrity:验证数据完整性。
  • exportDataSource:导出数据源的内容。

设备管理工具

  • registerDevice:注册新的设备。
  • getDeviceStatus:获取设备的运行状态。
  • updateDeviceSettings:更新设备配置设置。

资源监控工具

  • monitorResourceUsage:监控资源使用情况。
  • alertThresholdExceeded:检测并报告超出阈值的情况。
  • generateReport:生成资源使用报告。

安全管理工具

  • createSecurityRule:创建新的安全规则。
  • getSecurityPolicy:获取当前的安全策略配置。
  • testSecurityGroup:测试安全组的访问控制规则。

通知服务工具

  • sendNotification:发送自定义的通知消息。
  • subscribeToEvents:订阅特定事件的通知。
  • unsubscribeFromUpdates:取消对更新的通知订阅。

数据存储工具

  • createDataStore:创建新的数据存储区域。
  • getDataStoreContents:检索数据存储中的内容。
  • deleteOldData:删除过期的数据记录。

📚 详细文档

使用说明

  • 获取帮助:如需更多信息,请访问 SORACOM 官方文档
  • 反馈问题:遇到任何问题,可通过邮件联系 support@ soracom.io。
help

Runtime guide

cloud

Hosted runtime

Hosted servers run from a provider-managed environment. You usually connect the MCP client to the hosted endpoint or follow the provider's authorization flow, without keeping a local process alive

  1. Open provider connection page
  2. Authorize or copy endpoint
  3. Connect from your MCP client
terminal

Local runtime / other methods

Local servers run on your own machine or infrastructure. You normally copy the server_config into your MCP client, install the required package, and provide env variables from env_schema when needed

  1. Copy server_config
  2. Install required package
  3. Fill env variables and restart client