opensource/sim
3
0
Fork 0
mirror of https://github.com/simstudioai/sim.git synced 2026-09-24 15:45:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat(tools): added 50+ stripe tools and trigger and docs (#1816)

Browse Source 
* feat(tools): added 150+ new tools across confluence, discord, exa, firecrawl, jina, jira, linear, linkup, MS suite, parallel, reddit, supabase, & tavily

* feat(tools): added 40+ stripe tools and trigger

* added stripe tools to registry

* added number validation, tested all stripe tools

* update stripe payload, tested webhooks
This commit is contained in:
Waleed
2025-11-07 10:59:19 -08:00
committed by GitHub
parent 742d59f54d
commit c3436e998f
372 changed files with 40729 additions and 568 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/docs/content/docs/en/tools/confluence.mdx
+293 -1
View File
@@ -43,7 +43,7 @@ In Sim, the Confluence integration enables your agents to access and leverage yo
## Usage Instructions
Integrate Confluence into the workflow. Can read and update a page.
Integrate Confluence into the workflow. Can read, create, update, delete pages, manage comments, attachments, labels, and search content.
@@ -94,6 +94,298 @@ Update a Confluence page using the Confluence API.
| `title` | string | Updated page title |
| `success` | boolean | Update operation success status |
### `confluence_create_page`
Create a new page in a Confluence space.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
| `spaceId` | string | Yes | Confluence space ID where the page will be created |
| `title` | string | Yes | Title of the new page |
| `content` | string | Yes | Page content in Confluence storage format \(HTML\) |
| `parentId` | string | No | Parent page ID if creating a child page |
| `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `ts` | string | Timestamp of creation |
| `pageId` | string | Created page ID |
| `title` | string | Page title |
| `url` | string | Page URL |
### `confluence_delete_page`
Delete a Confluence page (moves it to trash where it can be restored).
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
| `pageId` | string | Yes | Confluence page ID to delete |
| `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `ts` | string | Timestamp of deletion |
| `pageId` | string | Deleted page ID |
| `deleted` | boolean | Deletion status |
### `confluence_search`
Search for content across Confluence pages, blog posts, and other content.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
| `query` | string | Yes | Search query string |
| `limit` | number | No | Maximum number of results to return \(default: 25\) |
| `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `ts` | string | Timestamp of search |
| `results` | array | Search results |
### `confluence_create_comment`
Add a comment to a Confluence page.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
| `pageId` | string | Yes | Confluence page ID to comment on |
| `comment` | string | Yes | Comment text in Confluence storage format |
| `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `ts` | string | Timestamp of creation |
| `commentId` | string | Created comment ID |
| `pageId` | string | Page ID |
### `confluence_list_comments`
List all comments on a Confluence page.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
| `pageId` | string | Yes | Confluence page ID to list comments from |
| `limit` | number | No | Maximum number of comments to return \(default: 25\) |
| `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `ts` | string | Timestamp of retrieval |
| `comments` | array | List of comments |
### `confluence_update_comment`
Update an existing comment on a Confluence page.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
| `commentId` | string | Yes | Confluence comment ID to update |
| `comment` | string | Yes | Updated comment text in Confluence storage format |
| `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `ts` | string | Timestamp of update |
| `commentId` | string | Updated comment ID |
| `updated` | boolean | Update status |
### `confluence_delete_comment`
Delete a comment from a Confluence page.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
| `commentId` | string | Yes | Confluence comment ID to delete |
| `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `ts` | string | Timestamp of deletion |
| `commentId` | string | Deleted comment ID |
| `deleted` | boolean | Deletion status |
### `confluence_list_attachments`
List all attachments on a Confluence page.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
| `pageId` | string | Yes | Confluence page ID to list attachments from |
| `limit` | number | No | Maximum number of attachments to return \(default: 25\) |
| `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `ts` | string | Timestamp of retrieval |
| `attachments` | array | List of attachments |
### `confluence_delete_attachment`
Delete an attachment from a Confluence page (moves to trash).
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
| `attachmentId` | string | Yes | Confluence attachment ID to delete |
| `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `ts` | string | Timestamp of deletion |
| `attachmentId` | string | Deleted attachment ID |
| `deleted` | boolean | Deletion status |
### `confluence_add_label`
Add a label to a Confluence page.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
| `pageId` | string | Yes | Confluence page ID to add label to |
| `labelName` | string | Yes | Label name to add |
| `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `ts` | string | Timestamp of operation |
| `pageId` | string | Page ID |
| `labelName` | string | Label name |
| `added` | boolean | Addition status |
### `confluence_list_labels`
List all labels on a Confluence page.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
| `pageId` | string | Yes | Confluence page ID to list labels from |
| `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `ts` | string | Timestamp of retrieval |
| `labels` | array | List of labels |
### `confluence_remove_label`
Remove a label from a Confluence page.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
| `pageId` | string | Yes | Confluence page ID to remove label from |
| `labelName` | string | Yes | Label name to remove |
| `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `ts` | string | Timestamp of operation |
| `pageId` | string | Page ID |
| `labelName` | string | Label name |
| `removed` | boolean | Removal status |
### `confluence_get_space`
Get details about a specific Confluence space.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
| `spaceId` | string | Yes | Confluence space ID to retrieve |
| `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `ts` | string | Timestamp of retrieval |
| `spaceId` | string | Space ID |
| `name` | string | Space name |
| `key` | string | Space key |
| `type` | string | Space type |
| `status` | string | Space status |
| `url` | string | Space URL |
### `confluence_list_spaces`
List all Confluence spaces accessible to the user.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Confluence domain \(e.g., yourcompany.atlassian.net\) |
| `limit` | number | No | Maximum number of spaces to return \(default: 25\) |
| `cloudId` | string | No | Confluence Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `ts` | string | Timestamp of retrieval |
| `spaces` | array | List of spaces |
## Notes
apps/docs/content/docs/en/tools/discord.mdx
+616 -2
View File
@@ -57,7 +57,7 @@ Discord components in Sim use efficient lazy loading, only fetching data when ne
## Usage Instructions
Integrate Discord into the workflow. Can send and get messages, get server information, and get a user’s information.
Comprehensive Discord integration: messages, threads, channels, roles, members, invites, and webhooks.
@@ -101,7 +101,7 @@ Retrieve messages from a Discord channel
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
| `messages` | array | Array of Discord messages with full metadata |
| `data` | object | Container for messages data |
### `discord_get_server`
@@ -139,6 +139,620 @@ Retrieve information about a Discord user
| `message` | string | Success or error message |
| `data` | object | Discord user information |
### `discord_edit_message`
Edit an existing message in a Discord channel
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID containing the message |
| `messageId` | string | Yes | The ID of the message to edit |
| `content` | string | No | The new text content for the message |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
| `data` | object | Updated Discord message data |
### `discord_delete_message`
Delete a message from a Discord channel
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID containing the message |
| `messageId` | string | Yes | The ID of the message to delete |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
### `discord_add_reaction`
Add a reaction emoji to a Discord message
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID containing the message |
| `messageId` | string | Yes | The ID of the message to react to |
| `emoji` | string | Yes | The emoji to react with \(unicode emoji or custom emoji in name:id format\) |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
### `discord_remove_reaction`
Remove a reaction from a Discord message
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID containing the message |
| `messageId` | string | Yes | The ID of the message with the reaction |
| `emoji` | string | Yes | The emoji to remove \(unicode emoji or custom emoji in name:id format\) |
| `userId` | string | No | The user ID whose reaction to remove \(omit to remove bot's own reaction\) |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
### `discord_pin_message`
Pin a message in a Discord channel
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID containing the message |
| `messageId` | string | Yes | The ID of the message to pin |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
### `discord_unpin_message`
Unpin a message in a Discord channel
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID containing the message |
| `messageId` | string | Yes | The ID of the message to unpin |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
### `discord_create_thread`
Create a thread in a Discord channel
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID to create the thread in |
| `name` | string | Yes | The name of the thread \(1-100 characters\) |
| `messageId` | string | No | The message ID to create a thread from \(if creating from existing message\) |
| `autoArchiveDuration` | number | No | Duration in minutes to auto-archive the thread \(60, 1440, 4320, 10080\) |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
| `data` | object | Created thread data |
### `discord_join_thread`
Join a thread in Discord
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `threadId` | string | Yes | The thread ID to join |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
### `discord_leave_thread`
Leave a thread in Discord
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `threadId` | string | Yes | The thread ID to leave |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
### `discord_archive_thread`
Archive or unarchive a thread in Discord
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `threadId` | string | Yes | The thread ID to archive/unarchive |
| `archived` | boolean | Yes | Whether to archive \(true\) or unarchive \(false\) the thread |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
| `data` | object | Updated thread data |
### `discord_create_channel`
Create a new channel in a Discord server
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `name` | string | Yes | The name of the channel \(1-100 characters\) |
| `type` | number | No | Channel type \(0=text, 2=voice, 4=category, 5=announcement, 13=stage\) |
| `topic` | string | No | Channel topic \(0-1024 characters\) |
| `parentId` | string | No | Parent category ID for the channel |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
| `data` | object | Created channel data |
### `discord_update_channel`
Update a Discord channel
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID to update |
| `name` | string | No | The new name for the channel |
| `topic` | string | No | The new topic for the channel |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
| `data` | object | Updated channel data |
### `discord_delete_channel`
Delete a Discord channel
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID to delete |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
### `discord_get_channel`
Get information about a Discord channel
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID to retrieve |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
| `data` | object | Channel data |
### `discord_create_role`
Create a new role in a Discord server
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `name` | string | Yes | The name of the role |
| `color` | number | No | RGB color value as integer \(e.g., 0xFF0000 for red\) |
| `hoist` | boolean | No | Whether to display role members separately from online members |
| `mentionable` | boolean | No | Whether the role can be mentioned |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
| `data` | object | Created role data |
### `discord_update_role`
Update a role in a Discord server
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `roleId` | string | Yes | The role ID to update |
| `name` | string | No | The new name for the role |
| `color` | number | No | RGB color value as integer |
| `hoist` | boolean | No | Whether to display role members separately |
| `mentionable` | boolean | No | Whether the role can be mentioned |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
| `data` | object | Updated role data |
### `discord_delete_role`
Delete a role from a Discord server
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `roleId` | string | Yes | The role ID to delete |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
### `discord_assign_role`
Assign a role to a member in a Discord server
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `userId` | string | Yes | The user ID to assign the role to |
| `roleId` | string | Yes | The role ID to assign |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
### `discord_remove_role`
Remove a role from a member in a Discord server
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `userId` | string | Yes | The user ID to remove the role from |
| `roleId` | string | Yes | The role ID to remove |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
### `discord_kick_member`
Kick a member from a Discord server
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `userId` | string | Yes | The user ID to kick |
| `reason` | string | No | Reason for kicking the member |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
### `discord_ban_member`
Ban a member from a Discord server
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `userId` | string | Yes | The user ID to ban |
| `reason` | string | No | Reason for banning the member |
| `deleteMessageDays` | number | No | Number of days to delete messages for \(0-7\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
### `discord_unban_member`
Unban a member from a Discord server
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `userId` | string | Yes | The user ID to unban |
| `reason` | string | No | Reason for unbanning the member |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
### `discord_get_member`
Get information about a member in a Discord server
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `userId` | string | Yes | The user ID to retrieve |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
| `data` | object | Member data |
### `discord_update_member`
Update a member in a Discord server (e.g., change nickname)
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
| `userId` | string | Yes | The user ID to update |
| `nick` | string | No | New nickname for the member \(null to remove\) |
| `mute` | boolean | No | Whether to mute the member in voice channels |
| `deaf` | boolean | No | Whether to deafen the member in voice channels |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
| `data` | object | Updated member data |
### `discord_create_invite`
Create an invite link for a Discord channel
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID to create an invite for |
| `maxAge` | number | No | Duration of invite in seconds \(0 = never expires, default 86400\) |
| `maxUses` | number | No | Max number of uses \(0 = unlimited, default 0\) |
| `temporary` | boolean | No | Whether invite grants temporary membership |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
| `data` | object | Created invite data |
### `discord_get_invite`
Get information about a Discord invite
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `inviteCode` | string | Yes | The invite code to retrieve |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
| `data` | object | Invite data |
### `discord_delete_invite`
Delete a Discord invite
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `inviteCode` | string | Yes | The invite code to delete |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
### `discord_create_webhook`
Create a webhook in a Discord channel
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `channelId` | string | Yes | The Discord channel ID to create the webhook in |
| `name` | string | Yes | Name of the webhook \(1-80 characters\) |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
| `data` | object | Created webhook data |
### `discord_execute_webhook`
Execute a Discord webhook to send a message
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `webhookId` | string | Yes | The webhook ID |
| `webhookToken` | string | Yes | The webhook token |
| `content` | string | Yes | The message content to send |
| `username` | string | No | Override the default username of the webhook |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
| `data` | object | Message sent via webhook |
### `discord_get_webhook`
Get information about a Discord webhook
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `webhookId` | string | Yes | The webhook ID to retrieve |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
| `data` | object | Webhook data |
### `discord_delete_webhook`
Delete a Discord webhook
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `botToken` | string | Yes | The bot token for authentication |
| `webhookId` | string | Yes | The webhook ID to delete |
| `serverId` | string | Yes | The Discord server ID \(guild ID\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Success or error message |
## Notes
apps/docs/content/docs/en/tools/exa.mdx
+27 -1
View File
@@ -62,6 +62,17 @@ Search the web using Exa AI. Returns relevant search results with titles, URLs,
| `numResults` | number | No | Number of results to return \(default: 10, max: 25\) |
| `useAutoprompt` | boolean | No | Whether to use autoprompt to improve the query \(default: false\) |
| `type` | string | No | Search type: neural, keyword, auto or fast \(default: auto\) |
| `includeDomains` | string | No | Comma-separated list of domains to include in results |
| `excludeDomains` | string | No | Comma-separated list of domains to exclude from results |
| `startPublishedDate` | string | No | Filter results published after this date \(ISO 8601 format, e.g., 2024-01-01\) |
| `endPublishedDate` | string | No | Filter results published before this date \(ISO 8601 format\) |
| `startCrawlDate` | string | No | Filter results crawled after this date \(ISO 8601 format\) |
| `endCrawlDate` | string | No | Filter results crawled before this date \(ISO 8601 format\) |
| `category` | string | No | Filter by category: company, research_paper, news_article, pdf, github, tweet, movie, song, personal_site |
| `text` | boolean | No | Include full text content in results \(default: false\) |
| `highlights` | boolean | No | Include highlighted snippets in results \(default: false\) |
| `summary` | boolean | No | Include AI-generated summaries in results \(default: false\) |
| `livecrawl` | string | No | Live crawling mode: always, fallback, or never \(default: never\) |
| `apiKey` | string | Yes | Exa AI API Key |
#### Output
@@ -81,6 +92,10 @@ Retrieve the contents of webpages using Exa AI. Returns the title, text content,
| `urls` | string | Yes | Comma-separated list of URLs to retrieve content from |
| `text` | boolean | No | If true, returns full page text with default settings. If false, disables text return. |
| `summaryQuery` | string | No | Query to guide the summary generation |
| `subpages` | number | No | Number of subpages to crawl from the provided URLs |
| `subpageTarget` | string | No | Comma-separated keywords to target specific subpages \(e.g., "docs,tutorial,about"\) |
| `highlights` | boolean | No | Include highlighted snippets in results \(default: false\) |
| `livecrawl` | string | No | Live crawling mode: always, fallback, or never \(default: never\) |
| `apiKey` | string | Yes | Exa AI API Key |
#### Output
@@ -100,6 +115,17 @@ Find webpages similar to a given URL using Exa AI. Returns a list of similar lin
| `url` | string | Yes | The URL to find similar links for |
| `numResults` | number | No | Number of similar links to return \(default: 10, max: 25\) |
| `text` | boolean | No | Whether to include the full text of the similar pages |
| `includeDomains` | string | No | Comma-separated list of domains to include in results |
| `excludeDomains` | string | No | Comma-separated list of domains to exclude from results |
| `excludeSourceDomain` | boolean | No | Exclude the source domain from results \(default: false\) |
| `startPublishedDate` | string | No | Filter results published after this date \(ISO 8601 format, e.g., 2024-01-01\) |
| `endPublishedDate` | string | No | Filter results published before this date \(ISO 8601 format\) |
| `startCrawlDate` | string | No | Filter results crawled after this date \(ISO 8601 format\) |
| `endCrawlDate` | string | No | Filter results crawled before this date \(ISO 8601 format\) |
| `category` | string | No | Filter by category: company, research_paper, news_article, pdf, github, tweet, movie, song, personal_site |
| `highlights` | boolean | No | Include highlighted snippets in results \(default: false\) |
| `summary` | boolean | No | Include AI-generated summaries in results \(default: false\) |
| `livecrawl` | string | No | Live crawling mode: always, fallback, or never \(default: never\) |
| `apiKey` | string | Yes | Exa AI API Key |
#### Output
@@ -136,7 +162,7 @@ Perform comprehensive research using AI to generate detailed reports with citati
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `query` | string | Yes | Research query or topic |
| `includeText` | boolean | No | Include full text content in results |
| `model` | string | No | Research model: exa-research-fast, exa-research \(default\), or exa-research-pro |
| `apiKey` | string | Yes | Exa AI API Key |
#### Output
apps/docs/content/docs/en/tools/firecrawl.mdx
+96 -3
View File
@@ -1,6 +1,6 @@
---
title: Firecrawl
description: Scrape or search the web
description: Scrape, search, crawl, map, and extract web data
---
import { BlockInfoCard } from "@/components/ui/block-info-card"
@@ -59,7 +59,7 @@ This allows your agents to gather information from websites, extract structured
## Usage Instructions
Integrate Firecrawl into the workflow. Can search, scrape, or crawl websites.
Integrate Firecrawl into the workflow. Can scrape pages, search the web, crawl entire websites, map URL structures, and extract structured data using AI.
@@ -74,7 +74,25 @@ Extract structured content from web pages with comprehensive metadata support. C
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `url` | string | Yes | The URL to scrape content from |
| `scrapeOptions` | json | No | Options for content scraping |
| `formats` | json | No | Output formats \(markdown, html, rawHtml, links, images, screenshot\). Default: \["markdown"\] |
| `onlyMainContent` | boolean | No | Extract only main content, excluding headers, navs, footers \(default: true\) |
| `includeTags` | json | No | HTML tags to retain in the output |
| `excludeTags` | json | No | HTML tags to remove from the output |
| `maxAge` | number | No | Return cached version if younger than this age in ms \(default: 172800000\) |
| `headers` | json | No | Custom request headers \(cookies, user-agent, etc.\) |
| `waitFor` | number | No | Delay in milliseconds before fetching \(default: 0\) |
| `mobile` | boolean | No | Emulate mobile device \(default: false\) |
| `skipTlsVerification` | boolean | No | Skip TLS certificate verification \(default: true\) |
| `timeout` | number | No | Request timeout in milliseconds |
| `parsers` | json | No | File processing controls \(e.g., \["pdf"\]\) |
| `actions` | json | No | Pre-scrape operations \(wait, click, scroll, screenshot, etc.\) |
| `location` | json | No | Geographic settings \(country, languages\) |
| `removeBase64Images` | boolean | No | Strip base64 images from output \(default: true\) |
| `blockAds` | boolean | No | Enable ad and popup blocking \(default: true\) |
| `proxy` | string | No | Proxy type: basic, stealth, or auto \(default: auto\) |
| `storeInCache` | boolean | No | Cache the page \(default: true\) |
| `zeroDataRetention` | boolean | No | Enable zero data retention mode \(default: false\) |
| `scrapeOptions` | json | No | Options for content scraping \(legacy, prefer top-level params\) |
| `apiKey` | string | Yes | Firecrawl API key |
#### Output
@@ -94,6 +112,15 @@ Search for information on the web using Firecrawl
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `query` | string | Yes | The search query to use |
| `limit` | number | No | Maximum number of results to return \(1-100, default: 5\) |
| `sources` | json | No | Search sources: \["web"\], \["images"\], or \["news"\] \(default: \["web"\]\) |
| `categories` | json | No | Filter by categories: \["github"\], \["research"\], or \["pdf"\] |
| `tbs` | string | No | Time-based search: qdr:h \(hour\), qdr:d \(day\), qdr:w \(week\), qdr:m \(month\), qdr:y \(year\) |
| `location` | string | No | Geographic location for results \(e.g., "San Francisco, California, United States"\) |
| `country` | string | No | ISO country code for geo-targeting \(default: US\) |
| `timeout` | number | No | Timeout in milliseconds \(default: 60000\) |
| `ignoreInvalidURLs` | boolean | No | Exclude invalid URLs from results \(default: false\) |
| `scrapeOptions` | json | No | Advanced scraping configuration for search results |
| `apiKey` | string | Yes | Firecrawl API key |
#### Output
@@ -113,6 +140,20 @@ Crawl entire websites and extract structured content from all accessible pages
| `url` | string | Yes | The website URL to crawl |
| `limit` | number | No | Maximum number of pages to crawl \(default: 100\) |
| `onlyMainContent` | boolean | No | Extract only main content from pages |
| `prompt` | string | No | Natural language instruction to auto-generate crawler options |
| `maxDiscoveryDepth` | number | No | Depth limit for URL discovery \(root pages have depth 0\) |
| `sitemap` | string | No | Whether to use sitemap data: "skip" or "include" \(default: "include"\) |
| `crawlEntireDomain` | boolean | No | Follow sibling/parent URLs or only child paths \(default: false\) |
| `allowExternalLinks` | boolean | No | Follow external website links \(default: false\) |
| `allowSubdomains` | boolean | No | Follow subdomain links \(default: false\) |
| `ignoreQueryParameters` | boolean | No | Prevent re-scraping same path with different query params \(default: false\) |
| `delay` | number | No | Seconds between scrapes for rate limit compliance |
| `maxConcurrency` | number | No | Concurrent scrape limit |
| `excludePaths` | json | No | Array of regex patterns for URLs to exclude |
| `includePaths` | json | No | Array of regex patterns for URLs to include exclusively |
| `webhook` | json | No | Webhook configuration for crawl notifications |
| `scrapeOptions` | json | No | Advanced scraping configuration |
| `zeroDataRetention` | boolean | No | Enable zero data retention \(default: false\) |
| `apiKey` | string | Yes | Firecrawl API Key |
#### Output
@@ -121,6 +162,58 @@ Crawl entire websites and extract structured content from all accessible pages
| --------- | ---- | ----------- |
| `pages` | array | Array of crawled pages with their content and metadata |
### `firecrawl_map`
Get a complete list of URLs from any website quickly and reliably. Useful for discovering all pages on a site without crawling them.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `url` | string | Yes | The base URL to map and discover links from |
| `search` | string | No | Filter results by relevance to a search term \(e.g., "blog"\) |
| `sitemap` | string | No | Controls sitemap usage: "skip", "include" \(default\), or "only" |
| `includeSubdomains` | boolean | No | Whether to include URLs from subdomains \(default: true\) |
| `ignoreQueryParameters` | boolean | No | Exclude URLs containing query strings \(default: true\) |
| `limit` | number | No | Maximum number of links to return \(max: 100,000, default: 5,000\) |
| `timeout` | number | No | Request timeout in milliseconds |
| `location` | json | No | Geographic context for proxying \(country, languages\) |
| `apiKey` | string | Yes | Firecrawl API key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the mapping operation was successful |
| `links` | array | Array of discovered URLs from the website |
### `firecrawl_extract`
Extract structured data from entire webpages using natural language prompts and JSON schema. Powerful agentic feature for intelligent data extraction.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `urls` | json | Yes | Array of URLs to extract data from \(supports glob format\) |
| `prompt` | string | No | Natural language guidance for the extraction process |
| `schema` | json | No | JSON Schema defining the structure of data to extract |
| `enableWebSearch` | boolean | No | Enable web search to find supplementary information \(default: false\) |
| `ignoreSitemap` | boolean | No | Ignore sitemap.xml files during scanning \(default: false\) |
| `includeSubdomains` | boolean | No | Extend scanning to subdomains \(default: true\) |
| `showSources` | boolean | No | Return data sources in the response \(default: false\) |
| `ignoreInvalidURLs` | boolean | No | Skip invalid URLs in the array \(default: true\) |
| `scrapeOptions` | json | No | Advanced scraping configuration options |
| `apiKey` | string | Yes | Firecrawl API key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the extraction operation was successful |
| `data` | object | Extracted structured data according to the schema or prompt |
| `sources` | array | Data sources \(only if showSources is enabled\) |
## Notes
apps/docs/content/docs/en/tools/jina.mdx
+63 -3
View File
@@ -1,6 +1,6 @@
---
title: Jina
description: Convert website content into text
description: Search the web or extract content from URLs
---
import { BlockInfoCard } from "@/components/ui/block-info-card"
@@ -63,7 +63,7 @@ This integration is particularly valuable for building agents that need to gathe
## Usage Instructions
Integrate Jina into the workflow. Extracts content from websites.
Integrate Jina AI into the workflow. Search the web and get LLM-friendly results, or extract clean content from specific URLs with advanced parsing options.
@@ -78,16 +78,76 @@ Extract and process web content into clean, LLM-friendly text using Jina AI Read
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `url` | string | Yes | The URL to read and convert to markdown |
| `useReaderLMv2` | boolean | No | Whether to use ReaderLM-v2 for better quality |
| `useReaderLMv2` | boolean | No | Whether to use ReaderLM-v2 for better quality \(3x token cost\) |
| `gatherLinks` | boolean | No | Whether to gather all links at the end |
| `jsonResponse` | boolean | No | Whether to return response in JSON format |
| `apiKey` | string | Yes | Your Jina AI API key |
| `targetSelector` | string | No | CSS selector to target specific page elements \(e.g., "#main-content"\) |
| `waitForSelector` | string | No | CSS selector to wait for before extracting content \(useful for dynamic pages\) |
| `removeSelector` | string | No | CSS selector for elements to exclude \(e.g., "header, footer, .ad"\) |
| `timeout` | number | No | Maximum seconds to wait for page load |
| `withImagesummary` | boolean | No | Gather all images from the page with metadata |
| `retainImages` | string | No | Control image inclusion: "none" removes all, "all" keeps all |
| `returnFormat` | string | No | Output format: markdown, html, text, screenshot, or pageshot |
| `withIframe` | boolean | No | Include iframe content in extraction |
| `withShadowDom` | boolean | No | Extract Shadow DOM content |
| `setCookie` | string | No | Forward authentication cookies \(disables caching\) |
| `proxyUrl` | string | No | HTTP proxy URL for request routing |
| `proxy` | string | No | Country code for proxy \(e.g., "US", "UK"\) or "auto"/"none" |
| `engine` | string | No | Rendering engine: browser, direct, or cf-browser-rendering |
| `tokenBudget` | number | No | Maximum tokens for the request \(cost control\) |
| `noCache` | boolean | No | Bypass cached content for real-time retrieval |
| `cacheTolerance` | number | No | Custom cache lifetime in seconds |
| `withGeneratedAlt` | boolean | No | Generate alt text for images using VLM |
| `baseUrl` | string | No | Set to "final" to follow redirect chain |
| `locale` | string | No | Browser locale for rendering \(e.g., "en-US"\) |
| `robotsTxt` | string | No | Bot User-Agent for robots.txt checking |
| `dnt` | boolean | No | Do Not Track - prevents caching/tracking |
| `noGfm` | boolean | No | Disable GitHub Flavored Markdown |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `content` | string | The extracted content from the URL, processed into clean, LLM-friendly text |
| `links` | array | List of links found on the page \(when gatherLinks or withLinksummary is enabled\) |
| `images` | array | List of images found on the page \(when withImagesummary is enabled\) |
### `jina_search`
Search the web and return top 5 results with LLM-friendly content. Each result is automatically processed through Jina Reader API. Supports geographic filtering, site restrictions, and pagination.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `q` | string | Yes | Search query string |
| `apiKey` | string | Yes | Your Jina AI API key |
| `gl` | string | No | Two-letter country code for geo-specific results \(e.g., "US", "UK", "JP"\) |
| `location` | string | No | City-level location for localized search results |
| `hl` | string | No | Two-letter language code for results \(e.g., "en", "es", "fr"\) |
| `num` | number | No | Maximum number of results per page \(default: 5\) |
| `page` | number | No | Page number for pagination \(offset\) |
| `site` | string | No | Restrict results to specific domain\(s\). Can be comma-separated for multiple sites \(e.g., "jina.ai,github.com"\) |
| `withFavicon` | boolean | No | Include website favicons in results |
| `withImagesummary` | boolean | No | Gather all images from result pages with metadata |
| `withLinksummary` | boolean | No | Gather all links from result pages |
| `retainImages` | string | No | Control image inclusion: "none" removes all, "all" keeps all |
| `noCache` | boolean | No | Bypass cached content for real-time retrieval |
| `withGeneratedAlt` | boolean | No | Generate alt text for images using VLM |
| `respondWith` | string | No | Set to "no-content" to get only metadata without page content |
| `returnFormat` | string | No | Output format: markdown, html, text, screenshot, or pageshot |
| `engine` | string | No | Rendering engine: browser or direct |
| `timeout` | number | No | Maximum seconds to wait for page load |
| `setCookie` | string | No | Forward authentication cookies |
| `proxyUrl` | string | No | HTTP proxy URL for request routing |
| `locale` | string | No | Browser locale for rendering \(e.g., "en-US"\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `results` | array | Array of search results, each containing title, description, url, and LLM-friendly content |
apps/docs/content/docs/en/tools/jira.mdx
+370
View File
@@ -137,6 +137,376 @@ Retrieve multiple Jira issues in bulk
| `success` | boolean | Operation success status |
| `output` | array | Array of Jira issues with summary, description, created and updated timestamps |
### `jira_delete_issue`
Delete a Jira issue
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `issueKey` | string | Yes | Jira issue key to delete \(e.g., PROJ-123\) |
| `deleteSubtasks` | boolean | No | Whether to delete subtasks. If false, parent issues with subtasks cannot be deleted. |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Deleted issue details with timestamp, issue key, and success status |
### `jira_assign_issue`
Assign a Jira issue to a user
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `issueKey` | string | Yes | Jira issue key to assign \(e.g., PROJ-123\) |
| `accountId` | string | Yes | Account ID of the user to assign the issue to. Use "-1" for automatic assignment or null to unassign. |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Assignment details with timestamp, issue key, assignee ID, and success status |
### `jira_transition_issue`
Move a Jira issue between workflow statuses (e.g., To Do -> In Progress)
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `issueKey` | string | Yes | Jira issue key to transition \(e.g., PROJ-123\) |
| `transitionId` | string | Yes | ID of the transition to execute \(e.g., "11" for "To Do", "21" for "In Progress"\) |
| `comment` | string | No | Optional comment to add when transitioning the issue |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Transition details with timestamp, issue key, transition ID, and success status |
### `jira_search_issues`
Search for Jira issues using JQL (Jira Query Language)
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `jql` | string | Yes | JQL query string to search for issues \(e.g., "project = PROJ AND status = Open"\) |
| `startAt` | number | No | The index of the first result to return \(for pagination\) |
| `maxResults` | number | No | Maximum number of results to return \(default: 50\) |
| `fields` | array | No | Array of field names to return \(default: \['summary', 'status', 'assignee', 'created', 'updated'\]\) |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Search results with timestamp, total count, pagination details, and array of matching issues |
### `jira_add_comment`
Add a comment to a Jira issue
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `issueKey` | string | Yes | Jira issue key to add comment to \(e.g., PROJ-123\) |
| `body` | string | Yes | Comment body text |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Comment details with timestamp, issue key, comment ID, body, and success status |
### `jira_get_comments`
Get all comments from a Jira issue
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `issueKey` | string | Yes | Jira issue key to get comments from \(e.g., PROJ-123\) |
| `startAt` | number | No | Index of the first comment to return \(default: 0\) |
| `maxResults` | number | No | Maximum number of comments to return \(default: 50\) |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Comments data with timestamp, issue key, total count, and array of comments |
### `jira_update_comment`
Update an existing comment on a Jira issue
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `issueKey` | string | Yes | Jira issue key containing the comment \(e.g., PROJ-123\) |
| `commentId` | string | Yes | ID of the comment to update |
| `body` | string | Yes | Updated comment text |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Updated comment details with timestamp, issue key, comment ID, body text, and success status |
### `jira_delete_comment`
Delete a comment from a Jira issue
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `issueKey` | string | Yes | Jira issue key containing the comment \(e.g., PROJ-123\) |
| `commentId` | string | Yes | ID of the comment to delete |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Deletion details with timestamp, issue key, comment ID, and success status |
### `jira_get_attachments`
Get all attachments from a Jira issue
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `issueKey` | string | Yes | Jira issue key to get attachments from \(e.g., PROJ-123\) |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Attachments data with timestamp, issue key, and array of attachments |
### `jira_delete_attachment`
Delete an attachment from a Jira issue
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `attachmentId` | string | Yes | ID of the attachment to delete |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Deletion details with timestamp, attachment ID, and success status |
### `jira_add_worklog`
Add a time tracking worklog entry to a Jira issue
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `issueKey` | string | Yes | Jira issue key to add worklog to \(e.g., PROJ-123\) |
| `timeSpentSeconds` | number | Yes | Time spent in seconds |
| `comment` | string | No | Optional comment for the worklog entry |
| `started` | string | No | Optional start time in ISO format \(defaults to current time\) |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Worklog details with timestamp, issue key, worklog ID, time spent in seconds, and success status |
### `jira_get_worklogs`
Get all worklog entries from a Jira issue
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `issueKey` | string | Yes | Jira issue key to get worklogs from \(e.g., PROJ-123\) |
| `startAt` | number | No | Index of the first worklog to return \(default: 0\) |
| `maxResults` | number | No | Maximum number of worklogs to return \(default: 50\) |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Worklogs data with timestamp, issue key, total count, and array of worklogs |
### `jira_update_worklog`
Update an existing worklog entry on a Jira issue
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `issueKey` | string | Yes | Jira issue key containing the worklog \(e.g., PROJ-123\) |
| `worklogId` | string | Yes | ID of the worklog entry to update |
| `timeSpentSeconds` | number | No | Time spent in seconds |
| `comment` | string | No | Optional comment for the worklog entry |
| `started` | string | No | Optional start time in ISO format |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Worklog update details with timestamp, issue key, worklog ID, and success status |
### `jira_delete_worklog`
Delete a worklog entry from a Jira issue
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `issueKey` | string | Yes | Jira issue key containing the worklog \(e.g., PROJ-123\) |
| `worklogId` | string | Yes | ID of the worklog entry to delete |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Deletion details with timestamp, issue key, worklog ID, and success status |
### `jira_create_issue_link`
Create a link relationship between two Jira issues
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `inwardIssueKey` | string | Yes | Jira issue key for the inward issue \(e.g., PROJ-123\) |
| `outwardIssueKey` | string | Yes | Jira issue key for the outward issue \(e.g., PROJ-456\) |
| `linkType` | string | Yes | The type of link relationship \(e.g., "Blocks", "Relates to", "Duplicates"\) |
| `comment` | string | No | Optional comment to add to the issue link |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Issue link details with timestamp, inward issue key, outward issue key, link type, and success status |
### `jira_delete_issue_link`
Delete a link between two Jira issues
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `linkId` | string | Yes | ID of the issue link to delete |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Deletion details with timestamp, link ID, and success status |
### `jira_add_watcher`
Add a watcher to a Jira issue to receive notifications about updates
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `issueKey` | string | Yes | Jira issue key to add watcher to \(e.g., PROJ-123\) |
| `accountId` | string | Yes | Account ID of the user to add as watcher |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Watcher details with timestamp, issue key, watcher account ID, and success status |
### `jira_remove_watcher`
Remove a watcher from a Jira issue
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
| `issueKey` | string | Yes | Jira issue key to remove watcher from \(e.g., PROJ-123\) |
| `accountId` | string | Yes | Account ID of the user to remove as watcher |
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Operation success status |
| `output` | object | Removal details with timestamp, issue key, watcher account ID, and success status |
## Notes
apps/docs/content/docs/en/tools/linear.mdx
+809 -2
View File
@@ -1,6 +1,6 @@
---
title: Linear
description: Read and create issues in Linear
description: Interact with Linear issues, projects, and more
---
import { BlockInfoCard } from "@/components/ui/block-info-card"
@@ -42,7 +42,7 @@ In Sim, the Linear integration allows your agents to seamlessly interact with yo
## Usage Instructions
Integrate Linear into the workflow. Can read and create issues.
Integrate Linear into the workflow. Can manage issues, comments, projects, labels, workflow states, cycles, attachments, and more.
@@ -65,6 +65,22 @@ Fetch and filter issues from Linear
| --------- | ---- | ----------- |
| `issues` | array | Array of issues from the specified Linear team and project, each containing id, title, description, state, teamId, and projectId |
### `linear_get_issue`
Get a single issue by ID from Linear with full details
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `issueId` | string | Yes | Linear issue ID |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `issue` | object | The issue with full details |
### `linear_create_issue`
Create a new issue in Linear
@@ -84,6 +100,797 @@ Create a new issue in Linear
| --------- | ---- | ----------- |
| `issue` | object | The created issue containing id, title, description, state, teamId, and projectId |
### `linear_update_issue`
Update an existing issue in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `issueId` | string | Yes | Linear issue ID to update |
| `title` | string | No | New issue title |
| `description` | string | No | New issue description |
| `stateId` | string | No | Workflow state ID \(status\) |
| `assigneeId` | string | No | User ID to assign the issue to |
| `priority` | number | No | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) |
| `estimate` | number | No | Estimate in points |
| `labelIds` | array | No | Array of label IDs to set on the issue |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `issue` | object | The updated issue |
### `linear_archive_issue`
Archive an issue in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `issueId` | string | Yes | Linear issue ID to archive |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the archive operation was successful |
| `issueId` | string | The ID of the archived issue |
### `linear_unarchive_issue`
Unarchive (restore) an archived issue in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `issueId` | string | Yes | Linear issue ID to unarchive |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the unarchive operation was successful |
| `issueId` | string | The ID of the unarchived issue |
### `linear_delete_issue`
Delete (trash) an issue in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `issueId` | string | Yes | Linear issue ID to delete |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the delete operation was successful |
### `linear_search_issues`
Search for issues in Linear using full-text search
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `query` | string | Yes | Search query string |
| `teamId` | string | No | Filter by team ID |
| `includeArchived` | boolean | No | Include archived issues in search results |
| `first` | number | No | Number of results to return \(default: 50\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `issues` | array | Array of matching issues |
### `linear_add_label_to_issue`
Add a label to an issue in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `issueId` | string | Yes | Linear issue ID |
| `labelId` | string | Yes | Label ID to add to the issue |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the label was successfully added |
| `issueId` | string | The ID of the issue |
### `linear_remove_label_from_issue`
Remove a label from an issue in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `issueId` | string | Yes | Linear issue ID |
| `labelId` | string | Yes | Label ID to remove from the issue |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the label was successfully removed |
| `issueId` | string | The ID of the issue |
### `linear_create_comment`
Add a comment to an issue in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `issueId` | string | Yes | Linear issue ID to comment on |
| `body` | string | Yes | Comment text \(supports Markdown\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `comment` | object | The created comment |
### `linear_update_comment`
Edit a comment in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `commentId` | string | Yes | Comment ID to update |
| `body` | string | Yes | New comment text \(supports Markdown\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `comment` | object | The updated comment |
### `linear_delete_comment`
Delete a comment from Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `commentId` | string | Yes | Comment ID to delete |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the delete operation was successful |
### `linear_list_comments`
List all comments on an issue in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `issueId` | string | Yes | Linear issue ID |
| `first` | number | No | Number of comments to return \(default: 50\) |
| `after` | string | No | Cursor for pagination |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `comments` | array | Array of comments on the issue |
### `linear_list_projects`
List projects in Linear with optional filtering
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `teamId` | string | No | Filter by team ID |
| `includeArchived` | boolean | No | Include archived projects |
| `first` | number | No | Number of projects to return \(default: 50\) |
| `after` | string | No | Cursor for pagination |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `projects` | array | Array of projects |
### `linear_get_project`
Get a single project by ID from Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Linear project ID |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `project` | object | The project with full details |
### `linear_create_project`
Create a new project in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `teamId` | string | Yes | Team ID to create the project in |
| `name` | string | Yes | Project name |
| `description` | string | No | Project description |
| `leadId` | string | No | User ID of the project lead |
| `startDate` | string | No | Project start date \(ISO format\) |
| `targetDate` | string | No | Project target date \(ISO format\) |
| `priority` | number | No | Project priority \(0-4\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `project` | object | The created project |
### `linear_update_project`
Update an existing project in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Project ID to update |
| `name` | string | No | New project name |
| `description` | string | No | New project description |
| `state` | string | No | Project state \(planned, started, completed, canceled\) |
| `leadId` | string | No | User ID of the project lead |
| `startDate` | string | No | Project start date \(ISO format\) |
| `targetDate` | string | No | Project target date \(ISO format\) |
| `priority` | number | No | Project priority \(0-4\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `project` | object | The updated project |
### `linear_archive_project`
Archive a project in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Project ID to archive |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the archive operation was successful |
| `projectId` | string | The ID of the archived project |
### `linear_list_users`
List all users in the Linear workspace
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `includeDisabled` | boolean | No | Include disabled/inactive users |
| `first` | number | No | Number of users to return \(default: 50\) |
| `after` | string | No | Cursor for pagination |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `users` | array | Array of workspace users |
### `linear_list_teams`
List all teams in the Linear workspace
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `first` | number | No | Number of teams to return \(default: 50\) |
| `after` | string | No | Cursor for pagination |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `teams` | array | Array of teams |
### `linear_get_viewer`
Get the currently authenticated user (viewer) information
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `user` | object | The currently authenticated user |
### `linear_list_labels`
List all labels in Linear workspace or team
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `teamId` | string | No | Filter by team ID |
| `first` | number | No | Number of labels to return \(default: 50\) |
| `after` | string | No | Cursor for pagination |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `labels` | array | Array of labels |
### `linear_create_label`
Create a new label in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `name` | string | Yes | Label name |
| `color` | string | No | Label color \(hex format, e.g., "#ff0000"\) |
| `description` | string | No | Label description |
| `teamId` | string | No | Team ID \(if omitted, creates workspace label\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `label` | object | The created label |
### `linear_update_label`
Update an existing label in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `labelId` | string | Yes | Label ID to update |
| `name` | string | No | New label name |
| `color` | string | No | New label color \(hex format\) |
| `description` | string | No | New label description |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `label` | object | The updated label |
### `linear_archive_label`
Archive a label in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `labelId` | string | Yes | Label ID to archive |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the archive operation was successful |
| `labelId` | string | The ID of the archived label |
### `linear_list_workflow_states`
List all workflow states (statuses) in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `teamId` | string | No | Filter by team ID |
| `first` | number | No | Number of states to return \(default: 50\) |
| `after` | string | No | Cursor for pagination |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `states` | array | Array of workflow states |
### `linear_create_workflow_state`
Create a new workflow state (status) in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `teamId` | string | Yes | Team ID to create the state in |
| `name` | string | Yes | State name \(e.g., "In Review"\) |
| `color` | string | Yes | State color \(hex format\) |
| `type` | string | Yes | State type: "backlog", "unstarted", "started", "completed", or "canceled" |
| `description` | string | No | State description |
| `position` | number | No | Position in the workflow |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `state` | object | The created workflow state |
### `linear_update_workflow_state`
Update an existing workflow state in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `stateId` | string | Yes | Workflow state ID to update |
| `name` | string | No | New state name |
| `color` | string | No | New state color \(hex format\) |
| `description` | string | No | New state description |
| `position` | number | No | New position in workflow |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `state` | object | The updated workflow state |
### `linear_list_cycles`
List cycles (sprints/iterations) in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `teamId` | string | No | Filter by team ID |
| `first` | number | No | Number of cycles to return \(default: 50\) |
| `after` | string | No | Cursor for pagination |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `cycles` | array | Array of cycles |
### `linear_get_cycle`
Get a single cycle by ID from Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `cycleId` | string | Yes | Cycle ID |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `cycle` | object | The cycle with full details |
### `linear_create_cycle`
Create a new cycle (sprint/iteration) in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `teamId` | string | Yes | Team ID to create the cycle in |
| `startsAt` | string | Yes | Cycle start date \(ISO format\) |
| `endsAt` | string | Yes | Cycle end date \(ISO format\) |
| `name` | string | No | Cycle name \(optional, will be auto-generated if not provided\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `cycle` | object | The created cycle |
### `linear_get_active_cycle`
Get the currently active cycle for a team
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `teamId` | string | Yes | Team ID |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `cycle` | object | The active cycle \(null if no active cycle\) |
### `linear_create_attachment`
Add an attachment to an issue in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `issueId` | string | Yes | Issue ID to attach to |
| `url` | string | Yes | URL of the attachment |
| `title` | string | No | Attachment title |
| `subtitle` | string | No | Attachment subtitle/description |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `attachment` | object | The created attachment |
### `linear_list_attachments`
List all attachments on an issue in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `issueId` | string | Yes | Issue ID |
| `first` | number | No | Number of attachments to return \(default: 50\) |
| `after` | string | No | Cursor for pagination |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `attachments` | array | Array of attachments |
### `linear_update_attachment`
Update an attachment metadata in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `attachmentId` | string | Yes | Attachment ID to update |
| `title` | string | No | New attachment title |
| `subtitle` | string | No | New attachment subtitle |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `attachment` | object | The updated attachment |
### `linear_delete_attachment`
Delete an attachment from Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `attachmentId` | string | Yes | Attachment ID to delete |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the delete operation was successful |
### `linear_create_issue_relation`
Link two issues together in Linear (blocks, relates to, duplicates)
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `issueId` | string | Yes | Source issue ID |
| `relatedIssueId` | string | Yes | Target issue ID to link to |
| `type` | string | Yes | Relation type: "blocks", "blocked", "duplicate", "related" |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `relation` | object | The created issue relation |
### `linear_list_issue_relations`
List all relations (dependencies) for an issue in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `issueId` | string | Yes | Issue ID |
| `first` | number | No | Number of relations to return \(default: 50\) |
| `after` | string | No | Cursor for pagination |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `relations` | array | Array of issue relations |
### `linear_delete_issue_relation`
Remove a relation between two issues in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `relationId` | string | Yes | Relation ID to delete |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the delete operation was successful |
### `linear_create_favorite`
Bookmark an issue, project, cycle, or label in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `issueId` | string | No | Issue ID to favorite |
| `projectId` | string | No | Project ID to favorite |
| `cycleId` | string | No | Cycle ID to favorite |
| `labelId` | string | No | Label ID to favorite |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `favorite` | object | The created favorite |
### `linear_list_favorites`
List all bookmarked items for the current user in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `first` | number | No | Number of favorites to return \(default: 50\) |
| `after` | string | No | Cursor for pagination |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `favorites` | array | Array of favorited items |
### `linear_create_project_update`
Post a status update for a project in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Project ID to post update for |
| `body` | string | Yes | Update message \(supports Markdown\) |
| `health` | string | No | Project health: "onTrack", "atRisk", or "offTrack" |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `update` | object | The created project update |
### `linear_list_project_updates`
List all status updates for a project in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Project ID |
| `first` | number | No | Number of updates to return \(default: 50\) |
| `after` | string | No | Cursor for pagination |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `updates` | array | Array of project updates |
### `linear_create_project_link`
Add an external link to a project in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Project ID to add link to |
| `url` | string | Yes | URL of the external link |
| `label` | string | No | Link label/title |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `link` | object | The created project link |
### `linear_list_notifications`
List notifications for the current user in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `first` | number | No | Number of notifications to return \(default: 50\) |
| `after` | string | No | Cursor for pagination |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `notifications` | array | Array of notifications |
### `linear_update_notification`
Mark a notification as read or unread in Linear
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `notificationId` | string | Yes | Notification ID to update |
| `readAt` | string | No | Timestamp to mark as read \(ISO format\). Pass null or omit to mark as unread |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `notification` | object | The updated notification |
## Notes
apps/docs/content/docs/en/tools/linkup.mdx
+8 -1
View File
@@ -59,8 +59,15 @@ Search the web for information using Linkup
| --------- | ---- | -------- | ----------- |
| `q` | string | Yes | The search query |
| `depth` | string | Yes | Search depth \(has to either be "standard" or "deep"\) |
| `outputType` | string | Yes | Type of output to return \(has to either be "sourcedAnswer" or "searchResults"\) |
| `outputType` | string | Yes | Type of output to return \(has to be "sourcedAnswer" or "searchResults"\) |
| `apiKey` | string | Yes | Enter your Linkup API key |
| `includeImages` | boolean | No | Whether to include images in search results |
| `fromDate` | string | No | Start date for filtering results \(YYYY-MM-DD format\) |
| `toDate` | string | No | End date for filtering results \(YYYY-MM-DD format\) |
| `excludeDomains` | string | No | Comma-separated list of domain names to exclude from search results |
| `includeDomains` | string | No | Comma-separated list of domain names to restrict search results to |
| `includeInlineCitations` | boolean | No | Add inline citations to answers \(only applies when outputType is "sourcedAnswer"\) |
| `includeSources` | boolean | No | Include sources in response |
#### Output
apps/docs/content/docs/en/tools/meta.json
+1
View File
@@ -57,6 +57,7 @@
"sms",
"stagehand",
"stagehand_agent",
"stripe",
"supabase",
"tavily",
"telegram",
apps/docs/content/docs/en/tools/microsoft_planner.mdx
+218 -2
View File
@@ -1,6 +1,6 @@
---
title: Microsoft Planner
description: Read and create tasks in Microsoft Planner
description: Manage tasks, plans, and buckets in Microsoft Planner
---
import { BlockInfoCard } from "@/components/ui/block-info-card"
@@ -122,7 +122,7 @@ In Sim, the Microsoft Planner integration allows your agents to programmatically
## Usage Instructions
Integrate Microsoft Planner into the workflow. Can read and create tasks.
Integrate Microsoft Planner into the workflow. Manage tasks, plans, buckets, and task details including checklists and references.
@@ -170,6 +170,222 @@ Create a new task in Microsoft Planner
| `task` | object | The created task object with all properties |
| `metadata` | object | Metadata including planId, taskId, and taskUrl |
### `microsoft_planner_update_task`
Update a task in Microsoft Planner
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `taskId` | string | Yes | The ID of the task to update |
| `etag` | string | Yes | The ETag value from the task to update \(If-Match header\) |
| `title` | string | No | The new title of the task |
| `bucketId` | string | No | The bucket ID to move the task to |
| `dueDateTime` | string | No | The due date and time for the task \(ISO 8601 format\) |
| `startDateTime` | string | No | The start date and time for the task \(ISO 8601 format\) |
| `percentComplete` | number | No | The percentage of task completion \(0-100\) |
| `priority` | number | No | The priority of the task \(0-10\) |
| `assigneeUserId` | string | No | The user ID to assign the task to |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the task was updated successfully |
| `task` | object | The updated task object with all properties |
| `metadata` | object | Metadata including taskId, planId, and taskUrl |
### `microsoft_planner_delete_task`
Delete a task from Microsoft Planner
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `taskId` | string | Yes | The ID of the task to delete |
| `etag` | string | Yes | The ETag value from the task to delete \(If-Match header\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the task was deleted successfully |
| `deleted` | boolean | Confirmation of deletion |
| `metadata` | object | Additional metadata |
### `microsoft_planner_list_plans`
List all plans in a Microsoft 365 group
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `groupId` | string | Yes | The ID of the Microsoft 365 group |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether plans were retrieved successfully |
| `plans` | array | Array of plan objects |
| `metadata` | object | Metadata including groupId and count |
### `microsoft_planner_read_plan`
Get details of a specific Microsoft Planner plan
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `planId` | string | Yes | The ID of the plan to retrieve |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the plan was retrieved successfully |
| `plan` | object | The plan object with all properties |
| `metadata` | object | Metadata including planId and planUrl |
### `microsoft_planner_list_buckets`
List all buckets in a Microsoft Planner plan
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `planId` | string | Yes | The ID of the plan |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether buckets were retrieved successfully |
| `buckets` | array | Array of bucket objects |
| `metadata` | object | Metadata including planId and count |
### `microsoft_planner_read_bucket`
Get details of a specific bucket
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `bucketId` | string | Yes | The ID of the bucket to retrieve |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the bucket was retrieved successfully |
| `bucket` | object | The bucket object with all properties |
| `metadata` | object | Metadata including bucketId and planId |
### `microsoft_planner_create_bucket`
Create a new bucket in a Microsoft Planner plan
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `planId` | string | Yes | The ID of the plan where the bucket will be created |
| `name` | string | Yes | The name of the bucket |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the bucket was created successfully |
| `bucket` | object | The created bucket object with all properties |
| `metadata` | object | Metadata including bucketId and planId |
### `microsoft_planner_update_bucket`
Update a bucket in Microsoft Planner
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `bucketId` | string | Yes | The ID of the bucket to update |
| `name` | string | No | The new name of the bucket |
| `etag` | string | Yes | The ETag value from the bucket to update \(If-Match header\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the bucket was updated successfully |
| `bucket` | object | The updated bucket object with all properties |
| `metadata` | object | Metadata including bucketId and planId |
### `microsoft_planner_delete_bucket`
Delete a bucket from Microsoft Planner
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `bucketId` | string | Yes | The ID of the bucket to delete |
| `etag` | string | Yes | The ETag value from the bucket to delete \(If-Match header\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the bucket was deleted successfully |
| `deleted` | boolean | Confirmation of deletion |
| `metadata` | object | Additional metadata |
### `microsoft_planner_get_task_details`
Get detailed information about a task including checklist and references
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `taskId` | string | Yes | The ID of the task |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the task details were retrieved successfully |
| `taskDetails` | object | The task details including description, checklist, and references |
| `metadata` | object | Metadata including taskId |
### `microsoft_planner_update_task_details`
Update task details including description, checklist items, and references in Microsoft Planner
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `taskId` | string | Yes | The ID of the task |
| `etag` | string | Yes | The ETag value from the task details to update \(If-Match header\) |
| `description` | string | No | The description of the task |
| `checklist` | object | No | Checklist items as a JSON object |
| `references` | object | No | References as a JSON object |
| `previewType` | string | No | Preview type: automatic, noPreview, checklist, description, or reference |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the task details were updated successfully |
| `taskDetails` | object | The updated task details object with all properties |
| `metadata` | object | Metadata including taskId |
## Notes
apps/docs/content/docs/en/tools/microsoft_teams.mdx
+205 -2
View File
@@ -1,6 +1,6 @@
---
title: Microsoft Teams
description: Read, write, and create messages
description: Manage messages, reactions, and members in Teams
---
import { BlockInfoCard } from "@/components/ui/block-info-card"
@@ -98,7 +98,7 @@ In Sim, the Microsoft Teams integration enables your agents to interact directly
## Usage Instructions
Integrate Microsoft Teams into the workflow. Can read and write chat messages, and read and write channel messages. Can be used in trigger mode to trigger a workflow when a message is sent to a chat or channel. To mention users in messages, wrap their name in `<at>` tags: `<at>userName</at>`
Integrate Microsoft Teams into the workflow. Read, write, update, and delete chat and channel messages. Reply to messages, add reactions, and list team/channel members. Can be used in trigger mode to trigger a workflow when a message is sent to a chat or channel. To mention users in messages, wrap their name in `<at>` tags: `<at>userName</at>`
@@ -202,6 +202,209 @@ Write or send a message to a Microsoft Teams channel
| `url` | string | Web URL to the message |
| `updatedContent` | boolean | Whether content was successfully updated |
### `microsoft_teams_update_chat_message`
Update an existing message in a Microsoft Teams chat
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `chatId` | string | Yes | The ID of the chat containing the message |
| `messageId` | string | Yes | The ID of the message to update |
| `content` | string | Yes | The new content for the message |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the update was successful |
| `messageId` | string | ID of the updated message |
| `updatedContent` | boolean | Whether content was successfully updated |
### `microsoft_teams_update_channel_message`
Update an existing message in a Microsoft Teams channel
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `teamId` | string | Yes | The ID of the team |
| `channelId` | string | Yes | The ID of the channel containing the message |
| `messageId` | string | Yes | The ID of the message to update |
| `content` | string | Yes | The new content for the message |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the update was successful |
| `messageId` | string | ID of the updated message |
| `updatedContent` | boolean | Whether content was successfully updated |
### `microsoft_teams_delete_chat_message`
Soft delete a message in a Microsoft Teams chat
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `chatId` | string | Yes | The ID of the chat containing the message |
| `messageId` | string | Yes | The ID of the message to delete |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the deletion was successful |
| `deleted` | boolean | Confirmation of deletion |
| `messageId` | string | ID of the deleted message |
### `microsoft_teams_delete_channel_message`
Soft delete a message in a Microsoft Teams channel
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `teamId` | string | Yes | The ID of the team |
| `channelId` | string | Yes | The ID of the channel containing the message |
| `messageId` | string | Yes | The ID of the message to delete |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the deletion was successful |
| `deleted` | boolean | Confirmation of deletion |
| `messageId` | string | ID of the deleted message |
### `microsoft_teams_reply_to_message`
Reply to an existing message in a Microsoft Teams channel
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `teamId` | string | Yes | The ID of the team |
| `channelId` | string | Yes | The ID of the channel |
| `messageId` | string | Yes | The ID of the message to reply to |
| `content` | string | Yes | The reply content |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the reply was successful |
| `messageId` | string | ID of the reply message |
| `updatedContent` | boolean | Whether content was successfully sent |
### `microsoft_teams_get_message`
Get a specific message from a Microsoft Teams chat or channel
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `teamId` | string | No | The ID of the team \(for channel messages\) |
| `channelId` | string | No | The ID of the channel \(for channel messages\) |
| `chatId` | string | No | The ID of the chat \(for chat messages\) |
| `messageId` | string | Yes | The ID of the message to retrieve |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the retrieval was successful |
| `content` | string | The message content |
| `metadata` | object | Message metadata including sender, timestamp, etc. |
### `microsoft_teams_set_reaction`
Add an emoji reaction to a message in Microsoft Teams
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `teamId` | string | No | The ID of the team \(for channel messages\) |
| `channelId` | string | No | The ID of the channel \(for channel messages\) |
| `chatId` | string | No | The ID of the chat \(for chat messages\) |
| `messageId` | string | Yes | The ID of the message to react to |
| `reactionType` | string | Yes | The emoji reaction \(e.g., ❤️, 👍, 😊\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the reaction was added successfully |
| `reactionType` | string | The emoji that was added |
| `messageId` | string | ID of the message |
### `microsoft_teams_unset_reaction`
Remove an emoji reaction from a message in Microsoft Teams
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `teamId` | string | No | The ID of the team \(for channel messages\) |
| `channelId` | string | No | The ID of the channel \(for channel messages\) |
| `chatId` | string | No | The ID of the chat \(for chat messages\) |
| `messageId` | string | Yes | The ID of the message |
| `reactionType` | string | Yes | The emoji reaction to remove \(e.g., ❤️, 👍, 😊\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the reaction was removed successfully |
| `reactionType` | string | The emoji that was removed |
| `messageId` | string | ID of the message |
### `microsoft_teams_list_team_members`
List all members of a Microsoft Teams team
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `teamId` | string | Yes | The ID of the team |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the listing was successful |
| `members` | array | Array of team members |
| `memberCount` | number | Total number of members |
### `microsoft_teams_list_channel_members`
List all members of a Microsoft Teams channel
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `teamId` | string | Yes | The ID of the team |
| `channelId` | string | Yes | The ID of the channel |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the listing was successful |
| `members` | array | Array of channel members |
| `memberCount` | number | Total number of members |
## Notes
apps/docs/content/docs/en/tools/parallel_ai.mdx
+47 -2
View File
@@ -1,6 +1,6 @@
---
title: Parallel AI
description: Search with Parallel AI
description: Web research with Parallel AI
---
import { BlockInfoCard } from "@/components/ui/block-info-card"
@@ -71,7 +71,7 @@ In Sim, the Parallel AI integration empowers your agents to perform web searches
## Usage Instructions
Integrate Parallel AI into the workflow. Can search the web.
Integrate Parallel AI into the workflow. Can search the web, extract information from URLs, and conduct deep research.
@@ -98,6 +98,51 @@ Search the web using Parallel AI. Provides comprehensive search results with int
| --------- | ---- | ----------- |
| `results` | array | Search results with excerpts from relevant pages |
### `parallel_extract`
Extract targeted information from specific URLs using Parallel AI. Processes provided URLs to pull relevant content based on your objective.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `urls` | string | Yes | Comma-separated list of URLs to extract information from |
| `objective` | string | Yes | What information to extract from the provided URLs |
| `excerpts` | boolean | Yes | Include relevant excerpts from the content |
| `full_content` | boolean | Yes | Include full page content |
| `apiKey` | string | Yes | Parallel AI API Key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `results` | array | Extracted information from the provided URLs |
### `parallel_deep_research`
Conduct comprehensive deep research across the web using Parallel AI. Synthesizes information from multiple sources with citations. Can take up to 15 minutes to complete.
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `input` | string | Yes | Research query or question \(up to 15,000 characters\) |
| `processor` | string | No | Compute level: base, lite, pro, ultra, ultra2x, ultra4x, ultra8x \(default: base\) |
| `output_schema` | string | No | Desired output format description. Use "text" for markdown reports with citations, or describe structured JSON format |
| `include_domains` | string | No | Comma-separated list of domains to restrict research to \(source policy\) |
| `exclude_domains` | string | No | Comma-separated list of domains to exclude from research \(source policy\) |
| `apiKey` | string | Yes | Parallel AI API Key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `status` | string | Task status \(running, completed, failed\) |
| `run_id` | string | Unique ID for this research task |
| `message` | string | Status message \(for running tasks\) |
| `content` | object | Research results \(structured based on output_schema\) |
| `basis` | array | Citations and sources with excerpts and confidence levels |
## Notes
apps/docs/content/docs/en/tools/reddit.mdx
+238 -1
View File
@@ -39,7 +39,7 @@ These operations let your agents access and analyze Reddit content as part of yo
## Usage Instructions
Integrate Reddit into the workflow. Can get posts and comments from a subreddit.
Integrate Reddit into workflows. Read posts, comments, and search content. Submit posts, vote, reply, edit, and manage your Reddit account.
@@ -57,6 +57,11 @@ Fetch posts from a subreddit with different sorting options
| `sort` | string | No | Sort method for posts: "hot", "new", "top", or "rising" \(default: "hot"\) |
| `limit` | number | No | Maximum number of posts to return \(default: 10, max: 100\) |
| `time` | string | No | Time filter for "top" sorted posts: "day", "week", "month", "year", or "all" \(default: "day"\) |
| `after` | string | No | Fullname of a thing to fetch items after \(for pagination\) |
| `before` | string | No | Fullname of a thing to fetch items before \(for pagination\) |
| `count` | number | No | A count of items already seen in the listing \(used for numbering\) |
| `show` | string | No | Show items that would normally be filtered \(e.g., "all"\) |
| `sr_detail` | boolean | No | Expand subreddit details in the response |
#### Output
@@ -77,6 +82,16 @@ Fetch comments from a specific Reddit post
| `subreddit` | string | Yes | The subreddit where the post is located \(without the r/ prefix\) |
| `sort` | string | No | Sort method for comments: "confidence", "top", "new", "controversial", "old", "random", "qa" \(default: "confidence"\) |
| `limit` | number | No | Maximum number of comments to return \(default: 50, max: 100\) |
| `depth` | number | No | Maximum depth of subtrees in the thread \(controls nested comment levels\) |
| `context` | number | No | Number of parent comments to include |
| `showedits` | boolean | No | Show edit information for comments |
| `showmore` | boolean | No | Include "load more comments" elements in the response |
| `showtitle` | boolean | No | Include submission title in the response |
| `threaded` | boolean | No | Return comments in threaded/nested format |
| `truncate` | number | No | Integer to truncate comment depth |
| `after` | string | No | Fullname of a thing to fetch items after \(for pagination\) |
| `before` | string | No | Fullname of a thing to fetch items before \(for pagination\) |
| `count` | number | No | A count of items already seen in the listing \(used for numbering\) |
#### Output
@@ -84,6 +99,228 @@ Fetch comments from a specific Reddit post
| --------- | ---- | ----------- |
| `post` | object | Post information including ID, title, author, content, and metadata |
### `reddit_get_controversial`
Fetch controversial posts from a subreddit
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `subreddit` | string | Yes | The name of the subreddit to fetch posts from \(without the r/ prefix\) |
| `time` | string | No | Time filter for controversial posts: "hour", "day", "week", "month", "year", or "all" \(default: "all"\) |
| `limit` | number | No | Maximum number of posts to return \(default: 10, max: 100\) |
| `after` | string | No | Fullname of a thing to fetch items after \(for pagination\) |
| `before` | string | No | Fullname of a thing to fetch items before \(for pagination\) |
| `count` | number | No | A count of items already seen in the listing \(used for numbering\) |
| `show` | string | No | Show items that would normally be filtered \(e.g., "all"\) |
| `sr_detail` | boolean | No | Expand subreddit details in the response |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `subreddit` | string | Name of the subreddit where posts were fetched from |
| `posts` | array | Array of controversial posts with title, author, URL, score, comments count, and metadata |
### `reddit_get_gilded`
Fetch gilded/awarded posts from a subreddit
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `subreddit` | string | Yes | The name of the subreddit to fetch posts from \(without the r/ prefix\) |
| `limit` | number | No | Maximum number of posts to return \(default: 10, max: 100\) |
| `after` | string | No | Fullname of a thing to fetch items after \(for pagination\) |
| `before` | string | No | Fullname of a thing to fetch items before \(for pagination\) |
| `count` | number | No | A count of items already seen in the listing \(used for numbering\) |
| `show` | string | No | Show items that would normally be filtered \(e.g., "all"\) |
| `sr_detail` | boolean | No | Expand subreddit details in the response |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `subreddit` | string | Name of the subreddit where posts were fetched from |
| `posts` | array | Array of gilded/awarded posts with title, author, URL, score, comments count, and metadata |
### `reddit_search`
Search for posts within a subreddit
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `subreddit` | string | Yes | The name of the subreddit to search in \(without the r/ prefix\) |
| `query` | string | Yes | Search query text |
| `sort` | string | No | Sort method for search results: "relevance", "hot", "top", "new", or "comments" \(default: "relevance"\) |
| `time` | string | No | Time filter for search results: "hour", "day", "week", "month", "year", or "all" \(default: "all"\) |
| `limit` | number | No | Maximum number of posts to return \(default: 10, max: 100\) |
| `restrict_sr` | boolean | No | Restrict search to the specified subreddit only \(default: true\) |
| `after` | string | No | Fullname of a thing to fetch items after \(for pagination\) |
| `before` | string | No | Fullname of a thing to fetch items before \(for pagination\) |
| `count` | number | No | A count of items already seen in the listing \(used for numbering\) |
| `show` | string | No | Show items that would normally be filtered \(e.g., "all"\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `subreddit` | string | Name of the subreddit where search was performed |
| `posts` | array | Array of search result posts with title, author, URL, score, comments count, and metadata |
### `reddit_submit_post`
Submit a new post to a subreddit (text or link)
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `subreddit` | string | Yes | The name of the subreddit to post to \(without the r/ prefix\) |
| `title` | string | Yes | Title of the submission \(max 300 characters\) |
| `text` | string | No | Text content for a self post \(markdown supported\) |
| `url` | string | No | URL for a link post \(cannot be used with text\) |
| `nsfw` | boolean | No | Mark post as NSFW |
| `spoiler` | boolean | No | Mark post as spoiler |
| `send_replies` | boolean | No | Send reply notifications to inbox \(default: true\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the post was submitted successfully |
| `message` | string | Success or error message |
| `data` | object | Post data including ID, name, URL, and permalink |
### `reddit_vote`
Upvote, downvote, or unvote a Reddit post or comment
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | string | Yes | Thing fullname to vote on \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) |
| `dir` | number | Yes | Vote direction: 1 \(upvote\), 0 \(unvote\), or -1 \(downvote\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the vote was successful |
| `message` | string | Success or error message |
### `reddit_save`
Save a Reddit post or comment to your saved items
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | string | Yes | Thing fullname to save \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) |
| `category` | string | No | Category to save under \(Reddit Gold feature\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the save was successful |
| `message` | string | Success or error message |
### `reddit_unsave`
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `subreddit` | string | Subreddit name |
| `posts` | json | Posts data |
| `post` | json | Single post data |
| `comments` | json | Comments data |
### `reddit_reply`
Add a comment reply to a Reddit post or comment
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `parent_id` | string | Yes | Thing fullname to reply to \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) |
| `text` | string | Yes | Comment text in markdown format |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the reply was posted successfully |
| `message` | string | Success or error message |
| `data` | object | Comment data including ID, name, permalink, and body |
### `reddit_edit`
Edit the text of your own Reddit post or comment
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `thing_id` | string | Yes | Thing fullname to edit \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) |
| `text` | string | Yes | New text content in markdown format |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the edit was successful |
| `message` | string | Success or error message |
| `data` | object | Updated content data |
### `reddit_delete`
Delete your own Reddit post or comment
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | string | Yes | Thing fullname to delete \(e.g., t3_xxxxx for post, t1_xxxxx for comment\) |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the deletion was successful |
| `message` | string | Success or error message |
### `reddit_subscribe`
Subscribe or unsubscribe from a subreddit
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `subreddit` | string | Yes | The name of the subreddit \(without the r/ prefix\) |
| `action` | string | Yes | Action to perform: "sub" to subscribe or "unsub" to unsubscribe |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `success` | boolean | Whether the subscription action was successful |
| `message` | string | Success or error message |
## Notes
apps/docs/content/docs/en/tools/stripe.mdx
+1070
View File
File diff suppressed because it is too large Load Diff
apps/docs/content/docs/en/tools/supabase.mdx
+299 -1
View File
@@ -76,7 +76,7 @@ Whether you’re building internal tools, automating business processes, or powe
## Usage Instructions
Integrate Supabase into the workflow. Can get many rows, get, create, update, delete, and upsert a row.
Integrate Supabase into the workflow. Supports database operations (query, insert, update, delete, upsert), full-text search, RPC functions, row counting, vector search, and complete storage management (upload, download, list, move, copy, delete files and buckets).
@@ -205,6 +205,51 @@ Insert or update data in a Supabase table (upsert operation)
| `message` | string | Operation status message |
| `results` | array | Array of upserted records |
### `supabase_count`
Count rows in a Supabase table
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
| `table` | string | Yes | The name of the Supabase table to count rows from |
| `filter` | string | No | PostgREST filter \(e.g., "status=eq.active"\) |
| `countType` | string | No | Count type: exact, planned, or estimated \(default: exact\) |
| `apiKey` | string | Yes | Your Supabase service role secret key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Operation status message |
| `count` | number | Number of rows matching the filter |
### `supabase_text_search`
Perform full-text search on a Supabase table
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
| `table` | string | Yes | The name of the Supabase table to search |
| `column` | string | Yes | The column to search in |
| `query` | string | Yes | The search query |
| `searchType` | string | No | Search type: plain, phrase, or websearch \(default: websearch\) |
| `language` | string | No | Language for text search configuration \(default: english\) |
| `limit` | number | No | Maximum number of rows to return |
| `apiKey` | string | Yes | Your Supabase service role secret key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Operation status message |
| `results` | array | Array of records matching the search query |
### `supabase_vector_search`
Perform similarity search using pgvector in a Supabase table
@@ -227,6 +272,259 @@ Perform similarity search using pgvector in a Supabase table
| `message` | string | Operation status message |
| `results` | array | Array of records with similarity scores from the vector search. Each record includes a similarity field \(0-1\) indicating how similar it is to the query vector. |
### `supabase_rpc`
Call a PostgreSQL function in Supabase
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
| `functionName` | string | Yes | The name of the PostgreSQL function to call |
| `apiKey` | string | Yes | Your Supabase service role secret key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Operation status message |
| `results` | json | Result returned from the function |
### `supabase_storage_upload`
Upload a file to a Supabase storage bucket
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
| `bucket` | string | Yes | The name of the storage bucket |
| `path` | string | Yes | The path where the file will be stored \(e.g., "folder/file.jpg"\) |
| `fileContent` | string | Yes | The file content \(base64 encoded for binary files, or plain text\) |
| `contentType` | string | No | MIME type of the file \(e.g., "image/jpeg", "text/plain"\) |
| `upsert` | boolean | No | If true, overwrites existing file \(default: false\) |
| `apiKey` | string | Yes | Your Supabase service role secret key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Operation status message |
| `results` | object | Upload result including file path and metadata |
### `supabase_storage_download`
Download a file from a Supabase storage bucket
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
| `bucket` | string | Yes | The name of the storage bucket |
| `path` | string | Yes | The path to the file to download \(e.g., "folder/file.jpg"\) |
| `apiKey` | string | Yes | Your Supabase service role secret key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Operation status message |
| `fileContent` | string | File content \(base64 encoded if binary, plain text otherwise\) |
| `contentType` | string | MIME type of the file |
| `isBase64` | boolean | Whether the file content is base64 encoded |
### `supabase_storage_list`
List files in a Supabase storage bucket
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
| `bucket` | string | Yes | The name of the storage bucket |
| `path` | string | No | The folder path to list files from \(default: root\) |
| `limit` | number | No | Maximum number of files to return \(default: 100\) |
| `offset` | number | No | Number of files to skip \(for pagination\) |
| `sortBy` | string | No | Column to sort by: name, created_at, updated_at \(default: name\) |
| `sortOrder` | string | No | Sort order: asc or desc \(default: asc\) |
| `search` | string | No | Search term to filter files by name |
| `apiKey` | string | Yes | Your Supabase service role secret key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Operation status message |
| `results` | array | Array of file objects with metadata |
### `supabase_storage_delete`
Delete files from a Supabase storage bucket
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
| `bucket` | string | Yes | The name of the storage bucket |
| `paths` | array | Yes | Array of file paths to delete \(e.g., \["folder/file1.jpg", "folder/file2.jpg"\]\) |
| `apiKey` | string | Yes | Your Supabase service role secret key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Operation status message |
| `results` | array | Array of deleted file objects |
### `supabase_storage_move`
Move a file within a Supabase storage bucket
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
| `bucket` | string | Yes | The name of the storage bucket |
| `fromPath` | string | Yes | The current path of the file \(e.g., "folder/old.jpg"\) |
| `toPath` | string | Yes | The new path for the file \(e.g., "newfolder/new.jpg"\) |
| `apiKey` | string | Yes | Your Supabase service role secret key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Operation status message |
| `results` | object | Move operation result |
### `supabase_storage_copy`
Copy a file within a Supabase storage bucket
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
| `bucket` | string | Yes | The name of the storage bucket |
| `fromPath` | string | Yes | The path of the source file \(e.g., "folder/source.jpg"\) |
| `toPath` | string | Yes | The path for the copied file \(e.g., "folder/copy.jpg"\) |
| `apiKey` | string | Yes | Your Supabase service role secret key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Operation status message |
| `results` | object | Copy operation result |
### `supabase_storage_create_bucket`
Create a new storage bucket in Supabase
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
| `bucket` | string | Yes | The name of the bucket to create |
| `isPublic` | boolean | No | Whether the bucket should be publicly accessible \(default: false\) |
| `fileSizeLimit` | number | No | Maximum file size in bytes \(optional\) |
| `allowedMimeTypes` | array | No | Array of allowed MIME types \(e.g., \["image/png", "image/jpeg"\]\) |
| `apiKey` | string | Yes | Your Supabase service role secret key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Operation status message |
| `results` | object | Created bucket information |
### `supabase_storage_list_buckets`
List all storage buckets in Supabase
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
| `apiKey` | string | Yes | Your Supabase service role secret key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Operation status message |
| `results` | array | Array of bucket objects |
### `supabase_storage_delete_bucket`
Delete a storage bucket in Supabase
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
| `bucket` | string | Yes | The name of the bucket to delete |
| `apiKey` | string | Yes | Your Supabase service role secret key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Operation status message |
| `results` | object | Delete operation result |
### `supabase_storage_get_public_url`
Get the public URL for a file in a Supabase storage bucket
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
| `bucket` | string | Yes | The name of the storage bucket |
| `path` | string | Yes | The path to the file \(e.g., "folder/file.jpg"\) |
| `download` | boolean | No | If true, forces download instead of inline display \(default: false\) |
| `apiKey` | string | Yes | Your Supabase service role secret key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Operation status message |
| `publicUrl` | string | The public URL to access the file |
### `supabase_storage_create_signed_url`
Create a temporary signed URL for a file in a Supabase storage bucket
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `projectId` | string | Yes | Your Supabase project ID \(e.g., jdrkgepadsdopsntdlom\) |
| `bucket` | string | Yes | The name of the storage bucket |
| `path` | string | Yes | The path to the file \(e.g., "folder/file.jpg"\) |
| `expiresIn` | number | Yes | Number of seconds until the URL expires \(e.g., 3600 for 1 hour\) |
| `download` | boolean | No | If true, forces download instead of inline display \(default: false\) |
| `apiKey` | string | Yes | Your Supabase service role secret key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `message` | string | Operation status message |
| `signedUrl` | string | The temporary signed URL to access the file |
## Notes
apps/docs/content/docs/en/tools/tavily.mdx
+76
View File
@@ -74,6 +74,21 @@ Perform AI-powered web searches using Tavily
| --------- | ---- | -------- | ----------- |
| `query` | string | Yes | The search query to execute |
| `max_results` | number | No | Maximum number of results \(1-20\) |
| `topic` | string | No | Category type: general, news, or finance \(default: general\) |
| `search_depth` | string | No | Search scope: basic \(1 credit\) or advanced \(2 credits\) \(default: basic\) |
| `include_answer` | string | No | LLM-generated response: true/basic for quick answer or advanced for detailed |
| `include_raw_content` | string | No | Parsed HTML content: true/markdown or text format |
| `include_images` | boolean | No | Include image search results |
| `include_image_descriptions` | boolean | No | Add descriptive text for images |
| `include_favicon` | boolean | No | Include favicon URLs |
| `chunks_per_source` | number | No | Maximum number of relevant chunks per source \(1-3, default: 3\) |
| `time_range` | string | No | Filter by recency: day/d, week/w, month/m, year/y |
| `start_date` | string | No | Earliest publication date \(YYYY-MM-DD format\) |
| `end_date` | string | No | Latest publication date \(YYYY-MM-DD format\) |
| `include_domains` | string | No | Comma-separated list of domains to whitelist \(max 300\) |
| `exclude_domains` | string | No | Comma-separated list of domains to blacklist \(max 150\) |
| `country` | string | No | Boost results from specified country \(general topic only\) |
| `auto_parameters` | boolean | No | Automatic parameter configuration based on query intent |
| `apiKey` | string | Yes | Tavily API Key |
#### Output
@@ -93,6 +108,9 @@ Extract raw content from multiple web pages simultaneously using Tavily
| --------- | ---- | -------- | ----------- |
| `urls` | string | Yes | URL or array of URLs to extract content from |
| `extract_depth` | string | No | The depth of extraction \(basic=1 credit/5 URLs, advanced=2 credits/5 URLs\) |
| `format` | string | No | Output format: markdown or text \(default: markdown\) |
| `include_images` | boolean | No | Incorporate images in extraction output |
| `include_favicon` | boolean | No | Add favicon URL for each result |
| `apiKey` | string | Yes | Tavily API Key |
#### Output
@@ -101,6 +119,64 @@ Extract raw content from multiple web pages simultaneously using Tavily
| --------- | ---- | ----------- |
| `results` | array | The URL that was extracted |
### `tavily_crawl`
Systematically crawl and extract content from websites using Tavily
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `url` | string | Yes | The root URL to begin the crawl |
| `instructions` | string | No | Natural language directions for the crawler \(costs 2 credits per 10 pages\) |
| `max_depth` | number | No | How far from base URL to explore \(1-5, default: 1\) |
| `max_breadth` | number | No | Links followed per page level \(≥1, default: 20\) |
| `limit` | number | No | Total links processed before stopping \(≥1, default: 50\) |
| `select_paths` | string | No | Comma-separated regex patterns to include specific URL paths \(e.g., /docs/.*\) |
| `select_domains` | string | No | Comma-separated regex patterns to restrict crawling to certain domains |
| `exclude_paths` | string | No | Comma-separated regex patterns to skip specific URL paths |
| `exclude_domains` | string | No | Comma-separated regex patterns to block certain domains |
| `allow_external` | boolean | No | Include external domain links in results \(default: true\) |
| `include_images` | boolean | No | Incorporate images in crawl output |
| `extract_depth` | string | No | Extraction depth: basic \(1 credit/5 pages\) or advanced \(2 credits/5 pages\) |
| `format` | string | No | Output format: markdown or text \(default: markdown\) |
| `include_favicon` | boolean | No | Add favicon URL for each result |
| `apiKey` | string | Yes | Tavily API Key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `base_url` | string | The base URL that was crawled |
| `results` | array | The crawled page URL |
### `tavily_map`
Discover and visualize website structure using Tavily
#### Input
| Parameter | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `url` | string | Yes | The root URL to begin mapping |
| `instructions` | string | No | Natural language guidance for mapping behavior \(costs 2 credits per 10 pages\) |
| `max_depth` | number | No | How far from base URL to explore \(1-5, default: 1\) |
| `max_breadth` | number | No | Links to follow per level \(default: 20\) |
| `limit` | number | No | Total links to process \(default: 50\) |
| `select_paths` | string | No | Comma-separated regex patterns for URL path filtering \(e.g., /docs/.*\) |
| `select_domains` | string | No | Comma-separated regex patterns to restrict mapping to specific domains |
| `exclude_paths` | string | No | Comma-separated regex patterns to exclude specific URL paths |
| `exclude_domains` | string | No | Comma-separated regex patterns to exclude domains |
| `allow_external` | boolean | No | Include external domain links in results \(default: true\) |
| `apiKey` | string | Yes | Tavily API Key |
#### Output
| Parameter | Type | Description |
| --------- | ---- | ----------- |
| `base_url` | string | The base URL that was mapped |
| `results` | array | Discovered URL |
## Notes