Soracom Batch Capability

naftiko: 1.0.0-alpha2
info:
  label: Soracom Batch Capability
  description: Self-contained Naftiko capability for creating and running Soracom Batch jobs that apply API calls across many SIMs or devices.
  tags:
  - Soracom
  - Batch
  - Automation
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    SORACOM_API_KEY: SORACOM_API_KEY
    SORACOM_API_TOKEN: SORACOM_API_TOKEN
capability:
  consumes:
  - type: http
    namespace: batch
    baseUri: https://api.soracom.io/v1
    description: Soracom Batch API.
    resources:
    - name: batch-groups
      path: /batch_groups
      operations:
      - name: listBatchGroups
        method: GET
        description: List batch groups.
        outputRawFormat: json
        outputParameters:
        - {name: result, type: array, value: $.}
        inputParameters: []
      - name: createBatchGroup
        method: POST
        description: Create a batch group.
        outputRawFormat: json
        outputParameters:
        - {name: result, type: object, value: $.}
        inputParameters:
        - {name: body, in: body, type: object, required: true}
    - name: batch-group-by-id
      path: /batch_groups/{batch_group_id}
      operations:
      - name: getBatchGroup
        method: GET
        description: Get a batch group.
        outputRawFormat: json
        outputParameters:
        - {name: result, type: object, value: $.}
        inputParameters:
        - {name: batch_group_id, in: path, type: string, required: true}
    - name: batch-jobs
      path: /batch_groups/{batch_group_id}/jobs
      operations:
      - name: listBatchJobs
        method: GET
        description: List jobs for a batch group.
        outputRawFormat: json
        outputParameters:
        - {name: result, type: array, value: $.}
        inputParameters:
        - {name: batch_group_id, in: path, type: string, required: true}
      - name: createBatchJob
        method: POST
        description: Create a job in the batch group.
        outputRawFormat: json
        outputParameters:
        - {name: result, type: object, value: $.}
        inputParameters:
        - {name: batch_group_id, in: path, type: string, required: true}
        - {name: body, in: body, type: object, required: true}
    authentication:
      type: apikey
      key: X-Soracom-API-Key
      value: '{{env.SORACOM_API_KEY}}'
      placement: header
  exposes:
  - type: mcp
    namespace: batch-mcp
    port: 9090
    transport: http
    description: MCP adapter for batch jobs.
    tools:
    - name: soracom-list-batch-groups
      description: List Soracom batch groups.
      hints: {readOnly: true, destructive: false, idempotent: true}
      call: batch.listBatchGroups
      outputParameters:
      - {type: array, mapping: $.}
    - name: soracom-create-batch-group
      description: Create a Soracom batch group.
      hints: {readOnly: false, destructive: false, idempotent: false}
      call: batch.createBatchGroup
      with:
        body: tools.body
      outputParameters:
      - {type: object, mapping: $.}
    - name: soracom-create-batch-job
      description: Create a job in a batch group.
      hints: {readOnly: false, destructive: false, idempotent: false}
      call: batch.createBatchJob
      with:
        batch_group_id: tools.batch_group_id
        body: tools.body
      outputParameters:
      - {type: object, mapping: $.}