Atlassian The Jira Cloud platform REST API — Issue Comments

naftiko: 1.0.0-alpha2
info:
  label: Atlassian The Jira Cloud platform REST API — Issue Comments
  description: 'Atlassian The Jira Cloud platform REST API — Issue Comments. 6 operations. Lead operation: Atlassian Get Comments
    By Ids. Self-contained Naftiko capability covering one Atlassian business surface.'
  tags:
  - Atlassian
  - Issue Comments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ATLASSIAN_API_KEY: ATLASSIAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: jira-issue-comments
    baseUri: https://your-domain.atlassian.net
    description: Atlassian The Jira Cloud platform REST API — Issue Comments business capability. Self-contained, no shared
      references.
    resources:
    - name: rest-api-3-comment-list
      path: /rest/api/3/comment/list
      operations:
      - name: atlassiangetcommentsbyids
        method: POST
        description: Atlassian Get Comments By Ids
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: expand
          in: query
          type: string
          description: Use [expand](#expansion) to include additional information about comments in the response. This parameter
            accepts a comma-separated list. Expand options include
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-issue-issueIdOrKey-comment
      path: /rest/api/3/issue/{issueIdOrKey}/comment
      operations:
      - name: atlassiangetcomments
        method: GET
        description: Atlassian Get Comments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: issueIdOrKey
          in: path
          type: string
          description: The ID or key of the issue.
          required: true
        - name: startAt
          in: query
          type: integer
          description: The index of the first item to return in a page of results (page offset).
        - name: maxResults
          in: query
          type: integer
          description: The maximum number of items to return per page.
        - name: orderBy
          in: query
          type: string
          description: '[Order](#ordering) the results by a field. Accepts *created* to sort comments by their created date.'
        - name: expand
          in: query
          type: string
          description: Use [expand](#expansion) to include additional information about comments in the response. This parameter
            accepts `renderedBody`, which returns the comment body
      - name: atlassianaddcomment
        method: POST
        description: Atlassian Add Comment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: issueIdOrKey
          in: path
          type: string
          description: The ID or key of the issue.
          required: true
        - name: expand
          in: query
          type: string
          description: Use [expand](#expansion) to include additional information about comments in the response. This parameter
            accepts `renderedBody`, which returns the comment body
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-issue-issueIdOrKey-comment-id
      path: /rest/api/3/issue/{issueIdOrKey}/comment/{id}
      operations:
      - name: atlassiandeletecomment
        method: DELETE
        description: Atlassian Delete Comment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: issueIdOrKey
          in: path
          type: string
          description: The ID or key of the issue.
          required: true
        - name: id
          in: path
          type: string
          description: The ID of the comment.
          required: true
      - name: atlassiangetcomment
        method: GET
        description: Atlassian Get Comment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: issueIdOrKey
          in: path
          type: string
          description: The ID or key of the issue.
          required: true
        - name: id
          in: path
          type: string
          description: The ID of the comment.
          required: true
        - name: expand
          in: query
          type: string
          description: Use [expand](#expansion) to include additional information about comments in the response. This parameter
            accepts `renderedBody`, which returns the comment body
      - name: atlassianupdatecomment
        method: PUT
        description: Atlassian Update Comment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: issueIdOrKey
          in: path
          type: string
          description: The ID or key of the issue.
          required: true
        - name: id
          in: path
          type: string
          description: The ID of the comment.
          required: true
        - name: notifyUsers
          in: query
          type: boolean
          description: Whether users are notified when a comment is updated.
        - name: overrideEditableFlag
          in: query
          type: boolean
          description: Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect
            app users with the *Administer Jira* [global permission](ht
        - name: expand
          in: query
          type: string
          description: Use [expand](#expansion) to include additional information about comments in the response. This parameter
            accepts `renderedBody`, which returns the comment body
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.ATLASSIAN_API_KEY}}'
  exposes:
  - type: rest
    namespace: jira-issue-comments-rest
    port: 8080
    description: REST adapter for Atlassian The Jira Cloud platform REST API — Issue Comments. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/3/comment/list
      name: rest-api-3-comment-list
      description: REST surface for rest-api-3-comment-list.
      operations:
      - method: POST
        name: atlassiangetcommentsbyids
        description: Atlassian Get Comments By Ids
        call: jira-issue-comments.atlassiangetcommentsbyids
        with:
          expand: rest.expand
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/issue/{issueidorkey}/comment
      name: rest-api-3-issue-issueidorkey-comment
      description: REST surface for rest-api-3-issue-issueIdOrKey-comment.
      operations:
      - method: GET
        name: atlassiangetcomments
        description: Atlassian Get Comments
        call: jira-issue-comments.atlassiangetcomments
        with:
          issueIdOrKey: rest.issueIdOrKey
          startAt: rest.startAt
          maxResults: rest.maxResults
          orderBy: rest.orderBy
          expand: rest.expand
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: atlassianaddcomment
        description: Atlassian Add Comment
        call: jira-issue-comments.atlassianaddcomment
        with:
          issueIdOrKey: rest.issueIdOrKey
          expand: rest.expand
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/issue/{issueidorkey}/comment/{id}
      name: rest-api-3-issue-issueidorkey-comment-id
      description: REST surface for rest-api-3-issue-issueIdOrKey-comment-id.
      operations:
      - method: DELETE
        name: atlassiandeletecomment
        description: Atlassian Delete Comment
        call: jira-issue-comments.atlassiandeletecomment
        with:
          issueIdOrKey: rest.issueIdOrKey
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: atlassiangetcomment
        description: Atlassian Get Comment
        call: jira-issue-comments.atlassiangetcomment
        with:
          issueIdOrKey: rest.issueIdOrKey
          id: rest.id
          expand: rest.expand
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: atlassianupdatecomment
        description: Atlassian Update Comment
        call: jira-issue-comments.atlassianupdatecomment
        with:
          issueIdOrKey: rest.issueIdOrKey
          id: rest.id
          notifyUsers: rest.notifyUsers
          overrideEditableFlag: rest.overrideEditableFlag
          expand: rest.expand
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: jira-issue-comments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Atlassian The Jira Cloud platform REST API — Issue Comments. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: atlassian-get-comments-ids
      description: Atlassian Get Comments By Ids
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: jira-issue-comments.atlassiangetcommentsbyids
      with:
        expand: tools.expand
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-comments
      description: Atlassian Get Comments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-issue-comments.atlassiangetcomments
      with:
        issueIdOrKey: tools.issueIdOrKey
        startAt: tools.startAt
        maxResults: tools.maxResults
        orderBy: tools.orderBy
        expand: tools.expand
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-add-comment
      description: Atlassian Add Comment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jira-issue-comments.atlassianaddcomment
      with:
        issueIdOrKey: tools.issueIdOrKey
        expand: tools.expand
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-delete-comment
      description: Atlassian Delete Comment
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jira-issue-comments.atlassiandeletecomment
      with:
        issueIdOrKey: tools.issueIdOrKey
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-comment
      description: Atlassian Get Comment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-issue-comments.atlassiangetcomment
      with:
        issueIdOrKey: tools.issueIdOrKey
        id: tools.id
        expand: tools.expand
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-update-comment
      description: Atlassian Update Comment
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: jira-issue-comments.atlassianupdatecomment
      with:
        issueIdOrKey: tools.issueIdOrKey
        id: tools.id
        notifyUsers: tools.notifyUsers
        overrideEditableFlag: tools.overrideEditableFlag
        expand: tools.expand
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.