Red Hat Insights API — Rules

naftiko: 1.0.0-alpha2
info:
  label: Red Hat Insights API — Rules
  description: 'Red Hat Insights API — Rules. 3 operations. Lead operation: Red Hat List Advisor Rules. Self-contained Naftiko
    capability covering one Red Hat business surface.'
  tags:
  - Red Hat
  - Rules
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    RED_HAT_API_KEY: RED_HAT_API_KEY
capability:
  consumes:
  - type: http
    namespace: insights-rules
    baseUri: https://console.redhat.com/api
    description: Red Hat Insights API — Rules business capability. Self-contained, no shared references.
    resources:
    - name: insights-v1-rule
      path: /insights/v1/rule/
      operations:
      - name: listrules
        method: GET
        description: Red Hat List Advisor Rules
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: category
          in: query
          type: integer
          description: Filter rules by category.
        - name: impact
          in: query
          type: string
          description: Filter rules by impact level.
        - name: likelihood
          in: query
          type: string
          description: Filter rules by likelihood level.
        - name: has_playbook
          in: query
          type: boolean
          description: Filter to rules that have remediation playbooks.
        - name: sort
          in: query
          type: string
          description: The field to sort results by.
    - name: insights-v1-rule-rule_id
      path: /insights/v1/rule/{rule_id}/
      operations:
      - name: getrule
        method: GET
        description: Red Hat Get an Advisor Rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: rule_id
          in: path
          type: string
          description: The unique identifier of the rule.
          required: true
    - name: insights-v1-rule-rule_id-systems
      path: /insights/v1/rule/{rule_id}/systems/
      operations:
      - name: listrulesystems
        method: GET
        description: Red Hat List Systems Affected by a Rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: rule_id
          in: path
          type: string
          description: The unique identifier of the rule.
          required: true
    authentication:
      type: bearer
      token: '{{env.RED_HAT_API_KEY}}'
  exposes:
  - type: rest
    namespace: insights-rules-rest
    port: 8080
    description: REST adapter for Red Hat Insights API — Rules. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/insights/v1/rule
      name: insights-v1-rule
      description: REST surface for insights-v1-rule.
      operations:
      - method: GET
        name: listrules
        description: Red Hat List Advisor Rules
        call: insights-rules.listrules
        with:
          category: rest.category
          impact: rest.impact
          likelihood: rest.likelihood
          has_playbook: rest.has_playbook
          sort: rest.sort
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/insights/v1/rule/{rule-id}
      name: insights-v1-rule-rule-id
      description: REST surface for insights-v1-rule-rule_id.
      operations:
      - method: GET
        name: getrule
        description: Red Hat Get an Advisor Rule
        call: insights-rules.getrule
        with:
          rule_id: rest.rule_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/insights/v1/rule/{rule-id}/systems
      name: insights-v1-rule-rule-id-systems
      description: REST surface for insights-v1-rule-rule_id-systems.
      operations:
      - method: GET
        name: listrulesystems
        description: Red Hat List Systems Affected by a Rule
        call: insights-rules.listrulesystems
        with:
          rule_id: rest.rule_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: insights-rules-mcp
    port: 9090
    transport: http
    description: MCP adapter for Red Hat Insights API — Rules. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: red-hat-list-advisor-rules
      description: Red Hat List Advisor Rules
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: insights-rules.listrules
      with:
        category: tools.category
        impact: tools.impact
        likelihood: tools.likelihood
        has_playbook: tools.has_playbook
        sort: tools.sort
      outputParameters:
      - type: object
        mapping: $.
    - name: red-hat-get-advisor-rule
      description: Red Hat Get an Advisor Rule
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: insights-rules.getrule
      with:
        rule_id: tools.rule_id
      outputParameters:
      - type: object
        mapping: $.
    - name: red-hat-list-systems-affected
      description: Red Hat List Systems Affected by a Rule
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: insights-rules.listrulesystems
      with:
        rule_id: tools.rule_id
      outputParameters:
      - type: object
        mapping: $.