Skip to content

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

fix(cli): improve error UX for toolkits info command

jkomyno65bf97b271b8
diff --git a/ts/packages/cli/src/commands/toolkits/commands/toolkits.info.cmd.ts b/ts/packages/cli/src/commands/toolkits/commands/toolkits.info.cmd.ts
index 7118f4c05..ea75fc8cc 100644
--- a/ts/packages/cli/src/commands/toolkits/commands/toolkits.info.cmd.ts
+++ b/ts/packages/cli/src/commands/toolkits/commands/toolkits.info.cmd.ts
@@ -6,7 +6,10 @@ import { TerminalUI } from 'src/services/terminal-ui';
import type { ToolkitDetailed, AuthConfigDetail } from 'src/models/toolkits';
import { bold, gray } from 'src/ui/colors';
-const slug = Args.text({ name: 'slug' }).pipe(Args.withDescription('Toolkit slug (e.g. "gmail")'));
+const slug = Args.text({ name: 'slug' }).pipe(
+ Args.withDescription('Toolkit slug (e.g. "gmail")'),
+ Args.optional
+);
/**
* Format auth config fields for display.
@@ -96,30 +99,41 @@ export const toolkitsCmd$Info = Command.make('info', { slug }, ({ slug }) =>
return;
}
+ // Missing slug guard
+ if (Option.isNone(slug)) {
+ yield* ui.log.warn('Missing required argument: <slug>');
+ yield* ui.log.step('Try specifying a toolkit slug, e.g.:\n> composio toolkits info "gmail"');
+ return;
+ }
+
+ const slugValue = slug.value;
+
const toolkit = yield* ui
- .withSpinner(`Fetching toolkit "${slug}"...`, repo.getToolkitDetailed(slug))
+ .withSpinner(`Fetching toolkit "${slugValue}"...`, repo.getToolkitDetailed(slugValue))
.pipe(
Effect.catchTag('services/HttpServerError', (e: HttpServerError) =>
Effect.gen(function* () {
- if (e.status === 404) {
- // Try to suggest similar toolkits
- const suggestions = yield* repo.searchToolkits({ search: slug, limit: 3 }).pipe(
- Effect.map(r => r.items),
- Effect.catchAll(() => Effect.succeed([]))
- );
+ // Show structured error message and suggested fix from the API
+ if (e.details) {
+ yield* ui.log.error(e.details.message);
+ yield* ui.log.step(e.details.suggestedFix);
+ } else {
+ yield* ui.log.error(`Failed to fetch toolkit "${slugValue}".`);
+ }
- if (suggestions.length > 0) {
- const suggestionLines = suggestions
- .map(s => ` ${s.slug} — ${s.meta.description}`)
- .join('\n');
- yield* ui.log.error(
- `Toolkit "${slug}" not found.\n\nDid you mean?\n${suggestionLines}\n\n> composio toolkits info "${suggestions[0]!.slug}"`
- );
- } else {
- yield* ui.log.error(`Toolkit "${slug}" not found.`);
- }
-
- return yield* Effect.fail(e);
+ // Try to suggest similar toolkits
+ const suggestions = yield* repo.searchToolkits({ search: slugValue, limit: 3 }).pipe(
+ Effect.map(r => r.items),
+ Effect.catchAll(() => Effect.succeed([]))
+ );
+
+ if (suggestions.length > 0) {
+ const suggestionLines = suggestions
+ .map(s => ` ${s.slug} — ${s.meta.description}`)
+ .join('\n');
+ yield* ui.log.step(
+ `Did you mean?\n${suggestionLines}\n\n> composio toolkits info "${suggestions[0]!.slug}"`
+ );
}
return yield* Effect.fail(e);
diff --git a/ts/packages/cli/src/services/composio-clients.ts b/ts/packages/cli/src/services/composio-clients.ts
index 3e62c30cd..671b6c808 100644
--- a/ts/packages/cli/src/services/composio-clients.ts
+++ b/ts/packages/cli/src/services/composio-clients.ts
@@ -36,12 +36,22 @@ import { renderPrettyError } from './utils/pretty-error';
* Error types
*/
+/**
+ * Structured error details from the Composio API.
+ */
+export interface HttpErrorDetails {
+ readonly message: string;
+ readonly suggestedFix: string;
+ readonly code: number;
+}
+
/**
* Error thrown when a HTTP request fails.
*/
export class HttpServerError extends Data.TaggedError('services/HttpServerError')<{
readonly cause?: unknown;
readonly status?: number;
+ readonly details?: HttpErrorDetails;
}> {}
/**
@@ -347,6 +357,11 @@ const handleHttpErrorResponse = (response: Response): Effect.Effect<never, HttpS
new HttpServerError({
cause: `HTTP ${status}\n${pretty}`,
status,
+ details: {
+ message: error.message,
+ suggestedFix: error.suggested_fix,
+ code: error.code,
+ },
})
);
}
diff --git a/ts/packages/cli/test/src/commands/$default.cmd.test.ts b/ts/packages/cli/test/src/commands/$default.cmd.test.ts
index 1eb9b1115..1bcb54fc0 100644
--- a/ts/packages/cli/test/src/commands/$default.cmd.test.ts
+++ b/ts/packages/cli/test/src/commands/$default.cmd.test.ts
@@ -88,7 +88,7 @@ describe('CLI: composio', () => {
- toolkits list [--query text] [--category text] [--limit integer] List available toolkits.
- - toolkits info <slug> View details of a specific toolkit.
+ - toolkits info [<slug>] View details of a specific toolkit.
- toolkits search [--limit integer] <query> Search toolkits by use case.
"
diff --git a/ts/packages/cli/test/src/commands/toolkits/toolkits.info.cmd.test.ts b/ts/packages/cli/test/src/commands/toolkits/toolkits.info.cmd.test.ts
index e260a9497..da6c96a73 100644
--- a/ts/packages/cli/test/src/commands/toolkits/toolkits.info.cmd.test.ts
+++ b/ts/packages/cli/test/src/commands/toolkits/toolkits.info.cmd.test.ts
@@ -160,7 +160,41 @@ describe('CLI: composio toolkits info', () => {
const lines = yield* MockConsole.getLines({ stripAnsi: true });
const output = lines.join('\n');
- expect(output).toContain('not found');
+ expect(output).toContain('Failed to fetch toolkit "gmal"');
+ })
+ );
+ }
+ );
+
+ layer(TestLive({ baseConfigProvider: testConfigProvider, toolkitsData }))(
+ '[Given] invalid slug with substring match',
+ it => {
+ it.scoped('shows error with suggestion', () =>
+ Effect.gen(function* () {
+ // "gma" is a substring of "gmail", so the mock will find suggestions
+ const result = yield* cli(['toolkits', 'info', 'gma']).pipe(Effect.either);
+ const lines = yield* MockConsole.getLines({ stripAnsi: true });
+ const output = lines.join('\n');
+
+ expect(output).toContain('Failed to fetch toolkit "gma"');
+ expect(output).toContain('Did you mean?');
+ expect(output).toContain('gmail');
+ })
+ );
+ }
+ );
+
+ layer(TestLive({ baseConfigProvider: testConfigProvider, toolkitsData }))(
+ '[Given] no slug argument',
+ it => {
+ it.scoped('shows missing argument warning with tip', () =>
+ Effect.gen(function* () {
+ yield* cli(['toolkits', 'info']);
+ const lines = yield* MockConsole.getLines({ stripAnsi: true });
+ const output = lines.join('\n');
+
+ expect(output).toContain('Missing required argument');
+ expect(output).toContain('composio toolkits info "gmail"');
})
);
}