Soracom MCP Server

🚀 SORACOM MCP Server

The SORACOM MCP Server is a server based on the Model Context Protocol (MCP), enabling seamless integration (partially supported) with the SORACOM API.

🚀 Quick Start

📦 Installation

1. Build the Docker Image

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

2. Configure VSCode

{
  "mcp": {
    "inputs": [
        {
            "type": "promptString",
            "name": "SORACOM_AUTH_KEY",
            "description": "Please enter your SORACOM authentication key.",
            "required": true
        }
    ],
    "outputs": [
        {
            "type": "command",
            "command": "shellCommand",
            "args": [
                "docker run -it --rm -e SORACOM_AUTH_KEY=${input:Soracom Auth Key} soracom-mcp-server:latest"
            ]
        }
    ]
  }
}

✨ Features

The following are all the tools supported by the MCP Server and their functional descriptions:

Billing-related Tools

• getBillingHistory: Retrieve the past confirmed monthly billing history.
• getBillingUsage: Obtain detailed billing usage information.
• exportBillingInformation: Export billing information.

Log Management Tools

• .getLogEntries: Retrieve log entries for specific resources.
• streamLogs: Stream log data in real-time.
• searchLogEvents: Search for log events that meet specific criteria.

Order Management Tools

• createOrder: Create a new order.
• getOrderStatus: Get the status information of an order.
• cancelOrder: Cancel an unfinished order.

Data Synchronization Tools

• syncData: Synchronize data between resources.
• validateDataIntegrity: Validate data integrity.
• exportDataSource: Export the contents of a data source.

Device Management Tools

• registerDevice: Register a new device.
• getDeviceStatus: Get the operating status of a device.
• updateDeviceSettings: Update device configuration settings.

Resource Monitoring Tools

• monitorResourceUsage: Monitor resource usage.
• alertThresholdExceeded: Detect and report situations where thresholds are exceeded.
• generateReport: Generate a resource usage report.

Security Management Tools

• createSecurityRule: Create a new security rule.
• getSecurityPolicy: Get the current security policy configuration.
• testSecurityGroup: Test the access control rules of a security group.

Notification Service Tools

• sendNotification: Send custom notification messages.
• subscribeToEvents: Subscribe to notifications for specific events.
• unsubscribeFromUpdates: Cancel subscriptions to update notifications.

Data Storage Tools

• createDataStore: Create a new data storage area.
• getDataStoreContents: Retrieve the contents of a data store.
• deleteOldData: Delete expired data records.

📚 Documentation

💻 Usage Examples

1. Get Help: For more information, please visit the SORACOM official documentation.
2. Report Issues: If you encounter any problems, you can contact support@ soracom.io via email.