For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create Group

Description

Creates a new AttackForge Group. A group is a named set of users; linking a group to a project gives its members access to that project. This is a write operation: it persists a new, empty group record.

The shape of args is declared inline (see Building args for Write Tools), so no preparatory call is needed. Only name is required. Group names are not unique, so call find_groups first when a group of the same name may already exist.

The caller is not made a member of the new group, and no email is sent. The new group starts with enable_project_team_notifications on and auto_add_project_request off - change either with patch_group - and is linked to projects with patch_project_groups.

Preconditions: the caller must be an administrator, and the tenant must be within its group licence. On success the new group id is returned.

How To Enable

  1. Go to Users

  2. Select the user you would like to provide access to this tool

  3. Click on Access > MCP

  4. Click on Add Tools

  5. Select the tool create_group and click Add

Example Prompts

  • Create a group called Red Team.

  • Set up a group for the ACME contractors with Jane Smith as the primary contact.

  • Create a SOC group owned by Security Operations and put "EMEA" in the region custom field.

Parameters

Parameter
Type
Required
Description

args

object

Yes

The group-creation payload - see the keys below.

args keys:

Key
Type
Required
Description

name

string

Yes

The group name. Names are not unique, so check find_groups first to avoid creating a second group with the same name.

owner

string

No

Free-text owner recorded on the group, such as a team or business unit. It is a label only and grants nobody access.

primary_contact_email

string

No

Email address of the group's primary contact. It is recorded only; nothing is sent to it.

primary_contact_name

string

No

Name of the group's primary contact.

primary_contact_number

string

No

Phone number of the group's primary contact.

custom_fields

array

No

Custom field values, each { key, value }. Discover keys via get_field_structure(model="group"). Keys that are not in the configured field structure, or that are configured with edit access, are accepted.

Example Response

Last updated