WebSphere Liberty REST Connector API — MBeans

naftiko: 1.0.0-alpha2
info:
  label: WebSphere Liberty REST Connector API — MBeans
  description: 'WebSphere Liberty REST Connector API — MBeans. 6 operations. Lead operation: List Registered Mbeans. Self-contained
    Naftiko capability covering one Websphere business surface.'
  tags:
  - Websphere
  - MBeans
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WEBSPHERE_API_KEY: WEBSPHERE_API_KEY
capability:
  consumes:
  - type: http
    namespace: liberty-rest-connector-mbeans
    baseUri: https://localhost:9443/IBMJMXConnectorREST/api
    description: WebSphere Liberty REST Connector API — MBeans business capability. Self-contained, no shared references.
    resources:
    - name: mbeans
      path: /mbeans
      operations:
      - name: listmbeans
        method: GET
        description: List Registered Mbeans
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: objectName
          in: query
          type: string
          description: ObjectName pattern to filter MBeans
        - name: className
          in: query
          type: string
          description: Filter by MBean class name
    - name: mbeans-objectName
      path: /mbeans/{objectName}
      operations:
      - name: getmbeaninfo
        method: GET
        description: Get Mbean Information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: mbeans-objectName-attributes
      path: /mbeans/{objectName}/attributes
      operations:
      - name: getmbeanattributes
        method: GET
        description: Get Mbean Attributes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: mbeans-objectName-attributes-attributeName
      path: /mbeans/{objectName}/attributes/{attributeName}
      operations:
      - name: getmbeanattribute
        method: GET
        description: Get a Specific Mbean Attribute
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: attributeName
          in: path
          type: string
          description: Name of the MBean attribute
          required: true
      - name: setmbeanattribute
        method: PUT
        description: Set a Specific Mbean Attribute
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: attributeName
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: mbeans-objectName-operations-operationName
      path: /mbeans/{objectName}/operations/{operationName}
      operations:
      - name: invokembeanoperation
        method: POST
        description: Invoke an Mbean Operation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: operationName
          in: path
          type: string
          description: Name of the MBean operation to invoke
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: basic
      username: '{{env.WEBSPHERE_USER}}'
      password: '{{env.WEBSPHERE_PASS}}'
  exposes:
  - type: rest
    namespace: liberty-rest-connector-mbeans-rest
    port: 8080
    description: REST adapter for WebSphere Liberty REST Connector API — MBeans. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/mbeans
      name: mbeans
      description: REST surface for mbeans.
      operations:
      - method: GET
        name: listmbeans
        description: List Registered Mbeans
        call: liberty-rest-connector-mbeans.listmbeans
        with:
          objectName: rest.objectName
          className: rest.className
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/mbeans/{objectname}
      name: mbeans-objectname
      description: REST surface for mbeans-objectName.
      operations:
      - method: GET
        name: getmbeaninfo
        description: Get Mbean Information
        call: liberty-rest-connector-mbeans.getmbeaninfo
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/mbeans/{objectname}/attributes
      name: mbeans-objectname-attributes
      description: REST surface for mbeans-objectName-attributes.
      operations:
      - method: GET
        name: getmbeanattributes
        description: Get Mbean Attributes
        call: liberty-rest-connector-mbeans.getmbeanattributes
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/mbeans/{objectname}/attributes/{attributename}
      name: mbeans-objectname-attributes-attributename
      description: REST surface for mbeans-objectName-attributes-attributeName.
      operations:
      - method: GET
        name: getmbeanattribute
        description: Get a Specific Mbean Attribute
        call: liberty-rest-connector-mbeans.getmbeanattribute
        with:
          attributeName: rest.attributeName
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: setmbeanattribute
        description: Set a Specific Mbean Attribute
        call: liberty-rest-connector-mbeans.setmbeanattribute
        with:
          attributeName: rest.attributeName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/mbeans/{objectname}/operations/{operationname}
      name: mbeans-objectname-operations-operationname
      description: REST surface for mbeans-objectName-operations-operationName.
      operations:
      - method: POST
        name: invokembeanoperation
        description: Invoke an Mbean Operation
        call: liberty-rest-connector-mbeans.invokembeanoperation
        with:
          operationName: rest.operationName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: liberty-rest-connector-mbeans-mcp
    port: 9090
    transport: http
    description: MCP adapter for WebSphere Liberty REST Connector API — MBeans. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-registered-mbeans
      description: List Registered Mbeans
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: liberty-rest-connector-mbeans.listmbeans
      with:
        objectName: tools.objectName
        className: tools.className
      outputParameters:
      - type: object
        mapping: $.
    - name: get-mbean-information
      description: Get Mbean Information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: liberty-rest-connector-mbeans.getmbeaninfo
      outputParameters:
      - type: object
        mapping: $.
    - name: get-mbean-attributes
      description: Get Mbean Attributes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: liberty-rest-connector-mbeans.getmbeanattributes
      outputParameters:
      - type: object
        mapping: $.
    - name: get-specific-mbean-attribute
      description: Get a Specific Mbean Attribute
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: liberty-rest-connector-mbeans.getmbeanattribute
      with:
        attributeName: tools.attributeName
      outputParameters:
      - type: object
        mapping: $.
    - name: set-specific-mbean-attribute
      description: Set a Specific Mbean Attribute
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: liberty-rest-connector-mbeans.setmbeanattribute
      with:
        attributeName: tools.attributeName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: invoke-mbean-operation
      description: Invoke an Mbean Operation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: liberty-rest-connector-mbeans.invokembeanoperation
      with:
        operationName: tools.operationName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.