Perforce Helix Swarm API — Comments

naftiko: 1.0.0-alpha2
info:
  label: Perforce Helix Swarm API — Comments
  description: 'Perforce Helix Swarm API — Comments. 4 operations. Lead operation: Perforce List Comments. Self-contained
    Naftiko capability covering one Perforce business surface.'
  tags:
  - Perforce
  - Comments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PERFORCE_API_KEY: PERFORCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: helix-swarm-comments
    baseUri: ''
    description: Perforce Helix Swarm API — Comments business capability. Self-contained, no shared references.
    resources:
    - name: comments
      path: /comments/
      operations:
      - name: listcomments
        method: GET
        description: Perforce List Comments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: after
          in: query
          type: integer
          description: A comment ID to seek past for pagination.
        - name: max
          in: query
          type: integer
          description: Maximum number of comments to return. Defaults to 100.
        - name: topic
          in: query
          type: string
          description: Filter comments by topic, such as reviews/1234 for a specific review.
        - name: context[version]
          in: query
          type: integer
          description: Filter by a specific review version.
        - name: ignoreArchived
          in: query
          type: boolean
          description: Exclude comments on archived reviews.
        - name: tasksOnly
          in: query
          type: boolean
          description: Return only comments flagged as tasks.
        - name: taskStates
          in: query
          type: array
          description: Filter by task state. Valid values include open, closed, verified, and comment.
        - name: fields
          in: query
          type: string
          description: Comma-separated list of fields to include in the response.
      - name: createcomment
        method: POST
        description: Perforce Add a Comment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: comments-notify
      path: /comments/notify
      operations:
      - name: sendcommentnotification
        method: POST
        description: Perforce Send Comment Notification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: comments-id
      path: /comments/{id}
      operations:
      - name: editcomment
        method: PATCH
        description: Perforce Edit a Comment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: The comment ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: basic
      username: '{{env.PERFORCE_USER}}'
      password: '{{env.PERFORCE_PASS}}'
  exposes:
  - type: rest
    namespace: helix-swarm-comments-rest
    port: 8080
    description: REST adapter for Perforce Helix Swarm API — Comments. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/comments
      name: comments
      description: REST surface for comments.
      operations:
      - method: GET
        name: listcomments
        description: Perforce List Comments
        call: helix-swarm-comments.listcomments
        with:
          after: rest.after
          max: rest.max
          topic: rest.topic
          context[version]: rest.context[version]
          ignoreArchived: rest.ignoreArchived
          tasksOnly: rest.tasksOnly
          taskStates: rest.taskStates
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcomment
        description: Perforce Add a Comment
        call: helix-swarm-comments.createcomment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/comments/notify
      name: comments-notify
      description: REST surface for comments-notify.
      operations:
      - method: POST
        name: sendcommentnotification
        description: Perforce Send Comment Notification
        call: helix-swarm-comments.sendcommentnotification
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/comments/{id}
      name: comments-id
      description: REST surface for comments-id.
      operations:
      - method: PATCH
        name: editcomment
        description: Perforce Edit a Comment
        call: helix-swarm-comments.editcomment
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: helix-swarm-comments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Perforce Helix Swarm API — Comments. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: perforce-list-comments
      description: Perforce List Comments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: helix-swarm-comments.listcomments
      with:
        after: tools.after
        max: tools.max
        topic: tools.topic
        context[version]: tools.context[version]
        ignoreArchived: tools.ignoreArchived
        tasksOnly: tools.tasksOnly
        taskStates: tools.taskStates
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: perforce-add-comment
      description: Perforce Add a Comment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: helix-swarm-comments.createcomment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: perforce-send-comment-notification
      description: Perforce Send Comment Notification
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: helix-swarm-comments.sendcommentnotification
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: perforce-edit-comment
      description: Perforce Edit a Comment
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: helix-swarm-comments.editcomment
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.