FactSet IRN Notes API — Comments

naftiko: 1.0.0-alpha2
info:
  label: FactSet IRN Notes API — Comments
  description: 'FactSet IRN Notes API — Comments. 8 operations. Lead operation: Factset Get All Comments for a Note. Self-contained
    Naftiko capability covering one Factset business surface.'
  tags:
  - Factset
  - Comments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: irn-notes-comments
    baseUri: https://api.factset.com/research/irn
    description: FactSet IRN Notes API — Comments business capability. Self-contained, no shared references.
    resources:
    - name: v1-notes-noteId-comments
      path: /v1/notes/{noteId}/comments
      operations:
      - name: getcomments
        method: GET
        description: Factset Get All Comments for a Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: noteId
          in: path
          type: string
          required: true
      - name: createcomment
        method: POST
        description: Factset Create a Comment to a Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: noteId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-notes-noteId-comments-commentId
      path: /v1/notes/{noteId}/comments/{commentId}
      operations:
      - name: getcomment
        method: GET
        description: Factset Get Details of a Comment Belonging to a Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: noteId
          in: path
          type: string
          required: true
        - name: commentId
          in: path
          type: string
          required: true
      - name: patchcomment
        method: PATCH
        description: Factset Edit a Comment for a Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: noteId
          in: path
          type: string
          required: true
        - name: commentId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletecomment
        method: DELETE
        description: Factset Delete a Comment From a Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: noteId
          in: path
          type: string
          required: true
        - name: commentId
          in: path
          type: string
          required: true
    - name: v1-notes-noteId-comments-commentId-attachments
      path: /v1/notes/{noteId}/comments/{commentId}/attachments
      operations:
      - name: getcommentattachments
        method: GET
        description: Factset Get Attachments Summary of a Comment Belonging to a Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: noteId
          in: path
          type: string
          required: true
        - name: commentId
          in: path
          type: string
          required: true
      - name: createcommentattachment
        method: POST
        description: Factset Create a Comment Attachment to a Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: noteId
          in: path
          type: string
          required: true
        - name: commentId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-notes-noteId-comments-commentId-attachments-attachmentId-download
      path: /v1/notes/{noteId}/comments/{commentId}/attachments/{attachmentId}/download
      operations:
      - name: downloadcommentattachmentforcomment
        method: GET
        description: Factset Download Single Attachment Detail of a Comment Belonging to a Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: noteId
          in: path
          type: string
          required: true
        - name: commentId
          in: path
          type: string
          required: true
        - name: attachmentId
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.FACTSET_API_KEY}}'
  exposes:
  - type: rest
    namespace: irn-notes-comments-rest
    port: 8080
    description: REST adapter for FactSet IRN Notes API — Comments. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/notes/{noteid}/comments
      name: v1-notes-noteid-comments
      description: REST surface for v1-notes-noteId-comments.
      operations:
      - method: GET
        name: getcomments
        description: Factset Get All Comments for a Note
        call: irn-notes-comments.getcomments
        with:
          noteId: rest.noteId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcomment
        description: Factset Create a Comment to a Note
        call: irn-notes-comments.createcomment
        with:
          noteId: rest.noteId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/notes/{noteid}/comments/{commentid}
      name: v1-notes-noteid-comments-commentid
      description: REST surface for v1-notes-noteId-comments-commentId.
      operations:
      - method: GET
        name: getcomment
        description: Factset Get Details of a Comment Belonging to a Note
        call: irn-notes-comments.getcomment
        with:
          noteId: rest.noteId
          commentId: rest.commentId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchcomment
        description: Factset Edit a Comment for a Note
        call: irn-notes-comments.patchcomment
        with:
          noteId: rest.noteId
          commentId: rest.commentId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecomment
        description: Factset Delete a Comment From a Note
        call: irn-notes-comments.deletecomment
        with:
          noteId: rest.noteId
          commentId: rest.commentId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/notes/{noteid}/comments/{commentid}/attachments
      name: v1-notes-noteid-comments-commentid-attachments
      description: REST surface for v1-notes-noteId-comments-commentId-attachments.
      operations:
      - method: GET
        name: getcommentattachments
        description: Factset Get Attachments Summary of a Comment Belonging to a Note
        call: irn-notes-comments.getcommentattachments
        with:
          noteId: rest.noteId
          commentId: rest.commentId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcommentattachment
        description: Factset Create a Comment Attachment to a Note
        call: irn-notes-comments.createcommentattachment
        with:
          noteId: rest.noteId
          commentId: rest.commentId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/notes/{noteid}/comments/{commentid}/attachments/{attachmentid}/download
      name: v1-notes-noteid-comments-commentid-attachments-attachmentid-download
      description: REST surface for v1-notes-noteId-comments-commentId-attachments-attachmentId-download.
      operations:
      - method: GET
        name: downloadcommentattachmentforcomment
        description: Factset Download Single Attachment Detail of a Comment Belonging to a Note
        call: irn-notes-comments.downloadcommentattachmentforcomment
        with:
          noteId: rest.noteId
          commentId: rest.commentId
          attachmentId: rest.attachmentId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: irn-notes-comments-mcp
    port: 9090
    transport: http
    description: MCP adapter for FactSet IRN Notes API — Comments. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: factset-get-all-comments-note
      description: Factset Get All Comments for a Note
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-notes-comments.getcomments
      with:
        noteId: tools.noteId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-create-comment-note
      description: Factset Create a Comment to a Note
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: irn-notes-comments.createcomment
      with:
        noteId: tools.noteId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-details-comment-belonging
      description: Factset Get Details of a Comment Belonging to a Note
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-notes-comments.getcomment
      with:
        noteId: tools.noteId
        commentId: tools.commentId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-edit-comment-note
      description: Factset Edit a Comment for a Note
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: irn-notes-comments.patchcomment
      with:
        noteId: tools.noteId
        commentId: tools.commentId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-delete-comment-note
      description: Factset Delete a Comment From a Note
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: irn-notes-comments.deletecomment
      with:
        noteId: tools.noteId
        commentId: tools.commentId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-attachments-summary-comment
      description: Factset Get Attachments Summary of a Comment Belonging to a Note
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-notes-comments.getcommentattachments
      with:
        noteId: tools.noteId
        commentId: tools.commentId
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-create-comment-attachment-note
      description: Factset Create a Comment Attachment to a Note
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: irn-notes-comments.createcommentattachment
      with:
        noteId: tools.noteId
        commentId: tools.commentId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-download-single-attachment-detail
      description: Factset Download Single Attachment Detail of a Comment Belonging to a Note
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-notes-comments.downloadcommentattachmentforcomment
      with:
        noteId: tools.noteId
        commentId: tools.commentId
        attachmentId: tools.attachmentId
      outputParameters:
      - type: object
        mapping: $.