Soracom Analysis and Query Capability

naftiko: 1.0.0-alpha2
info:
  label: Soracom Analysis and Query Capability
  description: Self-contained Naftiko capability for executing SQL queries on Soracom Query (Analysis) and searching across SIMs, Inventory devices, and Sigfox devices.
  tags:
  - Soracom
  - Query
  - Analysis
  - SQL
  - Search
  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: query
    baseUri: https://api.soracom.io/v1
    description: Soracom Analysis (Query) and Search API.
    resources:
    - name: analysis-queries
      path: /analysis/queries
      operations:
      - name: startQuery
        method: POST
        description: Execute an SQL query asynchronously against Soracom Query data.
        outputRawFormat: json
        outputParameters:
        - {name: result, type: object, value: $.}
        inputParameters:
        - {name: body, in: body, type: object, required: true}
    - name: analysis-query-by-id
      path: /analysis/queries/{query_id}
      operations:
      - name: getQuery
        method: GET
        description: Get the status and results of a previously submitted query.
        outputRawFormat: json
        outputParameters:
        - {name: result, type: object, value: $.}
        inputParameters:
        - {name: query_id, in: path, type: string, required: true}
    - name: analysis-schemas
      path: /analysis/schemas
      operations:
      - name: listSchemas
        method: GET
        description: List query schemas (tables and columns) available in Soracom Query.
        outputRawFormat: json
        outputParameters:
        - {name: result, type: array, value: $.}
        inputParameters: []
    - name: query-sims
      path: /query/sims
      operations:
      - name: searchSims
        method: GET
        description: Search SIMs.
        outputRawFormat: json
        outputParameters:
        - {name: result, type: array, value: $.}
        inputParameters:
        - {name: search_type, in: query, type: string, required: false}
        - {name: name, in: query, type: string, required: false}
        - {name: tag_name, in: query, type: string, required: false}
        - {name: tag_value, in: query, type: string, required: false}
    authentication:
      type: apikey
      key: X-Soracom-API-Key
      value: '{{env.SORACOM_API_KEY}}'
      placement: header
  exposes:
  - type: mcp
    namespace: query-mcp
    port: 9090
    transport: http
    description: MCP adapter for Query and search.
    tools:
    - name: soracom-start-query
      description: Run an SQL query against Soracom Query tables.
      hints: {readOnly: true, destructive: false, idempotent: false}
      call: query.startQuery
      with:
        body: tools.body
      outputParameters:
      - {type: object, mapping: $.}
    - name: soracom-get-query
      description: Fetch the status/result of a Soracom Query execution.
      hints: {readOnly: true, destructive: false, idempotent: true}
      call: query.getQuery
      with:
        query_id: tools.query_id
      outputParameters:
      - {type: object, mapping: $.}
    - name: soracom-list-query-schemas
      description: List Soracom Query schemas.
      hints: {readOnly: true, destructive: false, idempotent: true}
      call: query.listSchemas
      outputParameters:
      - {type: array, mapping: $.}
    - name: soracom-search-sims
      description: Search SIMs by name, tag, or other attributes.
      hints: {readOnly: true, destructive: false, idempotent: true}
      call: query.searchSims
      with:
        search_type: tools.search_type
        name: tools.name
        tag_name: tools.tag_name
        tag_value: tools.tag_value
      outputParameters:
      - {type: array, mapping: $.}