> 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/create-remediation-note.md).

# Create Remediation Note

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

Adds a remediation note to an existing AttackForge vulnerability. A remediation note is a timestamped, authored comment recording remediation progress, guidance, or discussion for a single vulnerability. This is a **write** operation: it persists a new remediation note against the vulnerability.

The shape of `args` is declared inline (see Building args for Write Tools), so no preparatory call is needed. `note` is a rich-text field and must use the AttackForge richtext format described in the `richtext_format` block returned by `get_args_schema_for_tool`.

Preconditions: the caller must have access to at least one project the vulnerability is linked to. On success the new remediation note 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 `create_remediation_note` and click `Add`

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

* *Add a remediation note to vulnerability X saying the vendor patch has been applied.*
* *Record on this finding that the risk has been accepted by the business owner.*
* *Note on vulnerability X that remediation is blocked pending a change window.*

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

| Parameter | Type   | Required | Description                                                 |
| --------- | ------ | -------- | ----------------------------------------------------------- |
| `args`    | object | Yes      | The remediation-note-creation payload - see the keys below. |

**`args` keys:**

| Key                | Type   | Required | Description                                                                                  |
| ------------------ | ------ | -------- | -------------------------------------------------------------------------------------------- |
| `vulnerability_id` | string | Yes      | Id (24-hex) of the vulnerability the note is being added to. Source: `find_vulnerabilities`. |
| `note`             | string | Yes      | The note content. Rich-text - use the AttackForge richtext format.                           |

#### Example Response

```json
{
  "id": "6981b0c4a1d3e45f77c20981"
}
```


---

# 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/create-remediation-note.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.