Webex · Capability

Webex Device — xAPI

Webex Device — xAPI. 3 operations. Lead operation: Execute Command. Self-contained Naftiko capability covering one Webex business surface.

Run with Naftiko WebexxAPI

What You Can Do

POST
Executecommand — Execute Command
/v1/xapi/command/{commandname}
GET
Queryschema — Query Schema
/v1/xapi/schema
GET
Querystatus — Query Status
/v1/xapi/status

MCP Tools

execute-command

Execute Command

query-schema

Query Schema

read-only idempotent
query-status

Query Status

read-only idempotent

Capability Spec

device-xapi.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: Webex Device — xAPI
  description: 'Webex Device — xAPI. 3 operations. Lead operation: Execute Command. Self-contained Naftiko capability covering
    one Webex business surface.'
  tags:
  - Webex
  - xAPI
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WEBEX_API_KEY: WEBEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: device-xapi
    baseUri: ''
    description: Webex Device — xAPI business capability. Self-contained, no shared references.
    resources:
    - name: xapi-command-commandName
      path: /xapi/command/{commandName}
      operations:
      - name: executecommand
        method: POST
        description: Execute Command
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: commandName
          in: path
          type: string
          description: Command to execute on the Webex RoomOS Device.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: xapi-schema
      path: /xapi/schema
      operations:
      - name: queryschema
        method: GET
        description: Query Schema
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deviceId
          in: query
          type: array
          description: A list of device IDs to query schemas from. A request can contain at most 5 device IDs.
          required: true
        - name: status
          in: query
          type: array
          description: A list of status key expressions to query schemas for. Supports patterns. Requires the `spark:xapi_statuses`
            scope.
        - name: command
          in: query
          type: array
          description: A list of command key expressions to query schemas for. Supports patterns. Requires the `spark:xapi_commands`
            scope.
    - name: xapi-status
      path: /xapi/status
      operations:
      - name: querystatus
        method: GET
        description: Query Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deviceId
          in: query
          type: string
          description: The unique identifier for the Webex RoomOS Device.
          required: true
        - name: name
          in: query
          type: array
          description: A list of status expressions used to query the Webex RoomOS Device. See the [xAPI section of the Device
            Developers Guide](/docs/api/guides/device-developers-gui
          required: true
    authentication:
      type: bearer
      token: '{{env.WEBEX_API_KEY}}'
  exposes:
  - type: rest
    namespace: device-xapi-rest
    port: 8080
    description: REST adapter for Webex Device — xAPI. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/xapi/command/{commandname}
      name: xapi-command-commandname
      description: REST surface for xapi-command-commandName.
      operations:
      - method: POST
        name: executecommand
        description: Execute Command
        call: device-xapi.executecommand
        with:
          commandName: rest.commandName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/xapi/schema
      name: xapi-schema
      description: REST surface for xapi-schema.
      operations:
      - method: GET
        name: queryschema
        description: Query Schema
        call: device-xapi.queryschema
        with:
          deviceId: rest.deviceId
          status: rest.status
          command: rest.command
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/xapi/status
      name: xapi-status
      description: REST surface for xapi-status.
      operations:
      - method: GET
        name: querystatus
        description: Query Status
        call: device-xapi.querystatus
        with:
          deviceId: rest.deviceId
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: device-xapi-mcp
    port: 9090
    transport: http
    description: MCP adapter for Webex Device — xAPI. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: execute-command
      description: Execute Command
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: device-xapi.executecommand
      with:
        commandName: tools.commandName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: query-schema
      description: Query Schema
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: device-xapi.queryschema
      with:
        deviceId: tools.deviceId
        status: tools.status
        command: tools.command
      outputParameters:
      - type: object
        mapping: $.
    - name: query-status
      description: Query Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: device-xapi.querystatus
      with:
        deviceId: tools.deviceId
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.