Signpost AI Logo
WorkersDebug

Tooltip

📸 Screenshots

Here are visual examples of this section:

Tooltip - Worker Configuration Interface Tooltip - Worker Configuration Interface

1. Overview and Purpose

The Tooltip worker provides a way to add notes and documentation directly to your workflow. It serves as a visual annotation tool that doesn't execute any processing logic but helps organize and document your flow for better understanding and maintenance.

2. Configuration Parameters

The Worker accepts the following parameters:

  • notes: Optional text field for adding documentation, comments, or explanatory notes to your workflow

3. Input/Output Handles

This worker does not have input or output handles as it serves purely as a documentation tool.

4. Usage Examples with Code

// Create a tooltip worker for documentation
const tooltipWorker = agent.initializeWorker(
  { type: "tooltip" },
  [],
  tooltip
);

// Configure with notes
tooltipWorker.parameters = {
  notes: "This section processes user authentication data"
};

5. Integration Examples

Use Tooltip workers throughout your workflow to document complex logic sections, mark important decision points, or provide context for other team members reviewing the flow.

6. Best Practices

  • Place tooltips near complex worker configurations to explain their purpose
  • Use clear, concise language in your notes for maximum readability
  • Consider using tooltips to mark different phases or sections of your workflow
  • Update tooltip notes when workflow logic changes to maintain accuracy

7. Troubleshooting Tips

  • Tooltip workers don't affect workflow execution, so they won't cause processing errors
  • If tooltips aren't displaying properly, check that the notes parameter contains valid text
  • Remember that tooltips are for documentation only and won't pass data between workers
  • Use tooltips liberally as they don't impact performance or execution time