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

Find Project Summary Fields

Description

Reads the project summary field values - the custom fields that make up a project's summary page - for AttackForge projects matching the optional filter. Use this to retrieve the content of the project summary page; call get_field_structure(model="project-summary") first to discover the summary custom-field keys you can request.

There is no count_* variant for summary fields. Results are automatically scoped to projects the calling user can access (non-admin users only see projects they have membership in), and the summary custom fields are additionally gated per project by the user's access to that project's summary page - a project the user cannot access the summary page for still appears in the results, but with those values omitted. Results are paginated (default 10 per page, max 50).

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 find_project_summary_fields and click Add

Example Prompts

  • What's on the summary page for project X?

  • Show me the summary fields for the ACME project.

  • List the engagement outcome summary field across all completed projects.

  • Get the project summary content for projects in Testing status.

Parameters

Parameter
Type
Required
Description

filter

object

No

A MongoDB-style filter on the project's own attributes (the same fields as find_projects). The summary custom fields returned by this tool are not filterable. Supported fields are listed below.

custom_field_keys

array

No

Summary custom field keys to include in each project's custom_fields array. Discover keys via get_field_structure(model="project-summary"). Omit to return no custom fields.

limit

integer

No

Maximum records to return in this page. Default 10, max 50.

skip

integer

No

Number of records to skip (offset). Default 0.

The project summary page carries only custom fields, so there is no fields parameter - each returned record is an id plus the requested custom_fields.

Supported filter fields:

Field
Type / Values

id

ObjectId('<24 hex>')

created, modified

ISO-8601 datetime

name, code

string

start_date, end_date

ISO-8601 datetime

status

one of 'Waiting to Start', 'Testing', 'On Hold', 'Overrun', 'Completed', 'Retest'

organization_code

string

vuln_code

string

attack_chains_enabled

boolean

reporting_enabled

boolean

retesting_enabled

boolean

summary_enabled

boolean

custom_tags

array of { name: string, value: string }

custom_fields

array of { key: string, value: string or array } - the project's own custom fields (from the Project form; discover via get_field_structure(model="project")), not the summary custom fields

The summary custom fields are omitted for any project the caller cannot access the summary page for; the project itself still appears in the results.

Example Response

Last updated