Skip to main content
This section provides setup instructions for each built-in tool category. Tools are managed in Admin → Tools and can be attached to flows or made available to agents.

​
Search Tools

Search tools allow agents to query the web for real-time information. Each provider requires an API key. AI-optimized search engine designed for LLMs, returning clean and concise results. Setup Steps:
  1. Sign up at tavily.com and obtain an API key
  2. In Admin → Tools, find Tavily Web Search and enter your API key
  3. Enable the tool
Environment Variable: TAVILY_API_KEY
Perplexity AI search API for real-time web search with AI-summarized results. Setup Steps:
  1. Sign up at perplexity.ai and generate an API key from the API settings
  2. In Admin → Tools, find Perplexity Web Search and enter your API key
  3. Enable the tool
Environment Variable: PERPLEXITY_API_KEY
Privacy-focused web search API with independent index. Setup Steps:
  1. Sign up at brave.com/search/api and obtain an API key
  2. In Admin → Tools, find Brave Web Search and enter your API key
  3. Enable the tool
Environment Variable: BRAVE_API_KEY
Neural search API that understands meaning, not just keywords. Setup Steps:
  1. Sign up at exa.ai and generate an API key
  2. In Admin → Tools, find Exa Web Search and enter your API key
  3. Enable the tool
Environment Variable: EXA_API_KEY
Google Search results API supporting multiple search engines. Setup Steps:
  1. Sign up at serpapi.com and obtain an API key
  2. In Admin → Tools, find SerpAPI Web Search and enter your API key
  3. Enable the tool
Environment Variable: SERPAPI_API_KEY

​
Database Tools

Database tools enable agents to query, inspect schemas, and list tables across various database platforms. All database tools use the Data Platform Connections system — configure connections in Admin → Data Connections first, then attach them to database tools. Supported database providers:
ProviderProvider IDNotes
Generic SQLsqlODBC-compatible databases
PostgreSQLpostgresNative PostgreSQL driver
MySQLmysqlMySQL / MariaDB
Microsoft SQL ServermssqlT-SQL / Azure SQL
OracleoracleOracle Database
IBM DB2db2IBM DB2 LUW
Azure Cosmos DBcosmosSQL API queries
DatabricksdatabricksDatabricks SQL Warehouse
SnowflakesnowflakeSnowflake Data Cloud
Google BigQuerybigqueryBigQuery SQL
Azure Synapse AnalyticssynapseSynapse Serverless/Dedicated SQL
AWS RedshiftredshiftAmazon Redshift
AWS AthenaathenaServerless queries on S3
ClickHouseclickhouseOLAP analytics database
TrinotrinoDistributed query engine
Setup Steps (all database providers):
  1. Go to Admin → Data Connections and create a connection for your database
  2. Provide the connection string, credentials, and test the connection
  3. In Admin → Tools, find the tool(s) for your database provider
  4. Select the data connection from the dropdown
  5. Enable the tool(s) you need (Natural Language Query, Execute Query, Schema Inspector, Table Listing)
Tip: Enable Read Only mode for safety — this restricts tools to SELECT queries only.

​
Internal Cosmos DB Tools

Two special database tools query the app’s own Cosmos DB instance:
  • Internal Cosmos DB Query — For user-facing queries with partition-key isolation
  • Admin Cosmos DB Query — For admin-level cross-partition queries
These tools use the app’s existing Cosmos DB credentials and require no additional configuration. Enable them in Admin → Tools.

​
Utility Tools

Utility tools provide common helper functions. Most are enabled by default and require no API keys.
ToolProvider IDRequires API Key
CalculatorcalculatorNo
Weather InformationweatherYes (OpenWeatherMap)
Code Interpretercode_interpreterNo (requires sandbox)
JSON Formatter & Validatorjson_toolsNo
Base64 Encoder/Decoderbase64_toolsNo
UUID Generatoruuid_generatorNo
Hash Generatorhash_generatorNo
JWT Decoderjwt_decoderNo
Regex Testerregex_testerNo
Timestamp Convertertimestamp_converterNo
URL Parser & Builderurl_parserNo
Text Diff Comparisontext_diffNo
String Transformerstring_transformNo

​
Weather Information Setup

  1. Sign up at openweathermap.org and obtain an API key
  2. In Admin → Tools, find Weather Information and enter your API key
  3. Select temperature units (Celsius or Fahrenheit)
  4. Enable the tool

​
Code Interpreter Setup

The Code Interpreter executes Python code in a sandboxed environment. It requires a sandbox runtime to be configured (disabled by default).

​
API Tools

API tools allow agents to interact with external APIs.

​
GraphQL Tools

Four GraphQL tools are available: Query, Introspection, Schema Validator, and Query Builder. These require no API keys — provide the GraphQL endpoint URL when invoking the tool. Enable them in Admin → Tools.

​
REST API Tools

Six REST tools are available: Generic Request, GET, POST, PUT, PATCH, and DELETE, plus OAuth2-authenticated requests and a Webhook Sender. These require no pre-configured API keys — authentication headers are provided at invocation time. Enable them in Admin → Tools.

​
Identity Tools (Microsoft Entra ID)

Entra ID tools look up users, managers, direct reports, and search the directory. They use the app’s existing Graph API credentials (managed identity or client secret) — no additional configuration needed.
ToolDescription
Entra User LookupGet user profile by email/UPN
Entra Get ManagerGet a user’s direct manager
Entra Get Direct ReportsList a user’s direct reports
Entra Search UsersSearch users by name, email, department, or title
Setup: Enable the desired tools in Admin → Tools. The Entra Identity tools read extended directory fields (jobTitle, department, employeeId, etc.) that go beyond the basic profile, so the server’s Graph app registration (Azure Portal → App registrations) needs User.Read.All (Application). This is on top of the unconditional User.ReadBasic.All + GroupMember.Read.All required by every authenticated request — see Server App Registration for the full picture.

​
Exchange Online Tools

Exchange tools use delegated (OBO) Graph API permissions — they execute as the authenticated user.
ToolDelegated Scope Required
Send Emailgraph_mail_send
List Messagesgraph_mail_read
Search Messagesgraph_mail_read
List Calendar Eventsgraph_calendar_read
Create Calendar Eventgraph_calendar_write
Get Out of Officegraph_mailbox_settings
Setup:
  1. In the Azure AD App Registrations portal, open your Client App Registration and add the required delegated Graph permissions (e.g., Mail.Send, Mail.Read, Calendars.ReadWrite, MailboxSettings.Read)
  2. Grant admin consent for the permissions
  3. In the app’s Admin → Settings, enable the corresponding enableDelegatedGraph* settings
  4. In Admin → Tools, enable the desired Exchange tools

​
OneDrive Tools

OneDrive tools also use delegated (OBO) Graph API permissions.
ToolDelegated Scope Required
List Filesgraph_files_read
Search Filesgraph_files_read
Get File Contentgraph_files_read
Upload Filegraph_files_readwrite
Create Foldergraph_files_readwrite
Get Sharing Linkgraph_files_readwrite
Setup:
  1. In the Azure AD App Registrations portal, open your Client App Registration and add Files.Read and/or Files.ReadWrite delegated Graph permissions
  2. Grant admin consent for the permissions
  3. In the app’s Admin → Settings, enable enableDelegatedGraphFiles (read) and/or enableDelegatedGraphFilesWrite (write)
  4. In Admin → Tools, enable the desired OneDrive tools