Get Args Schema For Tool

Description

Returns the JSON Schema that validates the args property of a mutation tool, together with the AttackForge richtext format spec whenever that schema contains rich-text fields.

Whether you need this call depends on the tool. For the dynamic-shape tools the shape of args 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 remaining mutation tools declare args inline in their own input schema, so building a payload for them needs no preparatory call; request one of those here only to obtain its richtext_format block.

The returned schema is the same one the server uses for validation, so any payload that satisfies it will pass server-side validation. Tenant config can change between sessions; do not cache results across conversations.

See Building args 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?

• What richtext format should I use for a remediation note?

Parameters

Parameter	Type	Required	Description
tool	string	Yes	The mutation tool whose args schema you need. Must be one of the values listed below - read-only tools have static schemas and are not valid here.

Dynamic-shape tools (you MUST call this before building args):

create_project                  create_project_request        create_vulnerability
create_writeup                  patch_project                 patch_project_request
patch_project_reporting_fields  patch_project_scope           patch_project_summary_fields
patch_vulnerability             patch_writeup

Inline-schema tools (accepted here, but only needed to fetch richtext_format):

archive_group                            archive_project
create_abuse_case                        create_group
create_project_testcase_note             create_project_testcase_workspace_note
create_remediation_note                  create_testcase
create_testsuite                         create_user
delete_user                              patch_group
patch_group_member_admins                patch_group_members
patch_group_project_requests             patch_project_groups
patch_project_member_admins              patch_project_members
patch_project_portfolio_streams          patch_project_testcase
patch_project_testcase_note              patch_project_testcase_workspace_note
patch_remediation_note                   patch_testcase
patch_testsuite                          patch_user
restore_group                            restore_project
restore_user                             update_project_testcase_lock
update_vulnerability_status

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>"
  }
}