UKG HR Administration

naftiko: "1.0.0-alpha1"

info:
  label: "UKG HR Administration"
  description: "HR administration workflow combining employee records, benefits, payroll, and organizational management capabilities."
  tags:
    - UKG
    - HCM
    - HR Administration
    - Benefits
    - Payroll
    - Employees
  created: "2026-05-03"
  modified: "2026-05-03"
  personas:
    - HR Administrator
    - Benefits Administrator
    - Payroll Processor
    - HR Business Partner

imports:
  - url: shared/pro-hcm.yaml
    namespace: pro-hcm

capability:
  exposes:
    - type: rest
      port: 8081
      namespace: hr-administration-api
      resources:
        - path: /v1/employees
          name: employees
          description: "Employee records"
          operations:
            - method: GET
              name: list-employees
              description: "List all employees"
              call: "pro-hcm.list-employees"
              outputParameters:
                - type: object
                  mapping: "$."
        - path: /v1/employees/{employeeId}/benefits
          name: benefits
          description: "Employee benefits elections"
          operations:
            - method: GET
              name: get-benefits-elections
              description: "Get benefits elections for an employee"
              call: "pro-hcm.get-benefits-elections"
              outputParameters:
                - type: object
                  mapping: "$."
        - path: /v1/pay-statements
          name: pay-statements
          description: "Employee pay statements"
          operations:
            - method: GET
              name: list-pay-statements
              description: "Get pay statement history"
              call: "pro-hcm.list-pay-statements"
              outputParameters:
                - type: object
                  mapping: "$."
    - type: mcp
      port: 9081
      namespace: hr-administration-mcp
      transport: http
      tools:
        - name: list-employees
          description: "List all employee records with demographics and job data"
          hints:
            readOnly: true
            openWorld: true
          call: "pro-hcm.list-employees"
          outputParameters:
            - type: object
              mapping: "$."
        - name: get-employee
          description: "Get a specific employee record by ID"
          hints:
            readOnly: true
            openWorld: true
          call: "pro-hcm.get-employee"
          outputParameters:
            - type: object
              mapping: "$."
        - name: get-employee-jobs
          description: "Get job assignment information for an employee"
          hints:
            readOnly: true
            openWorld: true
          call: "pro-hcm.get-employee-jobs"
          outputParameters:
            - type: object
              mapping: "$."
        - name: get-pay-rates
          description: "Get pay rates for an employee"
          hints:
            readOnly: true
            openWorld: true
          call: "pro-hcm.get-pay-rates"
          outputParameters:
            - type: object
              mapping: "$."
        - name: get-benefits-elections
          description: "Get benefits elections for an employee"
          hints:
            readOnly: true
            openWorld: true
          call: "pro-hcm.get-benefits-elections"
          outputParameters:
            - type: object
              mapping: "$."
        - name: list-departments
          description: "List all departments in the organization"
          hints:
            readOnly: true
            openWorld: true
          call: "pro-hcm.list-departments"
          outputParameters:
            - type: object
              mapping: "$."
        - name: list-locations
          description: "List all work locations"
          hints:
            readOnly: true
            openWorld: true
          call: "pro-hcm.list-locations"
          outputParameters:
            - type: object
              mapping: "$."
        - name: list-pay-statements
          description: "Get employee pay statement history"
          hints:
            readOnly: true
            openWorld: true
          call: "pro-hcm.list-pay-statements"
          outputParameters:
            - type: object
              mapping: "$."