Windmill · Capability

Windmill API — group

Windmill API — group. 19 operations. Lead operation: Add User to Instance Group. Self-contained Naftiko capability covering one Windmill business surface.

Run with Naftiko Windmillgroup

What You Can Do

POST
Addusertoinstancegroup — Add User to Instance Group
/v1/groups/adduser/{name}
POST
Createinstancegroup — Create Instance Group
/v1/groups/create
DELETE
Deleteinstancegroup — Delete Instance Group
/v1/groups/delete/{name}
GET
Exportinstancegroups — Export Instance Groups
/v1/groups/export
GET
Getinstancegroup — Get Instance Group
/v1/groups/get/{name}
GET
Listinstancegroups — List Instance Groups
/v1/groups/list
GET
Listinstancegroupswithworkspaces — List Instance Groups with Workspace Information
/v1/groups/list-with-workspaces
POST
Overwriteinstancegroups — Overwrite Instance Groups
/v1/groups/overwrite
POST
Removeuserfrominstancegroup — Remove User from Instance Group
/v1/groups/removeuser/{name}
POST
Updateinstancegroup — Update Instance Group
/v1/groups/update/{name}
POST
Addusertogroup — Add User to Group
/v1/w/{workspace}/groups/adduser/{name}
POST
Creategroup — Create Group
/v1/w/{workspace}/groups/create
DELETE
Deletegroup — Delete Group
/v1/w/{workspace}/groups/delete/{name}
GET
Getgroup — Get Group
/v1/w/{workspace}/groups/get/{name}
GET
Listgroups — List Groups
/v1/w/{workspace}/groups/list
GET
Listgroupnames — List Group Names
/v1/w/{workspace}/groups/listnames
POST
Removeusertogroup — Remove User to Group
/v1/w/{workspace}/groups/removeuser/{name}
POST
Updategroup — Update Group
/v1/w/{workspace}/groups/update/{name}
GET
Getgrouppermissionhistory — Get Group Permission History
/v1/w/{workspace}/groups-history/get/{name}

MCP Tools

add-user-instance-group

Add User to Instance Group

create-instance-group

Create Instance Group

delete-instance-group

Delete Instance Group

idempotent
export-instance-groups

Export Instance Groups

read-only idempotent
get-instance-group

Get Instance Group

read-only idempotent
list-instance-groups

List Instance Groups

read-only idempotent
list-instance-groups-workspace-information

List Instance Groups with Workspace Information

read-only idempotent
overwrite-instance-groups

Overwrite Instance Groups

remove-user-instance-group

Remove User from Instance Group

update-instance-group

Update Instance Group

add-user-group

Add User to Group

create-group

Create Group

delete-group

Delete Group

idempotent
get-group

Get Group

read-only idempotent
list-groups

List Groups

read-only idempotent
list-group-names

List Group Names

read-only idempotent
remove-user-group

Remove User to Group

update-group

Update Group

get-group-permission-history

Get Group Permission History

read-only idempotent

Capability Spec

