@devries-cameron20 / composio Mirror · read-only / commits / 6db846310
Fork 0

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

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 22, 05:45 UTC

fix(cli): send x-user-api-key and use COMPOSIO_USER_API_KEY (#2779)

Musthaq Ahamad committed Feb 26, 2026 at 14:49 UTC 6db846310e5d233014c9d4390529ae8d07293bd2
52 files changed +541 -87
.changeset/khaki-coats-start.md new
+5
@@ -0,0 +1,5 @@
1 +---
2 +'@composio/cli': patch
3 +---
4 +
5 +Skip user api key from env
.github/workflows/build-cli-binaries.yml
+1 -1
@@ -75,7 +75,7 @@ jobs:
75 - name: Test binary
76 working-directory: ts/packages/cli
77 env:
78 - COMPOSIO_API_KEY: test-dummy-api-key-for-ci
78 + COMPOSIO_USER_API_KEY: test-dummy-api-key-for-ci
79 run: |
80 ./dist/binaries/${{ matrix.artifact }} --version
81 ./dist/binaries/${{ matrix.artifact }} --help | head -5
.github/workflows/ts.test-e2e.yml
+28 -2
@@ -4,10 +4,10 @@ on:
4 push:
5 branches: [master, next]
6 paths:
7 - - "ts/**"
7 + - 'ts/**'
8 pull_request:
9 paths:
10 - - "ts/**"
10 + - 'ts/**'
11 workflow_dispatch:
12
13 jobs:
@@ -25,6 +25,7 @@ jobs:
25 env:
26 CI: 1
27 COMPOSIO_API_KEY: ${{ secrets.COMPOSIO_API_KEY }}
28 + COMPOSIO_USER_API_KEY: ${{ secrets.COMPOSIO_USER_API_KEY }}
29 COMPOSIO_E2E_NODE_VERSION: ${{ matrix.node-version }}
30 OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
31
@@ -32,6 +33,11 @@ jobs:
33 - name: Checkout Code
34 uses: actions/checkout@v6
35
36 + - name: Normalize Composio API keys
37 + run: |
38 + echo "COMPOSIO_USER_API_KEY=${COMPOSIO_USER_API_KEY}" >> "$GITHUB_ENV"
39 + echo "COMPOSIO_API_KEY=${COMPOSIO_API_KEY}" >> "$GITHUB_ENV"
40 +
41 - name: Setup Node.js, pnpm, Bun
42 uses: ./.github/actions/setup-node-pnpm-bun
43
@@ -68,6 +74,7 @@ jobs:
74 env:
75 CI: 1
76 COMPOSIO_API_KEY: ${{ secrets.COMPOSIO_API_KEY }}
77 + COMPOSIO_USER_API_KEY: ${{ secrets.COMPOSIO_USER_API_KEY }}
78 COMPOSIO_E2E_DENO_VERSION: ${{ matrix.deno-version }}
79 OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
80
@@ -75,6 +82,11 @@ jobs:
82 - name: Checkout Code
83 uses: actions/checkout@v6
84
85 + - name: Normalize Composio API keys
86 + run: |
87 + echo "COMPOSIO_USER_API_KEY=${COMPOSIO_USER_API_KEY}" >> "$GITHUB_ENV"
88 + echo "COMPOSIO_API_KEY=${COMPOSIO_API_KEY}" >> "$GITHUB_ENV"
89 +
90 - name: Setup Deno
91 uses: denoland/setup-deno@v2
92 with:
@@ -99,6 +111,7 @@ jobs:
111 permissions: read-all
112 env:
113 CI: 1
114 + COMPOSIO_USER_API_KEY: ${{ secrets.COMPOSIO_USER_API_KEY }}
115 COMPOSIO_API_KEY: ${{ secrets.COMPOSIO_API_KEY }}
116 OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
117
@@ -106,6 +119,11 @@ jobs:
119 - name: Checkout Code
120 uses: actions/checkout@v6
121
122 + - name: Normalize Composio API keys
123 + run: |
124 + echo "COMPOSIO_USER_API_KEY=${COMPOSIO_USER_API_KEY}" >> "$GITHUB_ENV"
125 + echo "COMPOSIO_API_KEY=${COMPOSIO_API_KEY}" >> "$GITHUB_ENV"
126 +
127 - name: Setup Node.js, pnpm, Bun
128 uses: ./.github/actions/setup-node-pnpm-bun
129
@@ -137,12 +155,18 @@ jobs:
155 permissions: read-all
156 env:
157 COMPOSIO_API_KEY: ${{ secrets.COMPOSIO_API_KEY }}
158 + COMPOSIO_USER_API_KEY: ${{ secrets.COMPOSIO_USER_API_KEY }}
159 OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
160
161 steps:
162 - name: Checkout Code
163 uses: actions/checkout@v6
164
165 + - name: Normalize Composio API keys
166 + run: |
167 + echo "COMPOSIO_USER_API_KEY=${COMPOSIO_USER_API_KEY}" >> "$GITHUB_ENV"
168 + echo "COMPOSIO_API_KEY=${COMPOSIO_API_KEY}" >> "$GITHUB_ENV"
169 +
170 - name: Setup Node.js, pnpm, Bun
171 uses: ./.github/actions/setup-node-pnpm-bun
172 with:
@@ -170,4 +194,6 @@ jobs:
194 - name: Run Cloudflare Workers E2E Tests
195 run: pnpm run test:e2e:cloudflare
196 env:
197 + COMPOSIO_USER_API_KEY: ${{ secrets.COMPOSIO_USER_API_KEY }}
198 + COMPOSIO_API_KEY: ${{ secrets.COMPOSIO_API_KEY }}
199 OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
ts/e2e-tests/_utils/Dockerfile.cli
+1 -1
@@ -3,7 +3,7 @@
3 # Usage: docker build -f Dockerfile.cli --build-arg CLI_VERSION=0.1.24 -t test-name .
4
5 ARG NODE_VERSION=20.19.0
6 -ARG BUN_VERSION=1.3.8
6 +ARG BUN_VERSION=1.3.10
7 ARG CLI_VERSION=0.0.0
8
9 FROM oven/bun:${BUN_VERSION} AS bun
ts/e2e-tests/_utils/src/image-lifecycle.ts
+24
@@ -1,4 +1,6 @@
1 import { $ } from 'bun';
2 +import { existsSync } from 'node:fs';
3 +import { homedir } from 'node:os';
4 import { resolve } from 'node:path';
5 import { getRepoRoot } from './config';
6
@@ -133,6 +135,22 @@ function labelsToArgs(labels: Record<string, string> = {}): string[] {
135 return args;
136 }
137
138 +/**
139 + * Adds a bind mount for host ~/.composio into container home.
140 + * This allows E2E jobs to inject `user_data.json` once per job.
141 + */
142 +function addHostComposioMount(dockerArgs: string[], containerComposioPath: string): void {
143 + const hostComposioPath = resolve(homedir(), '.composio');
144 + if (!existsSync(hostComposioPath)) {
145 + return;
146 + }
147 +
148 + dockerArgs.push(
149 + '--mount',
150 + `type=bind,src=${hostComposioPath},dst=${containerComposioPath},readonly`
151 + );
152 +}
153 +
154 /**
155 * Executes a command and captures stdout/stderr using Bun shell.
156 */
@@ -267,6 +285,8 @@ export async function runNodeContainer(options: RunNodeContainerOptions): Promis
285 dockerArgs.push('--workdir', containerCwd);
286 }
287
288 + addHostComposioMount(dockerArgs, '/root/.composio');
289 +
290 // Pass environment variables to the container for runtime configuration.
291 if (env) {
292 for (const [k, v] of Object.entries(env)) {
@@ -446,6 +466,8 @@ export async function runDenoContainer(options: RunDenoContainerOptions): Promis
466 dockerArgs.push('--workdir', containerCwd);
467 }
468
469 + addHostComposioMount(dockerArgs, '/root/.composio');
470 +
471 // Pass environment variables to the container for runtime configuration.
472 if (env) {
473 for (const [k, v] of Object.entries(env)) {
@@ -621,6 +643,8 @@ export async function runCliContainer(options: RunCliContainerOptions): Promise<
643 dockerArgs.push('--workdir', containerCwd);
644 }
645
646 + addHostComposioMount(dockerArgs, '/tmp/.composio');
647 +
648 if (env) {
649 for (const [k, v] of Object.entries(env)) {
650 if (v === undefined) continue;
ts/e2e-tests/cli/README.md
+1 -1
@@ -13,7 +13,7 @@ Tests use `runCmd` to execute shell commands in the container and assert on exit
13 | Suite | Description | Env Vars |
14 | --- | --- | --- |
15 | [version](./version/) | `composio version` output and exit code | None |
16 -| [whoami](./whoami/) | `composio whoami` prints the API key | `COMPOSIO_API_KEY` |
16 +| [whoami](./whoami/) | `composio whoami` prints the API key | `COMPOSIO_USER_API_KEY` |
17
18 ## Isolation Tool
19
ts/e2e-tests/cli/toolkits/info/README.md
+1 -1
@@ -13,7 +13,7 @@ Verifies that `composio toolkits info <slug>` returns detailed toolkit JSON in p
13
14 ## Requirements
15
16 -- `COMPOSIO_API_KEY` (**required**) — Composio API key passed to the container
16 +- `COMPOSIO_USER_API_KEY` (**required**) — Composio user API key passed to the container
17
18 ## Running
19
ts/e2e-tests/cli/toolkits/info/e2e.test.ts
+2 -2
@@ -16,7 +16,7 @@ import { describe, it, expect, beforeAll } from 'bun:test';
16
17 declare module 'bun' {
18 interface Env {
19 - COMPOSIO_API_KEY: string;
19 + COMPOSIO_USER_API_KEY: string;
20 }
21 }
22
@@ -25,7 +25,7 @@ e2e(import.meta.url, {
25 cli: ['current'],
26 },
27 env: {
28 - COMPOSIO_API_KEY: Bun.env.COMPOSIO_API_KEY,
28 + COMPOSIO_USER_API_KEY: Bun.env.COMPOSIO_USER_API_KEY,
29 },
30 defineTests: ({ runCmd }) => {
31 let validResult: E2ETestResult;
ts/e2e-tests/cli/toolkits/list/README.md
+1 -1
@@ -12,7 +12,7 @@ Verifies that `composio toolkits list` returns toolkits as JSON in piped mode wi
12
13 ## Requirements
14
15 -- `COMPOSIO_API_KEY` (**required**) — Composio API key passed to the container
15 +- `COMPOSIO_USER_API_KEY` (**required**) — Composio user API key passed to the container
16
17 ## Running
18
ts/e2e-tests/cli/toolkits/list/e2e.test.ts
+2 -2
@@ -11,7 +11,7 @@ import { describe, it, expect, beforeAll } from 'bun:test';
11
12 declare module 'bun' {
13 interface Env {
14 - COMPOSIO_API_KEY: string;
14 + COMPOSIO_USER_API_KEY: string;
15 }
16 }
17
@@ -20,7 +20,7 @@ e2e(import.meta.url, {
20 cli: ['current'],
21 },
22 env: {
23 - COMPOSIO_API_KEY: Bun.env.COMPOSIO_API_KEY,
23 + COMPOSIO_USER_API_KEY: Bun.env.COMPOSIO_USER_API_KEY,
24 },
25 defineTests: ({ runCmd }) => {
26 let exactResult: E2ETestResult;
ts/e2e-tests/cli/toolkits/search/README.md
+1 -1
@@ -13,7 +13,7 @@ Verifies that `composio toolkits search <query>` returns matching toolkits as JS
13
14 ## Requirements
15
16 -- `COMPOSIO_API_KEY` (**required**) — Composio API key passed to the container
16 +- `COMPOSIO_USER_API_KEY` (**required**) — Composio user API key passed to the container
17
18 ## Running
19
ts/e2e-tests/cli/toolkits/search/e2e.test.ts
+2 -2
@@ -16,7 +16,7 @@ import { describe, it, expect, beforeAll } from 'bun:test';
16
17 declare module 'bun' {
18 interface Env {
19 - COMPOSIO_API_KEY: string;
19 + COMPOSIO_USER_API_KEY: string;
20 }
21 }
22
@@ -25,7 +25,7 @@ e2e(import.meta.url, {
25 cli: ['current'],
26 },
27 env: {
28 - COMPOSIO_API_KEY: Bun.env.COMPOSIO_API_KEY,
28 + COMPOSIO_USER_API_KEY: Bun.env.COMPOSIO_USER_API_KEY,
29 },
30 defineTests: ({ runCmd }) => {
31 let validResult: E2ETestResult;
ts/e2e-tests/cli/whoami/README.md
+4 -4
@@ -7,7 +7,7 @@ Verifies that `composio whoami` prints the authenticated API key and respects st
7 The CLI separates decoration (stderr) from data (stdout). This suite ensures:
8
9 - `composio whoami` exits with code 0
10 -- stdout contains the API key passed via `COMPOSIO_API_KEY`
10 +- stdout contains the API key passed via `COMPOSIO_USER_API_KEY`
11 - stderr is empty (no decoration leaks into piped output)
12 - Redirecting stdout to a file captures the clean API key
13
@@ -16,15 +16,15 @@ The CLI separates decoration (stderr) from data (stdout). This suite ensures:
16 | Test | Description |
17 | --- | --- |
18 | Exit code | `composio whoami` returns 0 |
19 -| stdout | Output matches `COMPOSIO_API_KEY` |
19 +| stdout | Output matches `COMPOSIO_USER_API_KEY` |
20 | stderr | Empty when piped |
21 | File redirect | `composio whoami > out.txt` captures the API key in the file |
22
23 ## Requirements
24
25 -- `COMPOSIO_API_KEY` (**required**) — Composio API key passed to the container
25 +- `COMPOSIO_USER_API_KEY` (**required**) — Composio user API key consumed by CLI
26
27 -If `COMPOSIO_API_KEY` is not set, the suite fails fast at startup.
27 +If `COMPOSIO_USER_API_KEY` is not set, the suite fails fast at startup.
28
29 ## Isolation Tool
30
ts/e2e-tests/cli/whoami/e2e.test.ts
+3 -3
@@ -10,7 +10,7 @@ import { describe, it, expect, beforeAll } from 'bun:test';
10
11 declare module 'bun' {
12 interface Env {
13 - COMPOSIO_API_KEY: string;
13 + COMPOSIO_USER_API_KEY: string;
14 }
15 }
16
@@ -19,10 +19,10 @@ e2e(import.meta.url, {
19 cli: ['current'],
20 },
21 env: {
22 - COMPOSIO_API_KEY: Bun.env.COMPOSIO_API_KEY,
22 + COMPOSIO_USER_API_KEY: Bun.env.COMPOSIO_USER_API_KEY,
23 },
24 defineTests: ({ runCmd }) => {
25 - const expectedApiKey = Bun.env.COMPOSIO_API_KEY.trim();
25 + const expectedApiKey = Bun.env.COMPOSIO_USER_API_KEY.trim();
26 let whoamiResult: E2ETestResult;
27 let redirectedResult: E2ETestResultWithFiles<'out.txt'>;
28
ts/e2e-tests/runtimes/node/typescript-mjs-import-nodenext/e2e.test.ts
+2
@@ -13,6 +13,7 @@ import { describe, it, expect, beforeAll } from 'bun:test';
13 declare module 'bun' {
14 interface Env {
15 COMPOSIO_API_KEY: string;
16 + COMPOSIO_USER_API_KEY: string;
17 }
18 }
19
@@ -20,6 +21,7 @@ e2e(import.meta.url, {
21 versions: { node: ['current'] },
22 env: {
23 COMPOSIO_API_KEY: Bun.env.COMPOSIO_API_KEY,
24 + COMPOSIO_USER_API_KEY: Bun.env.COMPOSIO_USER_API_KEY,
25 },
26 defineTests: ({ runFixture }) => {
27 let result: E2ETestResult;
ts/packages/cli/src/commands/index.ts
+64 -2
@@ -18,6 +18,7 @@ import { authConfigsCmd } from './auth-configs/auth-configs.cmd';
18 import { connectedAccountsCmd } from './connected-accounts/connected-accounts.cmd';
19 import { triggersCmd } from './triggers/triggers.cmd';
20 import { logsCmd } from './logs-cmd/logs.cmd';
21 +import { showToolsExecuteInputHelp } from './tools/commands/tools.execute.cmd';
22
23 const $cmd = $defaultCmd.pipe(
24 Command.withSubcommands([
@@ -41,14 +42,75 @@ const $cmd = $defaultCmd.pipe(
42
43 export const rootCommand = $cmd;
44
45 +const parseExecuteInputHelpSlug = (argv: ReadonlyArray<string>): string | undefined => {
46 + const args = argv.slice(2);
47 + if (args.length < 3) return undefined;
48 + if (args[0] !== 'tools' || args[1] !== 'execute') return undefined;
49 +
50 + const hasHelp = args.includes('--help') || args.includes('-h');
51 + if (!hasHelp) return undefined;
52 +
53 + const tail = args.slice(2);
54 + for (let i = 0; i < tail.length; i += 1) {
55 + const token = tail[i];
56 + if (!token) continue;
57 +
58 + // Stop option parsing after "--" and treat next positional as slug.
59 + if (token === '--') {
60 + const candidate = tail[i + 1];
61 + return candidate && !candidate.startsWith('-') ? candidate : undefined;
62 + }
63 +
64 + // Ignore help flags.
65 + if (token === '--help' || token === '-h') {
66 + continue;
67 + }
68 +
69 + // Skip known execute option values.
70 + if (token === '--data' || token === '-d' || token === '--user-id') {
71 + i += 1;
72 + continue;
73 + }
74 + if (token.startsWith('--data=') || token.startsWith('-d=') || token.startsWith('--user-id=')) {
75 + continue;
76 + }
77 +
78 + // Skip unknown flags.
79 + if (token.startsWith('-')) {
80 + continue;
81 + }
82 +
83 + // First positional token is the slug.
84 + return token;
85 + }
86 +
87 + return undefined;
88 +};
89 +
90 +const normalizeVersionShortFlag = (argv: ReadonlyArray<string>): ReadonlyArray<string> => {
91 + const args = argv.slice(2);
92 + if (args.length === 1 && args[0] === '-v') {
93 + return [...argv.slice(0, 2), '--version'];
94 + }
95 + return argv;
96 +};
97 +
98 export const runWithConfig = Effect.gen(function* () {
99 const version = yield* getVersion;
46 -
47 - return Command.run($cmd, {
100 + const run = Command.run($cmd, {
101 name: 'composio',
102 executable: 'composio',
103 version,
104 });
105 +
106 + return (argv: ReadonlyArray<string>) => {
107 + const normalizedArgv = normalizeVersionShortFlag(argv);
108 + const executeHelpSlug = parseExecuteInputHelpSlug(normalizedArgv);
109 + if (executeHelpSlug) {
110 + return showToolsExecuteInputHelp(executeHelpSlug);
111 + }
112 + return run(normalizedArgv);
113 + };
114 });
115
116 export const run = Command.run($cmd, {
ts/packages/cli/src/commands/tools/commands/tools.execute.cmd.ts
+49
@@ -13,12 +13,15 @@ import {
13 } from 'src/services/tools-executor';
14 import type { ToolExecuteParams } from 'src/services/tools-executor';
15 import { ProjectContext } from 'src/services/project-context';
16 +import { ComposioToolkitsRepository } from 'src/services/composio-clients';
17 import {
18 extractApiErrorDetails,
19 extractMessage,
20 extractSlug,
21 } from 'src/utils/api-error-extraction';
22 import { bold } from 'src/ui/colors';
23 +import { handleHttpServerError } from 'src/effects/handle-http-error';
24 +import { formatToolInputParameters } from '../format';
25
26 const slug = Args.text({ name: 'slug' }).pipe(
27 Args.withDescription('Tool slug (e.g. "GITHUB_CREATE_ISSUE")')
@@ -169,6 +172,52 @@ const normalizeError = (error: unknown): unknown => {
172 return current;
173 };
174
175 +/**
176 + * Show execute-focused help for a specific tool slug.
177 + * This prints only input parameters (data payload schema).
178 + */
179 +export const showToolsExecuteInputHelp = (toolSlug: string) =>
180 + Effect.gen(function* () {
181 + if (!(yield* requireAuth)) return;
182 +
183 + const ui = yield* TerminalUI;
184 + const repo = yield* ComposioToolkitsRepository;
185 +
186 + const toolOpt = yield* ui
187 + .withSpinner(`Fetching input parameters for "${toolSlug}"...`, repo.getToolDetailed(toolSlug))
188 + .pipe(
189 + Effect.asSome,
190 + Effect.catchTag(
191 + 'services/HttpServerError',
192 + handleHttpServerError(ui, {
193 + fallbackMessage: `Tool "${toolSlug}" not found.`,
194 + hint: 'Browse available tools:\n> composio tools list',
195 + fallbackValue: Option.none(),
196 + searchForSuggestions: () =>
197 + repo.searchTools({ search: toolSlug, limit: 3 }).pipe(
198 + Effect.map(r =>
199 + r.items.map(s => ({
200 + label: `${s.slug} — ${s.description}`,
201 + command: `> composio tools execute "${s.slug}" --help`,
202 + }))
203 + )
204 + ),
205 + })
206 + )
207 + );
208 +
209 + if (Option.isNone(toolOpt)) return;
210 + const tool = toolOpt.value;
211 +
212 + yield* ui.note(formatToolInputParameters(tool), `Execute Help: ${tool.slug}`);
213 + yield* ui.log.step(
214 + `Run:\n> composio tools execute "${tool.slug}" --user-id "<user-id>" -d '{"key":"value"}'`
215 + );
216 + yield* ui.output(
217 + JSON.stringify({ slug: tool.slug, input_parameters: tool.input_parameters }, null, 2)
218 + );
219 + });
220 +
221 /**
222 * Display a user-friendly error message for tool execution failures.
223 *
ts/packages/cli/src/commands/tools/commands/tools.search.cmd.ts
+13 -3
@@ -8,7 +8,9 @@ import { formatToolsTable } from '../format';
8 import type { Tool } from 'src/models/tools';
9
10 const query = Args.text({ name: 'query' }).pipe(
11 - Args.withDescription('Search query (e.g. "send emails")')
11 + Args.withDescription(
12 + 'Semantic use-case query (e.g. "onboard a new GitHub repo and notify Slack").'
13 + )
14 );
15
16 const toolkits = Options.text('toolkits').pipe(
@@ -22,7 +24,11 @@ const limit = Options.integer('limit').pipe(
24 );
25
26 /**
25 - * Search tools by use case.
27 + * Search tools semantically by use case.
28 + *
29 + * The query is interpreted semantically (not exact keyword matching), so you can
30 + * describe an outcome or workflow. The command returns the most relevant tools
31 + * for that use case and includes recommended guidance/plan steps to help execute it.
32 *
33 * @example
34 * ```bash
@@ -135,4 +141,8 @@ export const toolsCmd$Search = Command.make(
141 // For machine-readable output (e.g. piping to jq), expose the full API payload.
142 yield* ui.output(JSON.stringify(searchResponse, null, 2));
143 })
138 -).pipe(Command.withDescription('Search tools by use case.'));
144 +).pipe(
145 + Command.withDescription(
146 + 'Semantically search tools by use case; returns best-fit tools plus recommended usage guidance.'
147 + )
148 +);
ts/packages/cli/src/commands/tools/format.ts
+53
@@ -58,6 +58,39 @@ function formatSchemaProperties(schema: Record<string, unknown>): string {
58 .join('\n');
59 }
60
61 +/**
62 + * Format JSON Schema properties using a detailed field layout, similar to trigger info.
63 + */
64 +function formatSchemaPropertiesDetailed(schema: Record<string, unknown>): string {
65 + const entries = extractSchemaProperties(schema);
66 + if (entries.length === 0) {
67 + return ' (none)';
68 + }
69 +
70 + const typeWidth = Math.max(...entries.map(e => e.type.length));
71 + const labelWidth = Math.max(...entries.map(e => e.label.length));
72 + const metadataLabels = ['description:', 'type:', 'required:', 'default:'] as const;
73 + const metadataLabelWidth = Math.max(...metadataLabels.map(label => label.length));
74 +
75 + return entries
76 + .map(e => {
77 + const lines: string[] = [];
78 + lines.push(` ${bold(e.name)}`);
79 + lines.push(
80 + ` ${'description:'.padEnd(metadataLabelWidth)} ${e.description ? gray(truncate(e.description, 70)) : '-'}`
81 + );
82 + lines.push(` ${'type:'.padEnd(metadataLabelWidth)} ${e.type.padEnd(typeWidth)}`);
83 + lines.push(` ${'required:'.padEnd(metadataLabelWidth)} ${e.label.padEnd(labelWidth)}`);
84 + if (e.hasDefault) {
85 + lines.push(
86 + ` ${'default:'.padEnd(metadataLabelWidth)} ${gray(truncate(JSON.stringify(e.defaultValue), 40))}`
87 + );
88 + }
89 + return lines.join('\n');
90 + })
91 + .join('\n\n');
92 +}
93 +
94 /**
95 * Format a detailed tool for interactive display.
96 */
@@ -93,3 +126,23 @@ export function formatToolInfo(tool: ToolDetailedResponse): string {
126
127 return lines.join('\n');
128 }
129 +
130 +/**
131 + * Format only tool input parameters for execute-help flows.
132 + */
133 +export function formatToolInputParameters(tool: ToolDetailedResponse): string {
134 + const lines: string[] = [];
135 + lines.push(`${bold('Name:')} ${tool.name}`);
136 + lines.push(`${bold('Slug:')} ${tool.slug}`);
137 + lines.push(`${bold('Description:')} ${tool.description || '(none)'}`);
138 +
139 + if (tool.toolkit.slug) {
140 + lines.push(`${bold('Toolkit:')} ${tool.toolkit.name} (${tool.toolkit.slug})`);
141 + }
142 +
143 + lines.push('');
144 + lines.push(gray('------------------------------'));
145 + lines.push(bold('Data Parameters:'));
146 + lines.push(formatSchemaPropertiesDetailed(tool.input_parameters as Record<string, unknown>));
147 + return lines.join('\n');
148 +}
ts/packages/cli/src/effects/app-config.ts
+2 -2
@@ -2,7 +2,7 @@ import { Config, LogLevel, Option } from 'effect';
2 import * as constants from 'src/constants';
3
4 type APP_CONFIG = Config.Config.Wrap<{
5 - API_KEY: Option.Option<string>;
5 + USER_API_KEY: Option.Option<string>;
6 ENVIRONMENT: Option.Option<string>;
7 BASE_URL: string;
8 WEB_URL: string;
@@ -35,7 +35,7 @@ const environmentBasedDefault = (
35 */
36 export const APP_CONFIG = {
37 // The API key for the Composio API
38 - API_KEY: Config.option(Config.string('API_KEY')),
38 + USER_API_KEY: Config.option(Config.string('USER_API_KEY')),
39
40 // The deployment environment ("production" | "staging"). Controls URL defaults.
41 ENVIRONMENT: Config.option(Config.string('ENVIRONMENT')),
ts/packages/cli/src/services/composio-clients.ts
+11 -3
@@ -1110,7 +1110,7 @@ export class ComposioClientSingleton extends Effect.Service<ComposioClientSingle
1110 onSome: projectContext =>
1111 projectContext.resolve.pipe(Effect.catchAll(() => Effect.succeed(Option.none()))),
1112 });
1113 - const defaultHeaders = Option.match(resolvedProjectContext, {
1113 + const projectContextHeaders = Option.match(resolvedProjectContext, {
1114 onNone: () =>
1115 globalOrgId && globalProjectId
1116 ? ({
@@ -1124,12 +1124,20 @@ export class ComposioClientSingleton extends Effect.Service<ComposioClientSingle
1124 'x-project-id': keys.projectId,
1125 }) satisfies Record<string, string>,
1126 });
1127 + const defaultHeaders = {
1128 + ...(apiKey ? ({ 'x-user-api-key': apiKey } satisfies Record<string, string>) : {}),
1129 + ...(projectContextHeaders ?? {}),
1130 + };
1131 + const normalizedDefaultHeaders =
1132 + Object.keys(defaultHeaders).length > 0 ? defaultHeaders : undefined;
1133
1134 yield* Effect.logDebug('Creating raw Composio client...');
1135 const client = new _RawComposioClient({
1130 - apiKey,
1136 + // Disable @composio/client's built-in x-api-key auth header.
1137 + // CLI always authenticates with x-user-api-key instead.
1138 + apiKey: null,
1139 baseURL,
1132 - defaultHeaders,
1140 + defaultHeaders: normalizedDefaultHeaders,
1141 });
1142
1143 ref = Option.some(client);
ts/packages/cli/src/services/config.ts
+2 -2
@@ -15,10 +15,10 @@ import { APP_CONFIG } from 'src/effects/app-config';
15 * @example
16 * ```sh
17 * # Environment variable
18 - * COMPOSIO_API_KEY=your_api_key
18 + * COMPOSIO_USER_API_KEY=your_user_api_key
19 * ```
20 *
21 - * Read via `yield* Config.string('API_KEY')`.
21 + * Read via `yield* Config.string('USER_API_KEY')`.
22 */
23
24 export const BaseConfigProviderLive = ConfigProvider.fromEnv();
ts/packages/cli/src/services/user-context.ts
+1 -1
@@ -49,7 +49,7 @@ export const ComposioUserContextLive = Layer.effect(
49 ComposioUserContext,
50 Effect.gen(function* () {
51 const fs = yield* FileSystem.FileSystem;
52 - const apiKey = yield* APP_CONFIG['API_KEY'];
52 + const apiKey = yield* APP_CONFIG['USER_API_KEY'];
53 const baseURL = yield* APP_CONFIG['BASE_URL'];
54 const webURL = yield* APP_CONFIG['WEB_URL'];
55
ts/packages/cli/test/src/commands/$default.cmd.test.ts
+12
@@ -46,4 +46,16 @@ describe('CLI: composio', () => {
46 })
47 );
48 });
49 +
50 + layer(TestLive())(it => {
51 + it.scoped("[Given] -v flag [Then] prints composio's version from package.json", () =>
52 + Effect.gen(function* () {
53 + const args = ['-v'];
54 + yield* cli(args);
55 + const lines = yield* MockConsole.getLines();
56 + const output = lines.join('\n');
57 + expect(output).toContain(pkg.version);
58 + })
59 + );
60 + });
61 });
ts/packages/cli/test/src/commands/__snapshots__/$default.cmd.test.ts.snap
+1 -1
@@ -69,7 +69,7 @@ Environment Variables:
69
70 - tools info [<slug>] View details of a specific tool.
71
72 - - tools search [--toolkits text] [--limit integer] <query> Search tools by use case.
72 + - tools search [--toolkits text] [--limit integer] <query> Semantically search tools by use case; returns best-fit tools plus recommended usage guidance.
73
74 - tools execute [(-d, --data text)] [--user-id text] <slug> Execute a tool by slug with JSON arguments.
75
ts/packages/cli/test/src/commands/auth-configs/auth-configs.create.cmd.test.ts
+1 -1
@@ -5,7 +5,7 @@ import { cli, TestLive, MockConsole } from 'test/__utils__';
5 import type { TestLiveInput } from 'test/__utils__/services/test-layer';
6
7 const testConfigProvider = ConfigProvider.fromMap(
8 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
8 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
9 ).pipe(extendConfigProvider);
10
11 describe('CLI: composio auth-configs create', () => {
ts/packages/cli/test/src/commands/auth-configs/auth-configs.delete.cmd.test.ts
+1 -1
@@ -26,7 +26,7 @@ const authConfigsData = {
26 } satisfies TestLiveInput['authConfigsData'];
27
28 const testConfigProvider = ConfigProvider.fromMap(
29 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
29 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
30 ).pipe(extendConfigProvider);
31
32 describe('CLI: composio auth-configs delete', () => {
ts/packages/cli/test/src/commands/auth-configs/auth-configs.info.cmd.test.ts
+1 -1
@@ -26,7 +26,7 @@ const authConfigsData = {
26 } satisfies TestLiveInput['authConfigsData'];
27
28 const testConfigProvider = ConfigProvider.fromMap(
29 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
29 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
30 ).pipe(extendConfigProvider);
31
32 describe('CLI: composio auth-configs info', () => {
ts/packages/cli/test/src/commands/auth-configs/auth-configs.list.cmd.test.ts
+1 -1
@@ -52,7 +52,7 @@ const authConfigsData = {
52 } satisfies TestLiveInput['authConfigsData'];
53
54 const testConfigProvider = ConfigProvider.fromMap(
55 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
55 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
56 ).pipe(extendConfigProvider);
57
58 describe('CLI: composio auth-configs list', () => {
ts/packages/cli/test/src/commands/connected-accounts/connected-accounts.delete.cmd.test.ts
+1 -1
@@ -30,7 +30,7 @@ const connectedAccountsData = {
30 } satisfies TestLiveInput['connectedAccountsData'];
31
32 const testConfigProvider = ConfigProvider.fromMap(
33 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
33 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
34 ).pipe(extendConfigProvider);
35
36 describe('CLI: composio connected-accounts delete', () => {
ts/packages/cli/test/src/commands/connected-accounts/connected-accounts.info.cmd.test.ts
+1 -1
@@ -30,7 +30,7 @@ const connectedAccountsData = {
30 } satisfies TestLiveInput['connectedAccountsData'];
31
32 const testConfigProvider = ConfigProvider.fromMap(
33 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
33 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
34 ).pipe(extendConfigProvider);
35
36 describe('CLI: composio connected-accounts info', () => {
ts/packages/cli/test/src/commands/connected-accounts/connected-accounts.link.cmd.test.ts
+1 -1
@@ -30,7 +30,7 @@ const connectedAccountsData = {
30 } satisfies TestLiveInput['connectedAccountsData'];
31
32 const testConfigProvider = ConfigProvider.fromMap(
33 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
33 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
34 ).pipe(extendConfigProvider);
35
36 describe('CLI: composio connected-accounts link', () => {
ts/packages/cli/test/src/commands/connected-accounts/connected-accounts.list.cmd.test.ts
+1 -1
@@ -64,7 +64,7 @@ const connectedAccountsData = {
64 } satisfies TestLiveInput['connectedAccountsData'];
65
66 const testConfigProvider = ConfigProvider.fromMap(
67 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
67 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
68 ).pipe(extendConfigProvider);
69
70 describe('CLI: composio connected-accounts list', () => {
ts/packages/cli/test/src/commands/connected-accounts/connected-accounts.whoami.cmd.test.ts
+1 -1
@@ -47,7 +47,7 @@ const connectedAccountsData = {
47 } satisfies TestLiveInput['connectedAccountsData'];
48
49 const testConfigProvider = ConfigProvider.fromMap(
50 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
50 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
51 ).pipe(extendConfigProvider);
52
53 describe('CLI: composio connected-accounts whoami', () => {
ts/packages/cli/test/src/commands/logout.cmd.test.ts
+1 -1
@@ -41,7 +41,7 @@ describe('CLI: composio logout', () => {
41
42 describe('[When] logged in', () => {
43 const testConfigProvider = ConfigProvider.fromMap(
44 - new Map([['COMPOSIO_API_KEY', 'api_key_already_logged_in']])
44 + new Map([['COMPOSIO_USER_API_KEY', 'api_key_already_logged_in']])
45 ).pipe(extendConfigProvider);
46
47 layer(TestLive({ baseConfigProvider: testConfigProvider }))(it => {
ts/packages/cli/test/src/commands/toolkits/toolkits.info.cmd.test.ts
+1 -1
@@ -126,7 +126,7 @@ const toolkitsData = {
126 } satisfies TestLiveInput['toolkitsData'];
127
128 const testConfigProvider = ConfigProvider.fromMap(
129 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
129 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
130 ).pipe(extendConfigProvider);
131
132 describe('CLI: composio toolkits info', () => {
ts/packages/cli/test/src/commands/toolkits/toolkits.list.cmd.test.ts
+1 -1
@@ -64,7 +64,7 @@ const toolkitsData = {
64 } satisfies TestLiveInput['toolkitsData'];
65
66 const testConfigProvider = ConfigProvider.fromMap(
67 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
67 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
68 ).pipe(extendConfigProvider);
69
70 describe('CLI: composio toolkits list', () => {
ts/packages/cli/test/src/commands/toolkits/toolkits.search.cmd.test.ts
+1 -1
@@ -64,7 +64,7 @@ const toolkitsData = {
64 } satisfies TestLiveInput['toolkitsData'];
65
66 const testConfigProvider = ConfigProvider.fromMap(
67 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
67 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
68 ).pipe(extendConfigProvider);
69
70 describe('CLI: composio toolkits search', () => {
ts/packages/cli/test/src/commands/tools/tools.execute.cmd.test.ts
+93 -1
@@ -5,9 +5,11 @@ import { extendConfigProvider } from 'src/services/config';
5 import { ActionExecuteConnectedAccountNotFoundError } from 'src/services/tools-executor';
6 import * as redactModule from 'src/ui/redact';
7 import { cli, TestLive, MockConsole } from 'test/__utils__';
8 +import type { TestLiveInput } from 'test/__utils__/services/test-layer';
9 +import { showToolsExecuteInputHelp } from 'src/commands/tools/commands/tools.execute.cmd';
10
11 const testConfigProvider = ConfigProvider.fromMap(
10 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
12 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
13 ).pipe(extendConfigProvider);
14
15 const parseLastJson = (lines: ReadonlyArray<string>) => {
@@ -69,6 +71,96 @@ describe('CLI: composio tools execute', () => {
71 );
72 });
73
74 + layer(
75 + TestLive({
76 + baseConfigProvider: testConfigProvider,
77 + toolkitsData: {
78 + tools: [
79 + {
80 + name: 'Send Email',
81 + slug: 'GMAIL_SEND_EMAIL',
82 + description: 'Send an email',
83 + tags: ['email'],
84 + available_versions: ['20260101_00'],
85 + input_parameters: {
86 + type: 'object',
87 + required: ['recipient'],
88 + properties: {
89 + recipient: { type: 'string', description: 'Recipient email' },
90 + subject: { type: 'string', description: 'Subject line' },
91 + },
92 + },
93 + output_parameters: {
94 + type: 'object',
95 + properties: {
96 + message_id: { type: 'string' },
97 + },
98 + },
99 + },
100 + ],
101 + } satisfies TestLiveInput['toolkitsData'],
102 + stdin: { isTTY: true, data: '' },
103 + })
104 + )('[Given] execute-help helper [Then] prints input parameters only', it => {
105 + it.scoped('prints execute input schema help for the provided slug', () =>
106 + Effect.gen(function* () {
107 + yield* showToolsExecuteInputHelp('GMAIL_SEND_EMAIL');
108 + const lines = yield* MockConsole.getLines({ stripAnsi: true });
109 + const output = lines.join('\n');
110 +
111 + expect(output).toContain('Data Parameters:');
112 + expect(output).toContain('recipient');
113 + expect(output).toContain('subject');
114 + expect(output).not.toContain('Output Parameters:');
115 + })
116 + );
117 + });
118 +
119 + layer(
120 + TestLive({
121 + baseConfigProvider: testConfigProvider,
122 + toolkitsData: {
123 + tools: [
124 + {
125 + name: 'Send Email',
126 + slug: 'GMAIL_SEND_EMAIL',
127 + description: 'Send an email',
128 + tags: ['email'],
129 + available_versions: ['20260101_00'],
130 + input_parameters: {
131 + type: 'object',
132 + required: ['recipient'],
133 + properties: {
134 + recipient: { type: 'string', description: 'Recipient email' },
135 + subject: { type: 'string', description: 'Subject line' },
136 + },
137 + },
138 + output_parameters: {
139 + type: 'object',
140 + properties: {
141 + message_id: { type: 'string' },
142 + },
143 + },
144 + },
145 + ],
146 + } satisfies TestLiveInput['toolkitsData'],
147 + stdin: { isTTY: true, data: '' },
148 + })
149 + )('[Given] execute-help with options before slug [Then] resolves correct slug', it => {
150 + it.scoped('does not treat --user-id value as slug', () =>
151 + Effect.gen(function* () {
152 + yield* cli(['tools', 'execute', '--user-id', 'default', 'GMAIL_SEND_EMAIL', '--help']);
153 + const lines = yield* MockConsole.getLines({ stripAnsi: true });
154 + const output = lines.join('\n');
155 +
156 + expect(output).toContain('Slug: GMAIL_SEND_EMAIL');
157 + expect(output).toContain('Data Parameters:');
158 + expect(output).toContain('recipient');
159 + expect(output).not.toContain('default');
160 + })
161 + );
162 + });
163 +
164 layer(
165 TestLive({
166 baseConfigProvider: testConfigProvider,
ts/packages/cli/test/src/commands/tools/tools.info.cmd.test.ts
+1 -1
@@ -46,7 +46,7 @@ const toolkitsData = {
46 } satisfies TestLiveInput['toolkitsData'];
47
48 const testConfigProvider = ConfigProvider.fromMap(
49 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
49 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
50 ).pipe(extendConfigProvider);
51
52 describe('CLI: composio tools info', () => {
ts/packages/cli/test/src/commands/tools/tools.list.cmd.test.ts
+1 -1
@@ -52,7 +52,7 @@ const toolkitsData = {
52 } satisfies TestLiveInput['toolkitsData'];
53
54 const testConfigProvider = ConfigProvider.fromMap(
55 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
55 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
56 ).pipe(extendConfigProvider);
57
58 describe('CLI: composio tools list', () => {
ts/packages/cli/test/src/commands/tools/tools.search.cmd.test.ts
+1 -1
@@ -44,7 +44,7 @@ const toolkitsData = {
44 } satisfies TestLiveInput['toolkitsData'];
45
46 const testConfigProvider = ConfigProvider.fromMap(
47 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
47 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
48 ).pipe(extendConfigProvider);
49
50 describe('CLI: composio tools search', () => {
ts/packages/cli/test/src/commands/triggers/triggers.info.cmd.test.ts
+1 -1
@@ -51,7 +51,7 @@ const toolkitsData = {
51 } satisfies TestLiveInput['toolkitsData'];
52
53 const testConfigProvider = ConfigProvider.fromMap(
54 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
54 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
55 ).pipe(extendConfigProvider);
56
57 describe('CLI: composio triggers info', () => {
ts/packages/cli/test/src/commands/triggers/triggers.list.cmd.test.ts
+1 -1
@@ -43,7 +43,7 @@ const toolkitsData = {
43 } satisfies TestLiveInput['toolkitsData'];
44
45 const testConfigProvider = ConfigProvider.fromMap(
46 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
46 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
47 ).pipe(extendConfigProvider);
48
49 describe('CLI: composio triggers list', () => {
ts/packages/cli/test/src/commands/triggers/triggers.listen.cmd.test.ts
+1 -1
@@ -6,7 +6,7 @@ import { createServer, type IncomingMessage } from 'node:http';
6 import { Composio } from '@composio/core';
7
8 const testConfigProvider = ConfigProvider.fromMap(
9 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
9 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
10 ).pipe(extendConfigProvider);
11
12 const mockV3TriggerEvent = {
ts/packages/cli/test/src/commands/triggers/triggers.mutations.cmd.test.ts
+1 -1
@@ -4,7 +4,7 @@ import { extendConfigProvider } from 'src/services/config';
4 import { cli, MockConsole, TestLive } from 'test/__utils__';
5
6 const testConfigProvider = ConfigProvider.fromMap(
7 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
7 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
8 ).pipe(extendConfigProvider);
9
10 describe('CLI: composio triggers mutations', () => {
ts/packages/cli/test/src/commands/triggers/triggers.status.cmd.test.ts
+1 -1
@@ -52,7 +52,7 @@ const triggersData = {
52 } satisfies TestLiveInput['triggersData'];
53
54 const testConfigProvider = ConfigProvider.fromMap(
55 - new Map([['COMPOSIO_API_KEY', 'test_api_key']])
55 + new Map([['COMPOSIO_USER_API_KEY', 'test_api_key']])
56 ).pipe(extendConfigProvider);
57
58 describe('CLI: composio triggers status', () => {
ts/packages/cli/test/src/commands/whoami.cmd.test.ts
+2 -2
@@ -5,11 +5,11 @@ import { cli, TestLive, MockConsole } from 'test/__utils__';
5
6 describe('CLI: composio whoami', () => {
7 const testConfigProvider = ConfigProvider.fromMap(
8 - new Map([['COMPOSIO_API_KEY', 'api_key_from_test_config_provider']])
8 + new Map([['COMPOSIO_USER_API_KEY', 'api_key_from_test_config_provider']])
9 ).pipe(extendConfigProvider);
10
11 layer(TestLive({ baseConfigProvider: testConfigProvider }))('with config override', it => {
12 - it.scoped('[Given] `COMPOSIO_API_KEY` [Then] prints it to stdout', () =>
12 + it.scoped('[Given] `COMPOSIO_USER_API_KEY` [Then] prints it to stdout', () =>
13 Effect.gen(function* () {
14 const args = ['whoami'];
15 yield* cli(args);
ts/packages/cli/test/src/services/composio-client-singleton.test.ts new
+91
@@ -0,0 +1,91 @@
1 +import { afterEach, describe, expect, it, vi } from 'vitest';
2 +import { BunFileSystem } from '@effect/platform-bun';
3 +import { ConfigProvider, Effect, Layer } from 'effect';
4 +import * as tempy from 'tempy';
5 +import { ComposioClientSingleton } from 'src/services/composio-clients';
6 +import { defaultNodeOs, NodeOs } from 'src/services/node-os';
7 +import { extendConfigProvider } from 'src/services/config';
8 +
9 +const withConfigLayer = (map: Map<string, string>, homedir: string) =>
10 + Layer.mergeAll(
11 + BunFileSystem.layer,
12 + Layer.succeed(NodeOs, defaultNodeOs({ homedir })),
13 + Layer.setConfigProvider(extendConfigProvider(ConfigProvider.fromMap(map)))
14 + );
15 +
16 +const okResponse = () =>
17 + new Response(JSON.stringify({ data: [] }), {
18 + status: 200,
19 + headers: { 'Content-Type': 'application/json' },
20 + });
21 +
22 +describe('ComposioClientSingleton headers', () => {
23 + afterEach(() => {
24 + vi.restoreAllMocks();
25 + });
26 +
27 + it('uses x-user-api-key and never x-api-key', async () => {
28 + const fetchSpy = vi.spyOn(globalThis, 'fetch').mockResolvedValue(okResponse());
29 + const homedir = tempy.temporaryDirectory();
30 + const configMap = new Map([
31 + ['COMPOSIO_USER_API_KEY', 'uak_from_user_env'],
32 + ['COMPOSIO_API_KEY', 'ak_should_be_ignored'],
33 + ['COMPOSIO_BASE_URL', 'https://backend.composio.dev'],
34 + ]);
35 +
36 + const program = Effect.gen(function* () {
37 + const client = yield* ComposioClientSingleton.get();
38 + yield* Effect.promise(() =>
39 + client.tools
40 + .list({ limit: 1, toolkit_versions: 'latest' })
41 + .then(() => undefined)
42 + .catch(() => undefined)
43 + );
44 + }).pipe(
45 + Effect.provide(
46 + Layer.provide(ComposioClientSingleton.Default, withConfigLayer(configMap, homedir))
47 + )
48 + );
49 +
50 + await Effect.runPromise(program);
51 +
52 + expect(fetchSpy).toHaveBeenCalledOnce();
53 + const [, init] = fetchSpy.mock.calls[0]!;
54 + const headers = new Headers((init as RequestInit).headers);
55 +
56 + expect(headers.get('x-user-api-key')).toBe('uak_from_user_env');
57 + expect(headers.has('x-api-key')).toBe(false);
58 + });
59 +
60 + it('does not read COMPOSIO_API_KEY for user auth', async () => {
61 + const fetchSpy = vi.spyOn(globalThis, 'fetch').mockResolvedValue(okResponse());
62 + const homedir = tempy.temporaryDirectory();
63 + const configMap = new Map([
64 + ['COMPOSIO_API_KEY', 'ak_only'],
65 + ['COMPOSIO_BASE_URL', 'https://backend.composio.dev'],
66 + ]);
67 +
68 + const program = Effect.gen(function* () {
69 + const client = yield* ComposioClientSingleton.get();
70 + yield* Effect.promise(() =>
71 + client.tools
72 + .list({ limit: 1, toolkit_versions: 'latest' })
73 + .then(() => undefined)
74 + .catch(() => undefined)
75 + );
76 + }).pipe(
77 + Effect.provide(
78 + Layer.provide(ComposioClientSingleton.Default, withConfigLayer(configMap, homedir))
79 + )
80 + );
81 +
82 + await Effect.runPromise(program);
83 +
84 + expect(fetchSpy).toHaveBeenCalledOnce();
85 + const [, init] = fetchSpy.mock.calls[0]!;
86 + const headers = new Headers((init as RequestInit).headers);
87 +
88 + expect(headers.get('x-user-api-key')).toBeNull();
89 + expect(headers.has('x-api-key')).toBe(false);
90 + });
91 +});
ts/packages/cli/test/src/services/config.test.ts
+17 -17
@@ -23,7 +23,7 @@ describe('Config', () => {
23 assertEquals(
24 actual,
25 Data.struct({
26 - API_KEY: Option.none(),
26 + USER_API_KEY: Option.none(),
27 ENVIRONMENT: Option.none(),
28 BASE_URL: 'https://backend.composio.dev',
29 CACHE_DIR: Option.none(),
@@ -37,7 +37,7 @@ describe('Config', () => {
37
38 it('[When] map entries are set without `COMPOSIO_` prefix', () => {
39 const map = new Map([
40 - ['API_KEY', 'api_key'],
40 + ['USER_API_KEY', 'api_key'],
41 ['BASE_URL', 'https://test.localhost'],
42 ['CACHE_DIR', '~/.composio'],
43 ['LOG_LEVEL', 'info'],
@@ -50,7 +50,7 @@ describe('Config', () => {
50 assertEquals(
51 actual,
52 Data.struct({
53 - API_KEY: Option.none(),
53 + USER_API_KEY: Option.none(),
54 ENVIRONMENT: Option.none(),
55 BASE_URL: 'https://backend.composio.dev',
56 CACHE_DIR: Option.none(),
@@ -64,7 +64,7 @@ describe('Config', () => {
64
65 it('[When] env variables are set with `COMPOSIO_` prefix', () => {
66 const map = new Map([
67 - ['COMPOSIO_API_KEY', 'api_key'],
67 + ['COMPOSIO_USER_API_KEY', 'api_key'],
68 ['COMPOSIO_BASE_URL', 'https://test.localhost'],
69 ['COMPOSIO_WEB_URL', 'https://test.localhost'],
70 ['COMPOSIO_CACHE_DIR', '~/.composio'],
@@ -78,7 +78,7 @@ describe('Config', () => {
78 assertEquals(
79 actual,
80 Data.struct({
81 - API_KEY: Option.some('api_key'),
81 + USER_API_KEY: Option.some('api_key'),
82 ENVIRONMENT: Option.none(),
83 BASE_URL: 'https://test.localhost',
84 WEB_URL: 'https://test.localhost',
@@ -100,7 +100,7 @@ describe('Config', () => {
100 assertEquals(
101 actual,
102 Data.struct({
103 - API_KEY: Option.none(),
103 + USER_API_KEY: Option.none(),
104 ENVIRONMENT: Option.some('production'),
105 BASE_URL: constants.DEFAULT_BASE_URL,
106 WEB_URL: constants.DEFAULT_WEB_URL,
@@ -122,7 +122,7 @@ describe('Config', () => {
122 assertEquals(
123 actual,
124 Data.struct({
125 - API_KEY: Option.none(),
125 + USER_API_KEY: Option.none(),
126 ENVIRONMENT: Option.some('staging'),
127 BASE_URL: constants.STAGING_BASE_URL,
128 WEB_URL: constants.STAGING_WEB_URL,
@@ -147,7 +147,7 @@ describe('Config', () => {
147 assertEquals(
148 actual,
149 Data.struct({
150 - API_KEY: Option.none(),
150 + USER_API_KEY: Option.none(),
151 ENVIRONMENT: Option.some('staging'),
152 BASE_URL: 'https://custom-backend.localhost',
153 WEB_URL: constants.STAGING_WEB_URL,
@@ -172,7 +172,7 @@ describe('Config', () => {
172 assertEquals(
173 actual,
174 Data.struct({
175 - API_KEY: Option.none(),
175 + USER_API_KEY: Option.none(),
176 ENVIRONMENT: Option.some('staging'),
177 BASE_URL: constants.STAGING_BASE_URL,
178 WEB_URL: 'https://custom-web.localhost',
@@ -194,7 +194,7 @@ describe('Config', () => {
194 assertEquals(
195 actual,
196 Data.struct({
197 - API_KEY: Option.none(),
197 + USER_API_KEY: Option.none(),
198 ENVIRONMENT: Option.some('unknown'),
199 BASE_URL: constants.DEFAULT_BASE_URL,
200 WEB_URL: constants.DEFAULT_WEB_URL,
@@ -304,7 +304,7 @@ describe('Config', () => {
304 assertEquals(
305 actual,
306 Data.struct({
307 - API_KEY: Option.none(),
307 + USER_API_KEY: Option.none(),
308 ENVIRONMENT: Option.none(),
309 BASE_URL: 'https://backend.composio.dev',
310 WEB_URL: 'https://platform.composio.dev',
@@ -317,7 +317,7 @@ describe('Config', () => {
317 });
318
319 it('[When] env variables are set without `COMPOSIO_` prefix', () => {
320 - vi.stubEnv('API_KEY', 'api_key');
320 + vi.stubEnv('USER_API_KEY', 'api_key');
321 vi.stubEnv('BASE_URL', 'https://test.localhost');
322 vi.stubEnv('CACHE_DIR', '~/.composio');
323 vi.stubEnv('LOG_LEVEL', 'info');
@@ -329,7 +329,7 @@ describe('Config', () => {
329 assertEquals(
330 actual,
331 Data.struct({
332 - API_KEY: Option.none(),
332 + USER_API_KEY: Option.none(),
333 ENVIRONMENT: Option.none(),
334 BASE_URL: 'https://backend.composio.dev',
335 WEB_URL: 'https://platform.composio.dev',
@@ -342,7 +342,7 @@ describe('Config', () => {
342 });
343
344 it('[When] env variables are set with `COMPOSIO_` prefix', () => {
345 - vi.stubEnv('COMPOSIO_API_KEY', 'api_key');
345 + vi.stubEnv('COMPOSIO_USER_API_KEY', 'api_key');
346 vi.stubEnv('COMPOSIO_BASE_URL', 'https://test.localhost');
347 vi.stubEnv('COMPOSIO_WEB_URL', 'https://test.localhost');
348 vi.stubEnv('COMPOSIO_CACHE_DIR', '~/.composio');
@@ -355,7 +355,7 @@ describe('Config', () => {
355 assertEquals(
356 actual,
357 Data.struct({
358 - API_KEY: Option.some('api_key'),
358 + USER_API_KEY: Option.some('api_key'),
359 ENVIRONMENT: Option.none(),
360 BASE_URL: 'https://test.localhost',
361 WEB_URL: 'https://test.localhost',
@@ -377,7 +377,7 @@ describe('Config', () => {
377 assertEquals(
378 actual,
379 Data.struct({
380 - API_KEY: Option.none(),
380 + USER_API_KEY: Option.none(),
381 ENVIRONMENT: Option.some('staging'),
382 BASE_URL: constants.STAGING_BASE_URL,
383 WEB_URL: constants.STAGING_WEB_URL,
@@ -401,7 +401,7 @@ describe('Config', () => {
401 assertEquals(
402 actual,
403 Data.struct({
404 - API_KEY: Option.none(),
404 + USER_API_KEY: Option.none(),
405 ENVIRONMENT: Option.some('staging'),
406 BASE_URL: 'https://custom.localhost',
407 WEB_URL: 'https://custom-web.localhost',
ts/packages/cli/test/src/services/user-context.test.ts
+26 -6
@@ -47,7 +47,7 @@ describe('ComposioUserContext', () => {
47 it.scoped('[Then] is logged in', () => {
48 const cwd = tempy.temporaryDirectory();
49 const map = new Map([
50 - ['COMPOSIO_API_KEY', 'api_key'],
50 + ['COMPOSIO_USER_API_KEY', 'api_key'],
51 ['COMPOSIO_BASE_URL', 'https://test.composio.localhost'],
52 ]) satisfies Map<string, string>;
53
@@ -72,6 +72,23 @@ describe('ComposioUserContext', () => {
72 assertEquals(ctx.isLoggedIn(), true);
73 }).pipe(Effect.provide(ComposioUserContextTest));
74 });
75 +
76 + it.scoped('[Then] COMPOSIO_API_KEY alone does not authenticate user context', () => {
77 + const cwd = tempy.temporaryDirectory();
78 + const map = new Map([['COMPOSIO_API_KEY', 'legacy_api_key']]) satisfies Map<string, string>;
79 +
80 + const NodeOsTest = Layer.succeed(NodeOs, defaultNodeOs({ homedir: cwd }));
81 + const ComposioUserContextTest = Layer.provideMerge(
82 + ComposioUserContextLive,
83 + Layer.mergeAll(BunFileSystem.layer, NodeOsTest, withMapConfigProvider(map))
84 + );
85 +
86 + return Effect.gen(function* () {
87 + const ctx = yield* ComposioUserContext;
88 + assertEquals(ctx.isLoggedIn(), false);
89 + assertEquals(Option.getOrUndefined(ctx.data.apiKey), undefined);
90 + }).pipe(Effect.provide(ComposioUserContextTest));
91 + });
92 });
93 });
94
@@ -120,7 +137,7 @@ describe('ComposioUserContext', () => {
137 describe('[When] dynamic `APP_CONFIG` is set', () => {
138 it.scoped('[Then] it overrides the config file', () => {
139 const cwd = tempy.temporaryDirectory();
123 - const map = new Map([['COMPOSIO_API_KEY', 'api_key']]) satisfies Map<string, string>;
140 + const map = new Map([['COMPOSIO_USER_API_KEY', 'api_key']]) satisfies Map<string, string>;
141
142 const NodeOsTest = Layer.succeed(NodeOs, defaultNodeOs({ homedir: cwd }));
143 const ComposioUserContextTest = Layer.provideMerge(
@@ -274,10 +291,13 @@ describe('ComposioUserContext', () => {
291 });
292 });
293
277 - describe('[When] the file is corrupted but env API_KEY is set', () => {
278 - it('[Then] it falls back to defaults but preserves env API_KEY', () => {
294 + describe('[When] the file is corrupted but env USER_API_KEY is set', () => {
295 + it('[Then] it falls back to defaults but preserves env USER_API_KEY', () => {
296 const cwd = tempy.temporaryDirectory();
280 - const map = new Map([['COMPOSIO_API_KEY', 'env_api_key']]) satisfies Map<string, string>;
297 + const map = new Map([
298 + ['COMPOSIO_USER_API_KEY', 'env_api_key'],
299 + ['COMPOSIO_API_KEY', 'legacy_api_key_should_be_ignored'],
300 + ]) satisfies Map<string, string>;
301
302 const NodeOsTest = Layer.succeed(NodeOs, defaultNodeOs({ homedir: cwd }));
303 const ComposioUserContextTest = Layer.provideMerge(
@@ -292,7 +312,7 @@ describe('ComposioUserContext', () => {
312
313 const ctx = yield* ComposioUserContext;
314
295 - // Despite corrupted file, env API_KEY should still work
315 + // Despite corrupted file, env USER_API_KEY should still work
316 assertEquals(ctx.isLoggedIn(), true);
317 assertEquals(Option.getOrUndefined(ctx.data.apiKey), 'env_api_key');
318 }).pipe(Effect.provide(ComposioUserContextTest));
turbo.jsonc
+5 -5
@@ -19,27 +19,27 @@
19 },
20 "test:e2e": {
21 "dependsOn": ["^build"],
22 - "env": ["COMPOSIO_API_KEY", "OPENAI_API_KEY"],
22 + "env": ["COMPOSIO_API_KEY", "COMPOSIO_USER_API_KEY", "OPENAI_API_KEY"],
23 "cache": false
24 },
25 "test:e2e:node": {
26 "dependsOn": ["^build"],
27 - "env": ["COMPOSIO_API_KEY", "COMPOSIO_E2E_NODE_VERSION", "OPENAI_API_KEY"],
27 + "env": ["COMPOSIO_API_KEY", "COMPOSIO_USER_API_KEY", "COMPOSIO_E2E_NODE_VERSION", "OPENAI_API_KEY"],
28 "cache": false
29 },
30 "test:e2e:deno": {
31 "dependsOn": ["^build"],
32 - "env": ["COMPOSIO_API_KEY", "COMPOSIO_E2E_DENO_VERSION", "OPENAI_API_KEY"],
32 + "env": ["COMPOSIO_API_KEY", "COMPOSIO_USER_API_KEY", "COMPOSIO_E2E_DENO_VERSION", "OPENAI_API_KEY"],
33 "cache": false
34 },
35 "test:e2e:cli": {
36 "dependsOn": ["^build"],
37 - "env": ["COMPOSIO_API_KEY", "COMPOSIO_E2E_CLI_VERSION", "OPENAI_API_KEY"],
37 + "env": ["COMPOSIO_API_KEY", "COMPOSIO_USER_API_KEY", "COMPOSIO_E2E_CLI_VERSION", "OPENAI_API_KEY"],
38 "cache": false
39 },
40 "test:e2e:cloudflare": {
41 "dependsOn": ["^build"],
42 - "env": ["COMPOSIO_API_KEY", "OPENAI_API_KEY"],
42 + "env": ["COMPOSIO_API_KEY", "COMPOSIO_USER_API_KEY", "OPENAI_API_KEY"],
43 "cache": false
44 },
45 "install:binary": {