Get Args Schema For Tool

Description

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

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

• 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

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

{
  "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": "<p>Run the tool and observe the result:</p><p>{{{evidence.png}}}</p>"
  }
}