windmill-group.yaml Raw ↑ 
naftiko: 1.0.0-alpha2
info:
  label: Windmill API — group
  description: 'Windmill API — group. 19 operations. Lead operation: Add User to Instance Group. Self-contained Naftiko capability
    covering one Windmill business surface.'
  tags:
  - Windmill
  - group
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WINDMILL_API_KEY: WINDMILL_API_KEY
capability:
  consumes:
  - type: http
    namespace: windmill-group
    baseUri: ''
    description: Windmill API — group business capability. Self-contained, no shared references.
    resources:
    - name: groups-adduser-name
      path: /groups/adduser/{name}
      operations:
      - name: addusertoinstancegroup
        method: POST
        description: Add User to Instance Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: groups-create
      path: /groups/create
      operations:
      - name: createinstancegroup
        method: POST
        description: Create Instance Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: groups-delete-name
      path: /groups/delete/{name}
      operations:
      - name: deleteinstancegroup
        method: DELETE
        description: Delete Instance Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-export
      path: /groups/export
      operations:
      - name: exportinstancegroups
        method: GET
        description: Export Instance Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-get-name
      path: /groups/get/{name}
      operations:
      - name: getinstancegroup
        method: GET
        description: Get Instance Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-list
      path: /groups/list
      operations:
      - name: listinstancegroups
        method: GET
        description: List Instance Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-list_with_workspaces
      path: /groups/list_with_workspaces
      operations:
      - name: listinstancegroupswithworkspaces
        method: GET
        description: List Instance Groups with Workspace Information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-overwrite
      path: /groups/overwrite
      operations:
      - name: overwriteinstancegroups
        method: POST
        description: Overwrite Instance Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: groups-removeuser-name
      path: /groups/removeuser/{name}
      operations:
      - name: removeuserfrominstancegroup
        method: POST
        description: Remove User from Instance Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: groups-update-name
      path: /groups/update/{name}
      operations:
      - name: updateinstancegroup
        method: POST
        description: Update Instance Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: w-workspace-groups-adduser-name
      path: /w/{workspace}/groups/adduser/{name}
      operations:
      - name: addusertogroup
        method: POST
        description: Add User to Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: w-workspace-groups-create
      path: /w/{workspace}/groups/create
      operations:
      - name: creategroup
        method: POST
        description: Create Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: w-workspace-groups-delete-name
      path: /w/{workspace}/groups/delete/{name}
      operations:
      - name: deletegroup
        method: DELETE
        description: Delete Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-groups-get-name
      path: /w/{workspace}/groups/get/{name}
      operations:
      - name: getgroup
        method: GET
        description: Get Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-groups-list
      path: /w/{workspace}/groups/list
      operations:
      - name: listgroups
        method: GET
        description: List Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-groups-listnames
      path: /w/{workspace}/groups/listnames
      operations:
      - name: listgroupnames
        method: GET
        description: List Group Names
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: only_member_of
          in: query
          type: boolean
          description: only list the groups the user is member of (default false)
    - name: w-workspace-groups-removeuser-name
      path: /w/{workspace}/groups/removeuser/{name}
      operations:
      - name: removeusertogroup
        method: POST
        description: Remove User to Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: w-workspace-groups-update-name
      path: /w/{workspace}/groups/update/{name}
      operations:
      - name: updategroup
        method: POST
        description: Update Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: w-workspace-groups_history-get-name
      path: /w/{workspace}/groups_history/get/{name}
      operations:
      - name: getgrouppermissionhistory
        method: GET
        description: Get Group Permission History
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.WINDMILL_API_KEY}}'
  exposes:
  - type: rest
    namespace: windmill-group-rest
    port: 8080
    description: REST adapter for Windmill API — group. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/groups/adduser/{name}
      name: groups-adduser-name
      description: REST surface for groups-adduser-name.
      operations:
      - method: POST
        name: addusertoinstancegroup
        description: Add User to Instance Group
        call: windmill-group.addusertoinstancegroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/create
      name: groups-create
      description: REST surface for groups-create.
      operations:
      - method: POST
        name: createinstancegroup
        description: Create Instance Group
        call: windmill-group.createinstancegroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/delete/{name}
      name: groups-delete-name
      description: REST surface for groups-delete-name.
      operations:
      - method: DELETE
        name: deleteinstancegroup
        description: Delete Instance Group
        call: windmill-group.deleteinstancegroup
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/export
      name: groups-export
      description: REST surface for groups-export.
      operations:
      - method: GET
        name: exportinstancegroups
        description: Export Instance Groups
        call: windmill-group.exportinstancegroups
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/get/{name}
      name: groups-get-name
      description: REST surface for groups-get-name.
      operations:
      - method: GET
        name: getinstancegroup
        description: Get Instance Group
        call: windmill-group.getinstancegroup
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/list
      name: groups-list
      description: REST surface for groups-list.
      operations:
      - method: GET
        name: listinstancegroups
        description: List Instance Groups
        call: windmill-group.listinstancegroups
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/list-with-workspaces
      name: groups-list-with-workspaces
      description: REST surface for groups-list_with_workspaces.
      operations:
      - method: GET
        name: listinstancegroupswithworkspaces
        description: List Instance Groups with Workspace Information
        call: windmill-group.listinstancegroupswithworkspaces
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/overwrite
      name: groups-overwrite
      description: REST surface for groups-overwrite.
      operations:
      - method: POST
        name: overwriteinstancegroups
        description: Overwrite Instance Groups
        call: windmill-group.overwriteinstancegroups
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/removeuser/{name}
      name: groups-removeuser-name
      description: REST surface for groups-removeuser-name.
      operations:
      - method: POST
        name: removeuserfrominstancegroup
        description: Remove User from Instance Group
        call: windmill-group.removeuserfrominstancegroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/groups/update/{name}
      name: groups-update-name
      description: REST surface for groups-update-name.
      operations:
      - method: POST
        name: updateinstancegroup
        description: Update Instance Group
        call: windmill-group.updateinstancegroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/groups/adduser/{name}
      name: w-workspace-groups-adduser-name
      description: REST surface for w-workspace-groups-adduser-name.
      operations:
      - method: POST
        name: addusertogroup
        description: Add User to Group
        call: windmill-group.addusertogroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/groups/create
      name: w-workspace-groups-create
      description: REST surface for w-workspace-groups-create.
      operations:
      - method: POST
        name: creategroup
        description: Create Group
        call: windmill-group.creategroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/groups/delete/{name}
      name: w-workspace-groups-delete-name
      description: REST surface for w-workspace-groups-delete-name.
      operations:
      - method: DELETE
        name: deletegroup
        description: Delete Group
        call: windmill-group.deletegroup
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/groups/get/{name}
      name: w-workspace-groups-get-name
      description: REST surface for w-workspace-groups-get-name.
      operations:
      - method: GET
        name: getgroup
        description: Get Group
        call: windmill-group.getgroup
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/groups/list
      name: w-workspace-groups-list
      description: REST surface for w-workspace-groups-list.
      operations:
      - method: GET
        name: listgroups
        description: List Groups
        call: windmill-group.listgroups
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/groups/listnames
      name: w-workspace-groups-listnames
      description: REST surface for w-workspace-groups-listnames.
      operations:
      - method: GET
        name: listgroupnames
        description: List Group Names
        call: windmill-group.listgroupnames
        with:
          only_member_of: rest.only_member_of
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/groups/removeuser/{name}
      name: w-workspace-groups-removeuser-name
      description: REST surface for w-workspace-groups-removeuser-name.
      operations:
      - method: POST
        name: removeusertogroup
        description: Remove User to Group
        call: windmill-group.removeusertogroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/groups/update/{name}
      name: w-workspace-groups-update-name
      description: REST surface for w-workspace-groups-update-name.
      operations:
      - method: POST
        name: updategroup
        description: Update Group
        call: windmill-group.updategroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/groups-history/get/{name}
      name: w-workspace-groups-history-get-name
      description: REST surface for w-workspace-groups_history-get-name.
      operations:
      - method: GET
        name: getgrouppermissionhistory
        description: Get Group Permission History
        call: windmill-group.getgrouppermissionhistory
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: windmill-group-mcp
    port: 9090
    transport: http
    description: MCP adapter for Windmill API — group. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: add-user-instance-group
      description: Add User to Instance Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-group.addusertoinstancegroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: create-instance-group
      description: Create Instance Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-group.createinstancegroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-instance-group
      description: Delete Instance Group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: windmill-group.deleteinstancegroup
      outputParameters:
      - type: object
        mapping: $.
    - name: export-instance-groups
      description: Export Instance Groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-group.exportinstancegroups
      outputParameters:
      - type: object
        mapping: $.
    - name: get-instance-group
      description: Get Instance Group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-group.getinstancegroup
      outputParameters:
      - type: object
        mapping: $.
    - name: list-instance-groups
      description: List Instance Groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-group.listinstancegroups
      outputParameters:
      - type: object
        mapping: $.
    - name: list-instance-groups-workspace-information
      description: List Instance Groups with Workspace Information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-group.listinstancegroupswithworkspaces
      outputParameters:
      - type: object
        mapping: $.
    - name: overwrite-instance-groups
      description: Overwrite Instance Groups
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-group.overwriteinstancegroups
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-user-instance-group
      description: Remove User from Instance Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-group.removeuserfrominstancegroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-instance-group
      description: Update Instance Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-group.updateinstancegroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: add-user-group
      description: Add User to Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-group.addusertogroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: create-group
      description: Create Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-group.creategroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-group
      description: Delete Group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: windmill-group.deletegroup
      outputParameters:
      - type: object
        mapping: $.
    - name: get-group
      description: Get Group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-group.getgroup
      outputParameters:
      - type: object
        mapping: $.
    - name: list-groups
      description: List Groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-group.listgroups
      outputParameters:
      - type: object
        mapping: $.
    - name: list-group-names
      description: List Group Names
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-group.listgroupnames
      with:
        only_member_of: tools.only_member_of
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-user-group
      description: Remove User to Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-group.removeusertogroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-group
      description: Update Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-group.updategroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-group-permission-history
      description: Get Group Permission History
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-group.getgrouppermissionhistory
      outputParameters:
      - type: object
        mapping: $.