Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
| 1 | import { Array as Arr, Effect, Option } from 'effect'; |
| 2 | import { ComposioToolkitsRepository } from 'src/services/composio-clients'; |
| 3 | import { TerminalUI } from 'src/services/terminal-ui'; |
| 4 | import { clampLimit } from 'src/ui/clamp-limit'; |
| 5 | import { formatToolsJson } from '../format'; |
| 6 | import { |
| 7 | FETCHING_TOOLS_MESSAGE, |
| 8 | formatToolsListing, |
| 9 | inspectToolHint, |
| 10 | noToolsFoundMessage, |
| 11 | } from './tools.list.format'; |
| 12 | |
| 13 | /** The arguments and flags of `composio tools list`. */ |
| 14 | export type ToolsListParams = { |
| 15 | readonly toolkit: string; |
| 16 | readonly query: Option.Option<string>; |
| 17 | readonly tags: Option.Option<string>; |
| 18 | readonly limit: number; |
| 19 | }; |
| 20 | |
| 21 | /** |
| 22 | * List available tools for a toolkit with optional filters. Prints the first page only. |
| 23 | * |
| 24 | * @example |
| 25 | * ```bash |
| 26 | * composio tools list gmail |
| 27 | * composio tools list gmail --query "send email" |
| 28 | * composio tools list gmail --tags "important" --limit 10 |
| 29 | * ``` |
| 30 | */ |
| 31 | export const runToolsList = ({ toolkit, query, tags, limit }: ToolsListParams) => |
| 32 | Effect.gen(function* () { |
| 33 | const ui = yield* TerminalUI; |
| 34 | const repo = yield* ComposioToolkitsRepository; |
| 35 | |
| 36 | const result = yield* ui.withSpinner( |
| 37 | FETCHING_TOOLS_MESSAGE, |
| 38 | repo.searchTools({ |
| 39 | search: Option.getOrUndefined(query), |
| 40 | toolkit_slug: toolkit, |
| 41 | tags: Option.getOrUndefined(tags), |
| 42 | limit: clampLimit(limit), |
| 43 | }) |
| 44 | ); |
| 45 | |
| 46 | yield* Arr.match(result.items, { |
| 47 | onEmpty: () => ui.log.warn(noToolsFoundMessage(toolkit)), |
| 48 | onNonEmpty: tools => |
| 49 | Effect.gen(function* () { |
| 50 | yield* ui.log.info(formatToolsListing(tools, result.total_pages)); |
| 51 | |
| 52 | const firstSlug = Arr.headNonEmpty(tools).slug; |
| 53 | if (firstSlug) { |
| 54 | yield* ui.log.step(inspectToolHint(firstSlug)); |
| 55 | } |
| 56 | |
| 57 | yield* ui.output(formatToolsJson(tools)); |
| 58 | }), |
| 59 | }); |
| 60 | }); |