MessageBird Contacts API — Groups

naftiko: 1.0.0-alpha2
info:
  label: MessageBird Contacts API — Groups
  description: 'MessageBird Contacts API — Groups. 9 operations. Lead operation: List groups for a contact. Self-contained
    Naftiko capability covering one Messagebird business surface.'
  tags:
  - Messagebird
  - Groups
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MESSAGEBIRD_API_KEY: MESSAGEBIRD_API_KEY
capability:
  consumes:
  - type: http
    namespace: contacts-groups
    baseUri: https://rest.messagebird.com
    description: MessageBird Contacts API — Groups business capability. Self-contained, no shared references.
    resources:
    - name: contacts-contactId-groups
      path: /contacts/{contactId}/groups
      operations:
      - name: listcontactgroups
        method: GET
        description: List groups for a contact
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups
      path: /groups
      operations:
      - name: listgroups
        method: GET
        description: List groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: creategroup
        method: POST
        description: Create a group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: groups-groupId
      path: /groups/{groupId}
      operations:
      - name: viewgroup
        method: GET
        description: View a group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updategroup
        method: PATCH
        description: Update a group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletegroup
        method: DELETE
        description: Delete a group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-groupId-contacts
      path: /groups/{groupId}/contacts
      operations:
      - name: listgroupcontacts
        method: GET
        description: List contacts in a group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: addcontactstogroup
        method: PUT
        description: Add contacts to a group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: groups-groupId-contacts-contactId
      path: /groups/{groupId}/contacts/{contactId}
      operations:
      - name: removecontactfromgroup
        method: DELETE
        description: Remove a contact from a group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.MESSAGEBIRD_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: contacts-groups-rest
    port: 8080
    description: REST adapter for MessageBird Contacts API — Groups. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/contacts/{contactid}/groups
      name: contacts-contactid-groups
      description: REST surface for contacts-contactId-groups.
      operations:
      - method: GET
        name: listcontactgroups
        description: List groups for a contact
        call: contacts-groups.listcontactgroups
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups
      name: groups
      description: REST surface for groups.
      operations:
      - method: GET
        name: listgroups
        description: List groups
        call: contacts-groups.listgroups
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: creategroup
        description: Create a group
        call: contacts-groups.creategroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{groupid}
      name: groups-groupid
      description: REST surface for groups-groupId.
      operations:
      - method: GET
        name: viewgroup
        description: View a group
        call: contacts-groups.viewgroup
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updategroup
        description: Update a group
        call: contacts-groups.updategroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletegroup
        description: Delete a group
        call: contacts-groups.deletegroup
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{groupid}/contacts
      name: groups-groupid-contacts
      description: REST surface for groups-groupId-contacts.
      operations:
      - method: GET
        name: listgroupcontacts
        description: List contacts in a group
        call: contacts-groups.listgroupcontacts
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: addcontactstogroup
        description: Add contacts to a group
        call: contacts-groups.addcontactstogroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/{groupid}/contacts/{contactid}
      name: groups-groupid-contacts-contactid
      description: REST surface for groups-groupId-contacts-contactId.
      operations:
      - method: DELETE
        name: removecontactfromgroup
        description: Remove a contact from a group
        call: contacts-groups.removecontactfromgroup
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: contacts-groups-mcp
    port: 9090
    transport: http
    description: MCP adapter for MessageBird Contacts API — Groups. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-groups-contact
      description: List groups for a contact
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: contacts-groups.listcontactgroups
      outputParameters:
      - type: object
        mapping: $.
    - name: list-groups
      description: List groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: contacts-groups.listgroups
      outputParameters:
      - type: object
        mapping: $.
    - name: create-group
      description: Create a group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: contacts-groups.creategroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: view-group
      description: View a group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: contacts-groups.viewgroup
      outputParameters:
      - type: object
        mapping: $.
    - name: update-group
      description: Update a group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: contacts-groups.updategroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-group
      description: Delete a group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: contacts-groups.deletegroup
      outputParameters:
      - type: object
        mapping: $.
    - name: list-contacts-group
      description: List contacts in a group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: contacts-groups.listgroupcontacts
      outputParameters:
      - type: object
        mapping: $.
    - name: add-contacts-group
      description: Add contacts to a group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: contacts-groups.addcontactstogroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-contact-group
      description: Remove a contact from a group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: contacts-groups.removecontactfromgroup
      outputParameters:
      - type: object
        mapping: $.