Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
TypeScript agentic-aiagentsaiai-agentsaiagentsdeveloper-toolsfunction-callinggpt-4javascriptjsllmllmopsmcppythonremote-mcp-serverssetypescript
import { ComposioNoAPIKeyError } from '../errors/SDKErrors';
import { COMPOSIO_DIR, DEFAULT_BASE_URL, USER_DATA_FILE_NAME } from './constants';
import { getEnvsWithPrefix, getEnvVariable } from './env';
import logger from './logger';
import { ComposioError } from '../errors/ComposioError';
import { ToolkitVersion, ToolkitVersionParam, ToolkitVersions } from '../types/tool.types';
import { normalizeToolkitSlug } from './toolkitVersion';
import { platform } from '#platform';
// File path helpers
export const userDataPath = () => {
try {
const homeDir = platform.homedir();
if (!homeDir) {
return null;
}
return platform.joinPath(homeDir, COMPOSIO_DIR, USER_DATA_FILE_NAME);
} catch (_error) {
logger.debug('Environment', `Unable to get user data path`);
return null;
}
};
/**
* Reads and parses the user data JSON file from the Composio directory.
*
* @returns The parsed user data object containing user configuration (api_key, base_url, etc.), or empty object if file doesn't exist or can't be read
*/
export const getUserDataJson = () => {
try {
const dataPath = userDataPath();
if (!dataPath || !platform.supportsFileSystem) {
return {};
}
const data = platform.readFileSync(dataPath, 'utf8');
return JSON.parse(data as string);
} catch (_error) {
logger.debug('Environment', 'No user data file found');
return {};
}
};
// Client configuration functions
export function getSDKConfig(baseUrl?: string | null, apiKey?: string | null) {
const userData = getUserDataJson();
const { api_key: apiKeyFromUserConfig, base_url: baseURLFromUserConfig } = userData;
const baseURLParsed =
baseUrl || getEnvVariable('COMPOSIO_BASE_URL') || baseURLFromUserConfig || DEFAULT_BASE_URL;
const apiKeyParsed = apiKey || getEnvVariable('COMPOSIO_API_KEY') || apiKeyFromUserConfig || '';
if (!apiKeyParsed) {
ComposioError.handleAndThrow(new ComposioNoAPIKeyError());
}
logger.debug('Environment', 'API Key: [REDACTED]');
logger.debug('Environment', `Base URL: ${baseURLParsed}`);
return { baseURL: baseURLParsed, apiKey: apiKeyParsed };
}
/**
* Gets toolkit versions configuration by merging environment variables, user-provided defaults, and fallbacks.
*
* Priority order:
* 1. If defaultVersions is a string, use it as global version for all toolkits
* 2. User-provided toolkit version mappings (defaultVersions object)
* 3. Environment variables (COMPOSIO_TOOLKIT_VERSION_<TOOLKIT_NAME>)
* 4. Fallback to 'latest' if no versions are configured
*
* @param defaultVersions - Optional default versions configuration (string for global version or object mapping toolkit names to versions)
* @returns Toolkit versions configuration - either a global version string, toolkit-specific version mapping, or 'latest'
*/
export function getToolkitVersionsFromEnv(
defaultVersions?: ToolkitVersionParam
): ToolkitVersionParam {
// if already set by user either a single version or 'latest' use that as is / override everything else
if (defaultVersions && typeof defaultVersions === 'string') {
return defaultVersions;
}
// check if there are envs similar to COMPOSIO_TOOLKIT_VERSION_GITHUB then extract the toolkit name
const envPrefixedVersions = getEnvsWithPrefix(`COMPOSIO_TOOLKIT_VERSION_`);
const toolkitVersionsFromEnv = Object.entries(envPrefixedVersions).reduce((acc, [key, value]) => {
const toolkitName = key.replace('COMPOSIO_TOOLKIT_VERSION_', '');
acc[normalizeToolkitSlug(toolkitName)] = value as ToolkitVersion;
return acc;
}, {} as ToolkitVersions);
// normalize keys via normalizeToolkitSlug (the same helper the lookup uses);
// user provided values act as overrides
let userProvidedToolkitVersions = {};
if (defaultVersions && typeof defaultVersions === 'object') {
userProvidedToolkitVersions = Object.fromEntries(
Object.entries(defaultVersions).map(([key, value]) => [normalizeToolkitSlug(key), value])
);
}
// final toolkit versions
const toolkitVersions = {
...toolkitVersionsFromEnv,
...userProvidedToolkitVersions,
};
// if the toolkitVersions are empty, use 'latest'
if (Object.keys(toolkitVersions).length === 0) {
return 'latest';
}
return toolkitVersions;
}