Get Bubble Details Tool

Provides detailed information about a specific bubble, including schema, parameters, and documentation

Quick Start

import { GetBubbleDetailsTool } from '@bubblelab/bubble-core';
const result = await new GetBubbleDetailsTool({

  bubbleName: 'example', // The name of the bubble to get details about
}).action();

Operation Details

execute

Input Schema

bubbleName string required

The name of the bubble to get details about

includeInputSchema boolean

Include input parameter schema in the response

credentials Record<CredentialType,string>

Object mapping credential types to values (injected at runtime)

Output Schema

name string required

Name of the bubble

alias string

Short alias for the bubble

inputSchema string

String representation of the input parameter schema types

outputSchema string required

String representation of the output schema types

usageExample string required

Code example showing how to use the bubble

success boolean required

Whether the operation was successful

error string required

Error message if operation failed