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

Patch Project Reporting Fields

Description

Partially updates the reporting fields - the executive summary and reporting custom fields - of an existing AttackForge project. This is the write counterpart to find_project_reporting_fields, and a write operation: only the keys present in args are modified - keys you omit are left untouched.

A two-step workflow is required because the input shape is tenant-specific - see Building args for Write Tools:

  1. Call get_args_schema_for_tool(tool="patch_project_reporting_fields") to retrieve the current JSON Schema for args (it also returns the richtext_format spec, because the executive summary is a rich-text field).

  2. Build args to match that schema and call this tool.

The schema always requires project_id (source: find_projects or find_project_reporting_fields) plus at least one of executive_summary or custom_fields. Discover the reporting custom-field keys with get_field_structure(model="project-reporting"). Preconditions: the caller must have Edit access to the target project and access to its reports; reporting custom fields are additionally gated per field by the caller's edit access (view-only keys are silently ignored). On success the project 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 patch_project_reporting_fields and click Add

Example Prompts

  • Update the executive summary of the ACME project.

  • Rewrite the executive summary for project X to include the retest outcome.

  • Set the report classification custom field on project X to Confidential.

  • Fill in the reporting fields for this project.

Parameters

Parameter
Type
Required
Description

args

object

Yes

The reporting-fields patch payload. Build it to satisfy get_args_schema_for_tool(tool="patch_project_reporting_fields"). Always requires project_id plus at least one of executive_summary / custom_fields; every supplied key applies a partial update. Any rich-text field (e.g. executive_summary) must use the AttackForge richtext format from the richtext_format block.

Example Response

Last updated