InsightIDR API — Comments

naftiko: 1.0.0-alpha2
info:
  label: InsightIDR API — Comments
  description: 'InsightIDR API — Comments. 5 operations. Lead operation: List comments. Self-contained Naftiko capability covering one business surface.'
  tags:
  - Rapid7
  - Comments
  created: '2026-05-20'
  modified: '2026-05-20'
binds:
- namespace: env
  keys:
    RAPID7_API_KEY: RAPID7_API_KEY
capability:
  consumes:
  - type: http
    namespace: insightidr-comments
    baseUri: https://{region}.api.insight.rapid7.com
    description: InsightIDR API — Comments business capability. Self-contained, no shared references.
    resources:
    - name: idr-v1-comments-rrn-visibility
      path: /idr/v1/comments/{rrn}/{visibility}
      operations:
      - name: updatecomment
        method: PUT
        description: Update comment visibility
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: rrn
          in: path
          type: string
          description: The RRN of the comment.
          required: true
        - name: visibility
          in: path
          type: string
          description: The new visibility for the comment (case insensitive).
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: idr-v1-comments
      path: /idr/v1/comments
      operations:
      - name: listcomments
        method: GET
        description: List comments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: target
          in: query
          type: string
          description: Return comments with this target.
          required: true
        - name: index
          in: query
          type: integer
          description: The optional 0, based index of the page to retrieve. Must be an integer greater than or equal to 0.
        - name: size
          in: query
          type: integer
          description: The optional size of the page to retrieve. Must be an integer greater than 0 or less  or equal to 100.
      - name: createcomment
        method: POST
        description: Create comment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: idr-v1-comments-rrn
      path: /idr/v1/comments/{rrn}
      operations:
      - name: getcomment
        method: GET
        description: Get comment by rrn
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: rrn
          in: path
          type: string
          description: Return a comment with this rrn.
          required: true
      - name: deletecomment
        method: DELETE
        description: Delete a comment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: rrn
          in: path
          type: string
          description: The RRN of the comment.
          required: true
  exposes:
  - type: rest
    namespace: insightidr-comments-rest
    port: 8080
    description: REST adapter for InsightIDR API — Comments. One resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/idr/v1/comments/{rrn}/{visibility}
      name: idr-v1-comments-rrn-visibility
      description: REST surface for idr-v1-comments-rrn-visibility.
      operations:
      - method: PUT
        name: updatecomment
        description: Update comment visibility
        call: insightidr-comments.updatecomment
        with:
          rrn: rest.rrn
          visibility: rest.visibility
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/idr/v1/comments
      name: idr-v1-comments
      description: REST surface for idr-v1-comments.
      operations:
      - method: GET
        name: listcomments
        description: List comments
        call: insightidr-comments.listcomments
        with:
          target: rest.target
          index: rest.index
          size: rest.size
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcomment
        description: Create comment
        call: insightidr-comments.createcomment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/idr/v1/comments/{rrn}
      name: idr-v1-comments-rrn
      description: REST surface for idr-v1-comments-rrn.
      operations:
      - method: GET
        name: getcomment
        description: Get comment by rrn
        call: insightidr-comments.getcomment
        with:
          rrn: rest.rrn
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecomment
        description: Delete a comment
        call: insightidr-comments.deletecomment
        with:
          rrn: rest.rrn
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: insightidr-comments-mcp
    port: 9090
    transport: http
    description: MCP adapter for InsightIDR API — Comments. One tool per consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: rapid7-updatecomment
      description: Update comment visibility
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: insightidr-comments.updatecomment
      with:
        rrn: tools.rrn
        visibility: tools.visibility
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-listcomments
      description: List comments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: insightidr-comments.listcomments
      with:
        target: tools.target
        index: tools.index
        size: tools.size
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-createcomment
      description: Create comment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: insightidr-comments.createcomment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-getcomment
      description: Get comment by rrn
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: insightidr-comments.getcomment
      with:
        rrn: tools.rrn
      outputParameters:
      - type: object
        mapping: $.
    - name: rapid7-deletecomment
      description: Delete a comment
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: insightidr-comments.deletecomment
      with:
        rrn: tools.rrn
      outputParameters:
      - type: object
        mapping: $.