Built-in Tools

This page documents all the built-in tools available in Vertesia Studio for use with Agents.

Core Tools

Think Tool

A tool for deep thinking and analysis of complex problems. Useful for brainstorming and planning.

  • Name: think
  • Description: Think through a complex problem step by step
  • Parameters: Free-form thought process

Plan Tool

A tool for creating structured, executable plans with tracked progress.

  • Name: plan
  • Description: Create a detailed plan for accomplishing a task
  • Parameters: Planning details and steps

Update Plan Tool

A tool for updating task progress within a plan.

  • Name: update_plan
  • Description: Update multiple tasks in your active plan simultaneously with visual progress tracking. This tool works in conjunction with the plan tool to maintain live status updates on your tasks.
  • Parameters: Task updates with status changes and progress notes

Parallel Execution Tools

Execute Parallel Work Streams Tool

Execute multiple parallel tasks to solve complex problems.

  • Name: execute_parallel_work_streams
  • Description: Executes multiple parallel work streams to solve complex problems by decomposing them into independent tasks that run concurrently. Perfect for complex problems that can be broken down into separate components that can be solved independently. Each task runs as a dedicated sub-agent with access to the specified tools and will work independently in parallel, dramatically speeding up complex multi-part tasks. Results can be automatically aggregated or returned individually.
  • Parameters:
    • tasks: Array of task definitions (each with id, name, instruction, context, and allowed_tools)
    • aggregate_results: Boolean to specify whether results should be aggregated (default: true)

Document Management Tools

Search Documents Tool

Search through existing documents in the system.

  • Name: search_documents
  • Description: Search for documents using various criteria
  • Parameters: Search terms, filters, and options

Fetch Documents Tool

Retrieve specific documents from the system.

  • Name: fetch_documents
  • Description: Fetch documents by their identifiers
  • Parameters: Document IDs or references

Create Document Tool

Create new documents in the system.

  • Name: create_document
  • Description: Create a new document with specified content
  • Parameters: Document content, metadata, and properties

Update Document Tool

Update existing documents in the system.

  • Name: update_document
  • Description: Update an existing document with new content or properties
  • Parameters: Document ID, updated content, and properties

Collection Management Tools

Create Collection Tool

Create a new collection to organize content.

  • Name: create_collection
  • Description: Create a new collection with optional schema and layout configuration
  • Parameters:
    • name (required): Name of the collection
    • description (optional): Description of the collection
    • type (optional): Content type for the collection
    • tags (optional): Array of tags
    • properties (optional): Additional properties
    • parent (optional): Parent collection ID

Update Collection Tool

Modify an existing collection's properties.

  • Name: update_collection
  • Description: Update an existing collection's configuration
  • Parameters:
    • id (required): Collection ID to update
    • name (optional): New name
    • description (optional): New description
    • type (optional): New content type
    • Other properties similar to create

Add to Collection Tool

Add objects to an existing collection.

  • Name: add_to_collection
  • Description: Add one or more objects to a collection
  • Parameters:
    • collectionId: Target collection ID
    • objectIds: Array of object IDs to add

Remove from Collection Tool

Remove objects from a collection.

  • Name: remove_from_collection
  • Description: Remove one or more objects from a collection
  • Parameters:
    • collectionId: Target collection ID
    • objectIds: Array of object IDs to remove

Get Collection Tool

Retrieve collection details.

  • Name: get_collection
  • Description: Retrieve a collection's details including schema and layout
  • Parameters:
    • id: Collection ID to retrieve

Type Management Tools

Get Object Type Tool

Retrieve object type definitions.

  • Name: get_object_type
  • Description: Get details about a specific object type

Create or Update Type Tool

Manage object type definitions.

  • Name: create_or_update_type
  • Description: Create new or update existing object types

Disable Type Tool

Disable existing object types.

  • Name: disable_type
  • Description: Disable an object type in the system

Web and External Tools

Web Search Tool

Perform web searches and retrieve results.

  • Name: web_search
  • Description: Search the web for information
  • Parameters: Search query and options

This activity requires an API key for serper. Go to Setting in Studio to configure your API key.

Execute Code Tool

Execute JavaScript code snippets.

  • Name: execute_code
  • Description: Run JavaScript code within the workflow
  • Parameters: Code to execute

Ask User Tool

Interact with users to get input.

  • Name: ask_user
  • Description: Request input from users during workflow execution
  • Parameters: Question or prompt for the user

Analyze Spreadsheet Tool

Process and analyze Excel files.

  • Name: analyze_spreadsheet
  • Description: Analyze spreadsheet content with custom code
  • Parameters:
    • object_id: ID of the spreadsheet object
    • code: Analysis code to execute
    • summary: Description of the analysis

Best Practices

  1. Tool Selection:

    • Choose the most specific tool for your task
    • Combine tools when needed for complex operations
    • Consider performance implications of tool choices
  2. Error Handling:

    • All tools include built-in error handling
    • Check tool responses for success/failure
    • Handle errors appropriately in your workflows
  3. Performance:

    • Use batch operations when possible
    • Consider caching for frequently accessed data
    • Monitor tool execution times
    • Use parallel execution tools for complex tasks that can be broken down
  4. Security:

    • Tools enforce permission checks automatically
    • Consider data privacy when using external tools
    • Follow least privilege principle

Was this page helpful?