ebay-mcp-remote-edition 1.0.0

package/build/config/environment.js

@@ -0,0 +1,297 @@
+import { config } from 'dotenv';
+import { existsSync, readFileSync } from 'fs';
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+import { LocaleEnum } from '../types/ebay-enums.js';
+import { getVersion } from '../utils/version.js';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+config({ path: join(__dirname, '../../.env'), quiet: true });
+function readSecretConfigFile() {
+    const configFile = process.env.EBAY_CONFIG_FILE;
+    if (!configFile || !existsSync(configFile)) {
+        return null;
+    }
+    try {
+        const raw = readFileSync(configFile, 'utf-8');
+        return JSON.parse(raw);
+    }
+    catch (error) {
+        console.error('Failed to load EBAY_CONFIG_FILE:', error);
+        return null;
+    }
+}
+function getSecretConfigForEnvironment(environment) {
+    const secretConfig = readSecretConfigFile();
+    return secretConfig?.[environment] ?? null;
+}
+function getProductionScopes() {
+    try {
+        const scopesPath = join(__dirname, '../../docs/auth/production_scopes.json');
+        const scopesData = readFileSync(scopesPath, 'utf-8');
+        const scopes = JSON.parse(scopesData);
+        const uniqueScopes = new Set();
+        scopes.forEach((item) => {
+            if (item.Scope) {
+                uniqueScopes.add(item.Scope);
+            }
+        });
+        return Array.from(uniqueScopes);
+    }
+    catch (error) {
+        console.error('Failed to load production scopes:', error);
+        return ['https://api.ebay.com/oauth/api_scope'];
+    }
+}
+function getSandboxScopes() {
+    try {
+        const scopesPath = join(__dirname, '../../docs/auth/sandbox_scopes.json');
+        const scopesData = readFileSync(scopesPath, 'utf-8');
+        const scopes = JSON.parse(scopesData);
+        const uniqueScopes = new Set();
+        scopes.forEach((item) => {
+            if (item.Scope) {
+                uniqueScopes.add(item.Scope);
+            }
+        });
+        return Array.from(uniqueScopes);
+    }
+    catch (error) {
+        console.error('Failed to load sandbox scopes:', error);
+        return ['https://api.ebay.com/oauth/api_scope'];
+    }
+}
+export function getDefaultScopes(environment) {
+    return environment === 'production' ? getProductionScopes() : getSandboxScopes();
+}
+export function getHostedOauthScopes(environment) {
+    if (environment === 'production') {
+        return [
+            'https://api.ebay.com/oauth/api_scope',
+            'https://api.ebay.com/oauth/api_scope/sell.marketing.readonly',
+            'https://api.ebay.com/oauth/api_scope/sell.marketing',
+            'https://api.ebay.com/oauth/api_scope/sell.inventory.readonly',
+            'https://api.ebay.com/oauth/api_scope/sell.inventory',
+            'https://api.ebay.com/oauth/api_scope/sell.account.readonly',
+            'https://api.ebay.com/oauth/api_scope/sell.account',
+            'https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly',
+            'https://api.ebay.com/oauth/api_scope/sell.fulfillment',
+            'https://api.ebay.com/oauth/api_scope/sell.analytics.readonly',
+            'https://api.ebay.com/oauth/api_scope/sell.finances',
+            'https://api.ebay.com/oauth/api_scope/sell.payment.dispute',
+            'https://api.ebay.com/oauth/api_scope/commerce.identity.readonly',
+            'https://api.ebay.com/oauth/api_scope/sell.reputation',
+            'https://api.ebay.com/oauth/api_scope/sell.reputation.readonly',
+            'https://api.ebay.com/oauth/api_scope/commerce.notification.subscription',
+            'https://api.ebay.com/oauth/api_scope/commerce.notification.subscription.readonly',
+            'https://api.ebay.com/oauth/api_scope/sell.stores',
+            'https://api.ebay.com/oauth/api_scope/sell.stores.readonly',
+            'https://api.ebay.com/oauth/scope/sell.edelivery',
+            'https://api.ebay.com/oauth/api_scope/commerce.vero',
+            'https://api.ebay.com/oauth/api_scope/sell.inventory.mapping',
+            'https://api.ebay.com/oauth/api_scope/commerce.message',
+            'https://api.ebay.com/oauth/api_scope/commerce.feedback',
+            'https://api.ebay.com/oauth/api_scope/commerce.shipping',
+        ];
+    }
+    return [
+        'https://api.ebay.com/oauth/api_scope',
+        'https://api.ebay.com/oauth/api_scope/buy.order.readonly',
+        'https://api.ebay.com/oauth/api_scope/buy.guest.order',
+        'https://api.ebay.com/oauth/api_scope/sell.marketing.readonly',
+        'https://api.ebay.com/oauth/api_scope/sell.marketing',
+        'https://api.ebay.com/oauth/api_scope/sell.inventory.readonly',
+        'https://api.ebay.com/oauth/api_scope/sell.inventory',
+        'https://api.ebay.com/oauth/api_scope/sell.account.readonly',
+        'https://api.ebay.com/oauth/api_scope/sell.account',
+        'https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly',
+        'https://api.ebay.com/oauth/api_scope/sell.fulfillment',
+        'https://api.ebay.com/oauth/api_scope/sell.analytics.readonly',
+        'https://api.ebay.com/oauth/api_scope/sell.marketplace.insights.readonly',
+        'https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly',
+        'https://api.ebay.com/oauth/api_scope/buy.shopping.cart',
+        'https://api.ebay.com/oauth/api_scope/buy.offer.auction',
+        'https://api.ebay.com/oauth/api_scope/commerce.identity.readonly',
+        'https://api.ebay.com/oauth/api_scope/commerce.identity.email.readonly',
+        'https://api.ebay.com/oauth/api_scope/commerce.identity.phone.readonly',
+        'https://api.ebay.com/oauth/api_scope/commerce.identity.address.readonly',
+        'https://api.ebay.com/oauth/api_scope/commerce.identity.name.readonly',
+        'https://api.ebay.com/oauth/api_scope/commerce.identity.status.readonly',
+        'https://api.ebay.com/oauth/api_scope/sell.finances',
+        'https://api.ebay.com/oauth/api_scope/sell.payment.dispute',
+        'https://api.ebay.com/oauth/api_scope/sell.item.draft',
+        'https://api.ebay.com/oauth/api_scope/sell.item',
+        'https://api.ebay.com/oauth/api_scope/sell.reputation',
+        'https://api.ebay.com/oauth/api_scope/sell.reputation.readonly',
+        'https://api.ebay.com/oauth/api_scope/commerce.notification.subscription',
+        'https://api.ebay.com/oauth/api_scope/commerce.notification.subscription.readonly',
+        'https://api.ebay.com/oauth/api_scope/sell.stores',
+        'https://api.ebay.com/oauth/api_scope/sell.stores.readonly',
+        'https://api.ebay.com/oauth/api_scope/commerce.vero',
+        'https://api.ebay.com/oauth/api_scope/sell.inventory.mapping',
+        'https://api.ebay.com/oauth/api_scope/commerce.message',
+        'https://api.ebay.com/oauth/api_scope/commerce.feedback',
+        'https://api.ebay.com/oauth/api_scope/commerce.shipping',
+        'https://api.ebay.com/oauth/api_scope/sell.order.read',
+        'https://api.ebay.com/oauth/api_scope/sell.order',
+        'https://api.ebay.com/oauth/api_scope/sell.auction.read',
+        'https://api.ebay.com/oauth/api_scope/sell.offer.read',
+        'https://api.ebay.com/oauth/api_scope/sell.offer',
+        'https://api.ebay.com/oauth/api_scope/sell.return.read',
+        'https://api.ebay.com/oauth/api_scope/sell.return',
+        'https://api.ebay.com/oauth/api_scope/sell.refund.read',
+        'https://api.ebay.com/oauth/api_scope/sell.resolution.read',
+        'https://api.ebay.com/oauth/api_scope/sell.inquiry.read',
+        'https://api.ebay.com/oauth/api_scope/sell.inquiry',
+        'https://api.ebay.com/oauth/api_scope/sell.cancellation.read',
+        'https://api.ebay.com/oauth/api_scope/sell.cancellation',
+        'https://api.ebay.com/oauth/api_scope/commerce.usernote',
+    ];
+}
+export function getConfiguredEnvironment() {
+    const env = process.env.EBAY_ENVIRONMENT || process.env.EBAY_DEFAULT_ENVIRONMENT || 'production';
+    return env === 'sandbox' ? 'sandbox' : 'production';
+}
+export function validateScopes(scopes, environment) {
+    const validScopes = getDefaultScopes(environment);
+    const validScopeSet = new Set(validScopes);
+    const warnings = [];
+    const requestedValidScopes = [];
+    scopes.forEach((scope) => {
+        if (validScopeSet.has(scope)) {
+            requestedValidScopes.push(scope);
+        }
+        else {
+            const otherEnvironment = environment === 'production' ? 'sandbox' : 'production';
+            const otherScopes = getDefaultScopes(otherEnvironment);
+            if (otherScopes.includes(scope)) {
+                warnings.push(`Scope "${scope}" is only available in ${otherEnvironment} environment, not in ${environment}.`);
+            }
+            else {
+                warnings.push(`Scope "${scope}" is not recognized for ${environment} environment.`);
+            }
+            requestedValidScopes.push(scope);
+        }
+    });
+    return { warnings, validScopes: requestedValidScopes };
+}
+export function validateEnvironmentConfig() {
+    const warnings = [];
+    const errors = [];
+    const rawEnv = process.env.EBAY_ENVIRONMENT || process.env.EBAY_DEFAULT_ENVIRONMENT;
+    if (!rawEnv) {
+        warnings.push('EBAY_ENVIRONMENT not set; defaulting to sandbox');
+    }
+    else if (rawEnv !== 'production' && rawEnv !== 'sandbox') {
+        errors.push(`EBAY_ENVIRONMENT "${rawEnv}" is invalid; must be "production" or "sandbox"`);
+    }
+    if (errors.length === 0) {
+        const environment = getConfiguredEnvironment();
+        const configForEnv = getSecretConfigForEnvironment(environment);
+        if (!configForEnv) {
+            if (!process.env.EBAY_CLIENT_ID) {
+                errors.push('EBAY_CLIENT_ID is not set. OAuth will not work.');
+            }
+            if (!process.env.EBAY_CLIENT_SECRET) {
+                errors.push('EBAY_CLIENT_SECRET is not set. OAuth will not work.');
+            }
+            if (!process.env.EBAY_REDIRECT_URI) {
+                warnings.push('EBAY_REDIRECT_URI is not set for selected environment.');
+            }
+        }
+    }
+    return {
+        isValid: errors.length === 0,
+        warnings,
+        errors,
+    };
+}
+export function getEbayConfig(environmentOverride) {
+    const environment = environmentOverride ?? getConfiguredEnvironment();
+    const secretConfig = getSecretConfigForEnvironment(environment);
+    const fallbackClientId = environment === 'production'
+        ? process.env.EBAY_PRODUCTION_CLIENT_ID || process.env.EBAY_CLIENT_ID || ''
+        : process.env.EBAY_SANDBOX_CLIENT_ID || process.env.EBAY_CLIENT_ID || '';
+    const fallbackClientSecret = environment === 'production'
+        ? process.env.EBAY_PRODUCTION_CLIENT_SECRET || process.env.EBAY_CLIENT_SECRET || ''
+        : process.env.EBAY_SANDBOX_CLIENT_SECRET || process.env.EBAY_CLIENT_SECRET || '';
+    const fallbackRedirectUri = environment === 'production'
+        ? process.env.EBAY_PRODUCTION_REDIRECT_URI || process.env.EBAY_REDIRECT_URI
+        : process.env.EBAY_SANDBOX_REDIRECT_URI || process.env.EBAY_REDIRECT_URI;
+    return {
+        clientId: secretConfig?.clientId || fallbackClientId,
+        clientSecret: secretConfig?.clientSecret || fallbackClientSecret,
+        redirectUri: secretConfig?.redirectUri || fallbackRedirectUri,
+        marketplaceId: (process.env.EBAY_MARKETPLACE_ID ?? '').trim() || 'EBAY_US',
+        contentLanguage: (process.env.EBAY_CONTENT_LANGUAGE ?? '').trim() || 'en-US',
+        environment,
+        accessToken: process.env.EBAY_USER_ACCESS_TOKEN ?? '',
+        refreshToken: process.env.EBAY_USER_REFRESH_TOKEN ?? '',
+        appAccessToken: process.env.EBAY_APP_ACCESS_TOKEN ?? '',
+    };
+}
+export function getBaseUrl(environment) {
+    return environment === 'production' ? 'https://api.ebay.com' : 'https://api.sandbox.ebay.com';
+}
+export function getIdentityBaseUrl(environment) {
+    return environment === 'production' ? 'https://apiz.ebay.com' : 'https://apiz.sandbox.ebay.com';
+}
+export function getAuthUrl(clientIdOrEnvironment, redirectUri, environment, locale = LocaleEnum.en_US, prompt = 'login', responseType = 'code', state, scopes) {
+    if (arguments.length === 1 &&
+        (clientIdOrEnvironment === 'production' || clientIdOrEnvironment === 'sandbox')) {
+        return `${getBaseUrl(clientIdOrEnvironment)}/identity/v1/oauth2/token`;
+    }
+    const clientId = clientIdOrEnvironment;
+    const env = environment ?? 'sandbox';
+    const scope = getDefaultScopes(env);
+    if (!(clientId && redirectUri)) {
+        console.error('clientId and redirectUri are required.');
+        return '';
+    }
+    const authBase = env === 'production' ? 'https://auth.ebay.com' : 'https://auth.sandbox.ebay.com';
+    const scopeList = scopes?.join('%20') || scope.join('%20');
+    const authorizeParams = new URLSearchParams({
+        client_id: clientId,
+        redirect_uri: redirectUri,
+        response_type: responseType,
+        prompt,
+        locale,
+        ...(state ? { state } : {}),
+    });
+    return `${authBase}/oauth2/authorize?${authorizeParams.toString()}&scope=${scopeList}`;
+}
+export function getOAuthAuthorizationUrl(clientId, redirectUri, environment, scopes, locale, state) {
+    const authBase = environment === 'production' ? 'https://auth.ebay.com' : 'https://auth.sandbox.ebay.com';
+    const scopeList = (scopes && scopes.length > 0 ? scopes : getDefaultScopes(environment)).join('%20');
+    const params = new URLSearchParams({
+        client_id: clientId,
+        redirect_uri: redirectUri,
+        response_type: 'code',
+        ...(locale ? { locale } : {}),
+        ...(state ? { state } : {}),
+    });
+    return `${authBase}/oauth2/authorize?${params.toString()}&scope=${scopeList}`;
+}
+const iconUrl = (size) => {
+    const url = new URL(`../../public/icons/${size}.png`, import.meta.url);
+    const path = fileURLToPath(url);
+    if (!existsSync(path)) {
+        console.warn(`[eBay MCP] Icon not found at ${path}.`);
+    }
+    return url.toString();
+};
+export const mcpConfig = {
+    name: 'eBay API Model Context Protocol Server',
+    version: getVersion(),
+    title: 'eBay API Model Context Protocol Server',
+    websiteUrl: 'https://github.com/mrnajiboy/ebay-mcp-remote-edition',
+    icons: [
+        { src: iconUrl('16x16'), mimeType: 'image/png', sizes: ['16x16'] },
+        { src: iconUrl('32x32'), mimeType: 'image/png', sizes: ['32x32'] },
+        { src: iconUrl('48x48'), mimeType: 'image/png', sizes: ['48x48'] },
+        { src: iconUrl('128x128'), mimeType: 'image/png', sizes: ['128x128'] },
+        { src: iconUrl('256x256'), mimeType: 'image/png', sizes: ['256x256'] },
+        { src: iconUrl('512x512'), mimeType: 'image/png', sizes: ['512x512'] },
+        { src: iconUrl('1024x1024'), mimeType: 'image/png', sizes: ['1024x1024'] },
+    ],
+};

