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

Find Project Reporting Fields

Description

Reads the reporting field values - the executive summary and the reporting custom fields - for AttackForge projects matching the optional filter. Use this to retrieve the reporting content of one or more projects; call get_field_structure(model="project-reporting") first to discover the reporting custom-field keys you can request.

There is no count_* variant for reporting fields. Results are automatically scoped to projects the calling user can access (non-admin users only see projects they have membership in), and the executive summary and reporting custom fields are additionally gated per project by the user's access to that project's reports - a project the user cannot access reports 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_reporting_fields and click Add

Example Prompts

  • Show me the executive summary for project X.

  • What reporting fields are set on the ACME project?

  • List the executive summaries for all completed projects.

  • Show me the report classification custom field on project X.

  • Get the reporting 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 executive summary and reporting custom fields returned by this tool are not filterable. Supported fields are listed below.

fields

array

No

System fields to include on each project (id is always returned). Allowed values: id, executive_summary.

custom_field_keys

array

No

Reporting custom field keys to include in each project's custom_fields array. Discover keys via get_field_structure(model="project-reporting"). 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.

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 reporting custom fields

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

Example Response

Last updated