> For the complete documentation index, see [llms.txt](https://support.attackforge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.attackforge.com/app/modules/ai-mcp-and-skills/patch-writeup.md).

# Patch Writeup

#### Description <a href="#description" id="description"></a>

Patches an existing AttackForge writeup (also called a writeup template). Only the fields supplied in `args` are changed; omitted fields are left untouched.

A two-step workflow is **required**:

1. Call `get_args_schema_for_tool(tool="patch_writeup")` to retrieve the current JSON Schema for `args`.
2. Build `args` to match that schema and call this tool.

The schema requires at minimum a writeup id (source: `find_writeups`). Preconditions: the caller needs Edit access to the writeup (and to the target library when moving it). Any rich-text field must use the AttackForge richtext format from the `richtext_format` block. On success the patched writeup id is returned.

#### How To Enable <a href="#how-to-enable" id="how-to-enable"></a>

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_writeup` and click `Add`

#### Example Prompts <a href="#example-prompts" id="example-prompts"></a>

* *Update the remediation recommendation on the XSS writeup.*
* *Change the severity of writeup X to 8.*
* *Move this writeup into the Main library.*
* *Add the "OWASP Top 10" tag to writeup X.*

#### Parameters <a href="#parameters" id="parameters"></a>

| Parameter | Type   | Required | Description                                                                                                                                                           |
| --------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `args`    | object | Yes      | The writeup-patch payload. Build it to satisfy `get_args_schema_for_tool(tool="patch_writeup")`. Requires at minimum a writeup id; other keys apply a partial update. |

#### Example Response

```json
{
  "id": "656168055d7035a12ade4cb3"
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://support.attackforge.com/app/modules/ai-mcp-and-skills/patch-writeup.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.