> 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/get-args-schema-for-tool.md).

# Get Args Schema For Tool

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

Returns the JSON Schema that validates the `args` property of a dynamic-shape mutation tool. The shape of `args` for the `create_*` / `patch_*` tools is configured per tenant (custom fields, optional features, role-based access overrides) and cannot be hard-coded - you MUST call this tool first, then build `args` to match the returned schema before invoking the target tool.

The returned schema is the same one the server uses for validation, so any payload that satisfies it will pass server-side validation. Where the schema includes rich-text fields, a `richtext_format` block is returned describing the required AttackForge richtext format. Tenant config can change between sessions; do not cache results across conversations.

See Two-Step Workflow for Write Tools on the *Working with the Tools* page.

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

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

* *What fields do I need to create a vulnerability?*
* *Show me the schema for creating a project.*
* *What does the payload for patching a writeup look like?*
* *Which fields are required to create a project request?*

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

| Parameter | Type   | Required | Description                                                                                                                                                                                                                                                                                                                     |
| --------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `tool`    | string | Yes      | The dynamic-shape mutation tool whose `args` schema you need. One of `create_project`, `create_project_request`, `create_vulnerability`, `create_writeup`, `patch_project`, `patch_project_request`, `patch_project_scope`, `patch_vulnerability`, `patch_writeup`. Read-only tools have static schemas and are not valid here. |

#### Example Response

```json
{
  "tool": "create_vulnerability",
  "schema": {
    "type": "object",
    "properties": {
      "project_id": {
        "type": "string",
        "pattern": "^[0-9a-fA-F]{24}$"
      },
      "writeup_id": {
        "type": "string",
        "pattern": "^[0-9a-fA-F]{24}$"
      },
      "priority": {
        "enum": [
          "Critical",
          "High",
          "Medium",
          "Low",
          "Info"
        ]
      },
      "steps_to_reproduce": {
        "type": "string"
      },
      "custom_fields": {
        "type": "array"
      }
    },
    "required": [
      "project_id",
      "writeup_id"
    ],
    "additionalProperties": false
  },
  "richtext_format": {
    "description": "Rich-text fields accept AttackForge richtext markup. Embedded files are referenced using {{{filename.png}}} placeholders.",
    "example": "&lt;p&gt;Run the tool and observe the result:&lt;/p&gt;&lt;p&gt;{{{evidence.png}}}&lt;/p&gt;"
  }
}
```


---

# 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/get-args-schema-for-tool.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.