package/build/index.d.ts

@@ -0,0 +1 @@
+export {};

package/build/index.js

@@ -0,0 +1,129 @@
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
+import { EbaySellerApi } from './api/index.js';
+import { getEbayConfig, mcpConfig, validateEnvironmentConfig } from './config/environment.js';
+import { getToolDefinitions, executeTool } from './tools/index.js';
+import { serverLogger, toolLogger, getLogPaths } from './utils/logger.js';
+import { checkForUpdates } from './utils/version.js';
+checkForUpdates({ defer: true });
+const args = process.argv.slice(2);
+if (args.includes('setup')) {
+    try {
+        const { runSetup } = await import('./scripts/setup.js');
+        await runSetup();
+        process.exit(0);
+    }
+    catch (error) {
+        console.error('Setup failed:', error instanceof Error ? error.message : error);
+        process.exit(1);
+    }
+}
+/**
+ * eBay API MCP Server
+ * Provides access to eBay APIs through Model Context Protocol
+ */
+class EbayMcpServer {
+    server;
+    api;
+    constructor() {
+        this.server = new McpServer(mcpConfig);
+        // Initialize eBay API client
+        this.api = new EbaySellerApi(getEbayConfig());
+        this.setupHandlers();
+        this.setupErrorHandling();
+    }
+    /**
+     * Initialize the API (load tokens from storage)
+     */
+    async initialize() {
+        await this.api.initialize();
+    }
+    setupHandlers() {
+        const tools = getToolDefinitions();
+        serverLogger.info(`Registering ${tools.length} tools`);
+        // Register each tool with the MCP server
+        for (const toolDef of tools) {
+            this.server.registerTool(toolDef.name, {
+                description: toolDef.description,
+                inputSchema: toolDef.inputSchema,
+            }, async (args) => {
+                toolLogger.debug(`Executing tool: ${toolDef.name}`, { args });
+                try {
+                    const result = await executeTool(this.api, toolDef.name, args);
+                    toolLogger.debug(`Tool ${toolDef.name} completed successfully`);
+                    return {
+                        content: [
+                            {
+                                type: 'text',
+                                text: JSON.stringify(result, null, 2),
+                            },
+                        ],
+                    };
+                }
+                catch (error) {
+                    const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+                    toolLogger.error(`Tool ${toolDef.name} failed`, { error: errorMessage });
+                    return {
+                        content: [
+                            {
+                                type: 'text',
+                                text: JSON.stringify({ error: errorMessage }, null, 2),
+                            },
+                        ],
+                        isError: true,
+                    };
+                }
+            });
+        }
+    }
+    setupErrorHandling() {
+        process.on('SIGINT', async () => {
+            serverLogger.info('Received SIGINT, shutting down...');
+            await this.server.close();
+            process.exit(0);
+        });
+    }
+    async run() {
+        serverLogger.info('Starting eBay API MCP Server');
+        // Validate environment configuration
+        const validation = validateEnvironmentConfig();
+        // Log warnings
+        if (validation.warnings.length > 0) {
+            validation.warnings.forEach((warning) => {
+                serverLogger.warn(warning);
+            });
+        }
+        // Log errors and exit if configuration is invalid
+        if (!validation.isValid) {
+            validation.errors.forEach((error) => {
+                serverLogger.error(error);
+            });
+            serverLogger.error('Please fix the configuration errors and restart the server.');
+            process.exit(1);
+        }
+        // Initialize API (load tokens from storage)
+        serverLogger.info('Initializing API client');
+        await this.initialize();
+        // Log log file locations if file logging is enabled
+        if (process.env.EBAY_ENABLE_FILE_LOGGING === 'true') {
+            const paths = getLogPaths();
+            serverLogger.info('File logging enabled', {
+                logDir: paths.logDir,
+                errorLog: paths.errorLog,
+                combinedLog: paths.combinedLog,
+            });
+        }
+        const transport = new StdioServerTransport();
+        await this.server.connect(transport);
+        serverLogger.info('eBay API MCP Server running on stdio');
+    }
+}
+// Start the server
+const server = new EbayMcpServer();
+server.run().catch((error) => {
+    serverLogger.error('Fatal error running server', {
+        error: error instanceof Error ? error.message : String(error),
+        stack: error instanceof Error ? error.stack : undefined,
+    });
+    process.exit(1);
+});