ToolResponseDtoSuccessResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/flowra-dev/json-schema/flowra-dev-tool-response-dto-success-response-schema.json",
  "title": "ToolResponseDtoSuccessResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/flowra-dev-tools-api-openapi.yml#/components/schemas/ToolResponseDtoSuccessResponse",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "Success status"
    },
    "message": {
      "type": "string",
      "description": "Success message"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Tool UUID"
        },
        "slug": {
          "type": "string",
          "description": "Stable tool slug used in execute and agent tool lists"
        },
        "name": {
          "type": "string",
          "description": "Display name"
        },
        "description": {
          "type": "string",
          "description": "What the tool does"
        },
        "instructions": {
          "type": "string",
          "description": "Instructions for when an agent should call this tool"
        },
        "toolkitSlug": {
          "type": "string",
          "description": "Parent toolkit slug"
        },
        "inputParameters": {
          "type": "object",
          "description": "JSON Schema for arguments"
        },
        "outputParameters": {
          "type": "object",
          "description": "JSON Schema for the result"
        },
        "noAuth": {
          "type": "boolean",
          "description": "True when the tool can run without a connected account"
        },
        "availableVersions": {
          "description": "Published versions",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "version": {
          "type": "string",
          "description": "Current version"
        },
        "scopes": {
          "description": "Required scopes",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "tags": {
          "description": "Tags",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "isImportant": {
          "type": "boolean",
          "description": "Highlighted in pickers"
        },
        "isDeprecated": {
          "type": "boolean",
          "description": "Marked deprecated in the catalog"
        },
        "isDisabled": {
          "type": "boolean",
          "description": "Disabled tools cannot be executed"
        },
        "popularityScore": {
          "type": "number",
          "description": "Relative popularity score"
        },
        "provider": {
          "enum": [
            "COMPOSIO",
            "LOCAL"
          ],
          "type": "string"
        },
        "type": {
          "enum": [
            "action",
            "poll",
            "webhook"
          ],
          "type": "string"
        },
        "ragContentHash": {
          "type": "string"
        },
        "ragSyncedAt": {
          "format": "date-time",
          "type": "string"
        },
        "createdAt": {
          "format": "date-time",
          "type": "string"
        },
        "updatedAt": {
          "format": "date-time",
          "type": "string"
        },
        "fieldModifiers": {
          "type": "object"
        },
        "script": {
          "type": [
            "string",
            "null"
          ],
          "description": "Custom script for this tool when set (language and source code).",
          "enum": [
            "javascript",
            "python",
            null
          ]
        },
        "executionCreditCost": {
          "type": [
            "number",
            "null"
          ],
          "description": "Credits charged per successful execution. Null = platform default. Visible to admins only."
        }
      },
      "required": [
        "id",
        "slug",
        "name",
        "description",
        "instructions",
        "toolkitSlug",
        "inputParameters",
        "outputParameters",
        "noAuth",
        "availableVersions",
        "version",
        "scopes",
        "tags",
        "isImportant",
        "isDeprecated",
        "isDisabled",
        "popularityScore",
        "provider",
        "type",
        "ragContentHash",
        "ragSyncedAt",
        "createdAt",
        "updatedAt",
        "fieldModifiers"
      ]
    }
  },
  "required": [
    "success",
    "message",
    "data"
  ]
}