Skip to main content

SuccessResponse_McpToolDefinitionArray

successboolean
Constant value: true
data object[]
  • Array [
  • idinteger
    toolNamestring

    LLM-facing tool name shipped in tools/list, unique per organization.

    toolIdstring

    Operation slug; uniformly "endpoint" for external-API-sourced tools.

    sourceTypeMcpToolSourceType (string)

    Possible values: [datacluster, external_api]

    externalApiEndpointIdinteger | nullnullable
    clientClusterEndpointIdinteger | nullnullable
    summarystring | nullnullable
    descriptionstring | nullnullable
    mcpDescriptionstring

    The description shipped to LLM clients in tools/list.

    tagsstring[]
    requiredAbilitiesstring[]
    annotations object

    No keys beyond these five are accepted; an unknown key is rejected with a 422.

    readOnlyHintboolean
    destructiveHintboolean
    idempotentHintboolean
    openWorldHintboolean
    titlestring

    Human-readable display title shown by MCP clients alongside the snake_case toolName.

    Possible values: non-empty and <= 255 characters

    inputSchema object

    MCP inputSchema shape: the root must declare type: "object".

    typestringrequired
    Constant value: object
    propertiesobjectrequired
    requiredstring[]
    outputSchemaobject | nullnullable
    isEnabledboolean

    Newly-created tools (default-generated or single-endpoint) start disabled for review.

    isPublicboolean
    organizationIdinteger | nullnullable

    Null only for platform-global datacluster built-ins; always set for external-API tools.

    createdAtstring<date-time>
    updatedAtstring<date-time>
    deletedAtstring,null<date-time>nullable
  • ]
  • SuccessResponse_McpToolDefinitionArray
    {
    "success": true,
    "data": [
    {
    "id": 0,
    "toolName": "string",
    "toolId": "string",
    "sourceType": "datacluster",
    "externalApiEndpointId": 0,
    "clientClusterEndpointId": 0,
    "summary": "string",
    "description": "string",
    "mcpDescription": "string",
    "tags": [
    "string"
    ],
    "requiredAbilities": [
    "string"
    ],
    "annotations": {
    "readOnlyHint": true,
    "destructiveHint": true,
    "idempotentHint": true,
    "openWorldHint": true,
    "title": "string"
    },
    "inputSchema": {
    "type": "object",
    "properties": {},
    "required": [
    "string"
    ]
    },
    "outputSchema": "Unknown Type: object,null",
    "isEnabled": true,
    "isPublic": true,
    "organizationId": 0,
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z",
    "deletedAt": "2024-07-29T15:51:28.071Z"
    }
    ]
    }