ebay-mcp 1.4.3

package/build/utils/setup-validator.js

@@ -0,0 +1,305 @@
+/**
+ * Setup Validation Module
+ *
+ * Tests the configuration after setup to ensure everything is working properly.
+ */
+import { existsSync, readFileSync } from 'fs';
+import { join } from 'path';
+import chalk from 'chalk';
+import { EbayOAuthClient } from '../auth/oauth.js';
+import { getOAuthAuthorizationUrl } from '../config/environment.js';
+/**
+ * Parse .env file manually
+ */
+function parseEnvFile(filePath) {
+    const env = {};
+    if (!existsSync(filePath)) {
+        return env;
+    }
+    const content = readFileSync(filePath, 'utf-8');
+    const lines = content.split('\n');
+    for (const line of lines) {
+        const trimmed = line.trim();
+        // Skip empty lines and comments
+        if (!trimmed || trimmed.startsWith('#')) {
+            continue;
+        }
+        // Parse KEY=VALUE
+        const match = /^([^=]+)=(.*)$/.exec(trimmed);
+        if (match) {
+            const key = match[1].trim();
+            let value = match[2].trim();
+            // Remove quotes if present
+            if ((value.startsWith('"') && value.endsWith('"')) ||
+                (value.startsWith("'") && value.endsWith("'"))) {
+                value = value.slice(1, -1);
+            }
+            env[key] = value;
+        }
+    }
+    return env;
+}
+/**
+ * Validate .env file exists and is readable
+ */
+function validateEnvFile(projectRoot) {
+    const envPath = join(projectRoot, '.env');
+    if (!existsSync(envPath)) {
+        return {
+            test: '.env File Existence',
+            passed: false,
+            message: 'Configuration file not found',
+            error: `.env file does not exist at ${envPath}`,
+        };
+    }
+    try {
+        readFileSync(envPath, 'utf-8');
+        return {
+            test: '.env File Existence',
+            passed: true,
+            message: 'Configuration file exists and is readable',
+        };
+    }
+    catch (error) {
+        return {
+            test: '.env File Existence',
+            passed: false,
+            message: 'Configuration file cannot be read',
+            error: error instanceof Error ? error.message : 'Unknown error',
+        };
+    }
+}
+/**
+ * Validate required app credentials are present
+ */
+function validateAppCredentials(envVars) {
+    const required = ['EBAY_CLIENT_ID', 'EBAY_CLIENT_SECRET', 'EBAY_REDIRECT_URI'];
+    const missing = [];
+    for (const key of required) {
+        if (!envVars[key] || envVars[key].trim() === '') {
+            missing.push(key);
+        }
+    }
+    if (missing.length > 0) {
+        return {
+            test: 'App Credentials',
+            passed: false,
+            message: 'Missing required app credentials',
+            error: `Missing: ${missing.join(', ')}`,
+        };
+    }
+    return {
+        test: 'App Credentials',
+        passed: true,
+        message: 'All required app credentials are present',
+    };
+}
+/**
+ * Validate environment setting
+ */
+function validateEnvironment(envVars) {
+    const env = envVars.EBAY_ENVIRONMENT || 'sandbox';
+    if (env !== 'sandbox' && env !== 'production') {
+        return {
+            test: 'Environment Setting',
+            passed: false,
+            message: 'Invalid environment value',
+            error: `EBAY_ENVIRONMENT must be "sandbox" or "production", got "${env}"`,
+        };
+    }
+    return {
+        test: 'Environment Setting',
+        passed: true,
+        message: `Environment set to "${env}"`,
+    };
+}
+/**
+ * Check if user tokens are configured
+ */
+function validateUserTokens(envVars) {
+    const hasRefreshToken = envVars.EBAY_USER_REFRESH_TOKEN && envVars.EBAY_USER_REFRESH_TOKEN.trim() !== '';
+    if (!hasRefreshToken) {
+        return {
+            test: 'User Tokens (Optional)',
+            passed: true,
+            message: 'No user tokens configured (app token only mode)',
+            error: 'To enable user-specific API calls, set EBAY_USER_REFRESH_TOKEN',
+        };
+    }
+    return {
+        test: 'User Tokens',
+        passed: true,
+        message: 'User refresh token is configured',
+    };
+}
+/**
+ * Test OAuth client initialization
+ */
+async function validateOAuthInitialization(config) {
+    try {
+        const oauthClient = new EbayOAuthClient(config);
+        await oauthClient.initialize();
+        return {
+            test: 'OAuth Client Initialization',
+            passed: true,
+            message: 'OAuth client initialized successfully',
+        };
+    }
+    catch (error) {
+        return {
+            test: 'OAuth Client Initialization',
+            passed: false,
+            message: 'Failed to initialize OAuth client',
+            error: error instanceof Error ? error.message : 'Unknown error',
+        };
+    }
+}
+/**
+ * Test OAuth URL generation
+ */
+function validateOAuthURL(config) {
+    try {
+        if (!config.redirectUri) {
+            return {
+                test: 'OAuth URL Generation',
+                passed: false,
+                message: 'Redirect URI is required for OAuth URL generation',
+                error: 'EBAY_REDIRECT_URI is not configured',
+            };
+        }
+        const url = getOAuthAuthorizationUrl(config.clientId, config.redirectUri, config.environment);
+        if (!url.startsWith('http')) {
+            return {
+                test: 'OAuth URL Generation',
+                passed: false,
+                message: 'Invalid OAuth URL generated',
+                error: 'Generated URL is not valid',
+            };
+        }
+        return {
+            test: 'OAuth URL Generation',
+            passed: true,
+            message: 'OAuth URL can be generated',
+        };
+    }
+    catch (error) {
+        return {
+            test: 'OAuth URL Generation',
+            passed: false,
+            message: 'Failed to generate OAuth URL',
+            error: error instanceof Error ? error.message : 'Unknown error',
+        };
+    }
+}
+/**
+ * Run all validation tests
+ */
+export async function validateSetup(projectRoot) {
+    const results = [];
+    console.log(chalk.bold.cyan('\n🧪 Running Configuration Tests...\n'));
+    // Test 1: .env file exists
+    const envFileResult = validateEnvFile(projectRoot);
+    results.push(envFileResult);
+    printResult(envFileResult);
+    if (!envFileResult.passed) {
+        return {
+            totalTests: 1,
+            passed: 0,
+            failed: 1,
+            results,
+        };
+    }
+    // Parse .env file
+    const envPath = join(projectRoot, '.env');
+    const envVars = parseEnvFile(envPath);
+    // Test 2: App credentials
+    const appCredsResult = validateAppCredentials(envVars);
+    results.push(appCredsResult);
+    printResult(appCredsResult);
+    // Test 3: Environment setting
+    const envResult = validateEnvironment(envVars);
+    results.push(envResult);
+    printResult(envResult);
+    // Test 4: User tokens (optional)
+    const userTokensResult = validateUserTokens(envVars);
+    results.push(userTokensResult);
+    printResult(userTokensResult);
+    // If app credentials are valid, test OAuth functionality
+    if (appCredsResult.passed) {
+        const config = {
+            clientId: envVars.EBAY_CLIENT_ID,
+            clientSecret: envVars.EBAY_CLIENT_SECRET,
+            redirectUri: envVars.EBAY_REDIRECT_URI,
+            environment: (envVars.EBAY_ENVIRONMENT || 'sandbox'),
+        };
+        // Test 5: OAuth initialization
+        const oauthInitResult = await validateOAuthInitialization(config);
+        results.push(oauthInitResult);
+        printResult(oauthInitResult);
+        // Test 6: OAuth URL generation
+        if (oauthInitResult.passed) {
+            const oauthURLResult = validateOAuthURL(config);
+            results.push(oauthURLResult);
+            printResult(oauthURLResult);
+        }
+    }
+    // Calculate summary
+    const passed = results.filter((r) => r.passed).length;
+    const failed = results.length - passed;
+    // Print summary
+    console.log(chalk.gray('\n' + '─'.repeat(60)));
+    console.log(chalk.bold.white('\n📊 Validation Summary\n'));
+    console.log(`  Total Tests: ${results.length}`);
+    console.log(`  ${chalk.green('✓ Passed:')} ${passed}`);
+    console.log(`  ${chalk.red('✗ Failed:')} ${failed}`);
+    if (failed === 0) {
+        console.log(chalk.green.bold('\n✨ All tests passed! Configuration is valid.\n'));
+    }
+    else {
+        console.log(chalk.yellow.bold('\n⚠️  Some tests failed. Please review the errors above.\n'));
+    }
+    return {
+        totalTests: results.length,
+        passed,
+        failed,
+        results,
+    };
+}
+/**
+ * Print a single validation result
+ */
+function printResult(result) {
+    const icon = result.passed ? chalk.green('✓') : chalk.red('✗');
+    const status = result.passed ? chalk.green('PASS') : chalk.red('FAIL');
+    console.log(`${icon} ${chalk.bold(result.test)}: ${status}`);
+    console.log(`  ${chalk.gray(result.message)}`);
+    if (result.error) {
+        console.log(`  ${chalk.yellow('→')} ${chalk.yellow(result.error)}`);
+    }
+    console.log('');
+}
+/**
+ * Display recommendations based on validation results
+ */
+export function displayRecommendations(summary) {
+    const hasUserTokens = summary.results.some((r) => r.test === 'User Tokens' && r.passed && !r.error);
+    console.log(chalk.bold.cyan('💡 Recommendations:\n'));
+    if (!hasUserTokens) {
+        console.log(chalk.yellow('  ⚠️  User tokens not configured'));
+        console.log(chalk.gray('     • You can only use app token for limited API access'));
+        console.log(chalk.gray('     • To enable full API access, use the ebay_get_oauth_url tool'));
+        console.log(chalk.gray('     • Then save your refresh token to EBAY_USER_REFRESH_TOKEN in .env\n'));
+    }
+    if (summary.failed > 0) {
+        console.log(chalk.red('  ❌ Configuration has errors'));
+        console.log(chalk.gray('     • Review the failed tests above'));
+        console.log(chalk.gray('     • Update your .env file with correct values'));
+        console.log(chalk.gray('     • Run the setup wizard again: npm run setup\n'));
+    }
+    else {
+        console.log(chalk.green('  ✅ Configuration is complete and valid'));
+        console.log(chalk.gray('     • Restart your MCP client (Claude Desktop, Cline, etc.)'));
+        console.log(chalk.gray('     • The eBay MCP server should now be available'));
+        console.log(chalk.gray('     • Try using tools like: ebay_get_user, ebay_get_oauth_url\n'));
+    }
+}

package/build/utils/token-utils.d.ts

@@ -0,0 +1,40 @@
+import { z } from 'zod';
+/**
+ * Zod schemas for token utility tools
+ */
+export declare const ConvertDateToTimestampSchema: z.ZodObject<{
+    dateInput: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    dateInput: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    dateInput: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+}, z.ZodTypeAny, "passthrough">>;
+export declare const ValidateTokenExpirySchema: z.ZodObject<{
+    accessTokenExpiry: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    refreshTokenExpiry: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    accessTokenExpiry: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    refreshTokenExpiry: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    accessTokenExpiry: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    refreshTokenExpiry: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+}, z.ZodTypeAny, "passthrough">>;
+export declare const SetUserTokensWithExpirySchema: z.ZodObject<{
+    accessToken: z.ZodString;
+    refreshToken: z.ZodString;
+    accessTokenExpiry: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    refreshTokenExpiry: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    autoRefresh: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+    accessToken: z.ZodString;
+    refreshToken: z.ZodString;
+    accessTokenExpiry: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    refreshTokenExpiry: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    autoRefresh: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+    accessToken: z.ZodString;
+    refreshToken: z.ZodString;
+    accessTokenExpiry: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    refreshTokenExpiry: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    autoRefresh: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, z.ZodTypeAny, "passthrough">>;

package/build/utils/token-utils.js

@@ -0,0 +1,40 @@
+import { z } from 'zod';
+/**
+ * Zod schemas for token utility tools
+ */
+export const ConvertDateToTimestampSchema = z
+    .object({
+    dateInput: z
+        .union([z.string(), z.number()])
+        .describe('Date to convert. Supports ISO 8601 strings (e.g., "2025-01-15T10:30:00Z"), Unix timestamps (seconds or milliseconds), or relative time (e.g., "in 2 hours")'),
+})
+    .passthrough();
+export const ValidateTokenExpirySchema = z
+    .object({
+    accessTokenExpiry: z
+        .union([z.string(), z.number()])
+        .describe('Access token expiry time. Can be ISO date string, Unix timestamp (seconds or milliseconds), or relative time'),
+    refreshTokenExpiry: z
+        .union([z.string(), z.number()])
+        .describe('Refresh token expiry time. Can be ISO date string, Unix timestamp (seconds or milliseconds), or relative time'),
+})
+    .passthrough();
+export const SetUserTokensWithExpirySchema = z
+    .object({
+    accessToken: z.string().min(1).describe('eBay user access token'),
+    refreshToken: z.string().min(1).describe('eBay user refresh token'),
+    accessTokenExpiry: z
+        .union([z.string(), z.number()])
+        .optional()
+        .describe("Optional: Access token expiry time. If not provided, defaults to 2 hours from now. Can be ISO date string, Unix timestamp, or relative time (e.g., 'in 7200 seconds')"),
+    refreshTokenExpiry: z
+        .union([z.string(), z.number()])
+        .optional()
+        .describe('Optional: Refresh token expiry time. If not provided, defaults to 18 months from now. Can be ISO date string, Unix timestamp, or relative time'),
+    autoRefresh: z
+        .boolean()
+        .optional()
+        .default(true)
+        .describe('If true and access token is expired but refresh token is valid, automatically refresh the access token. Default: true'),
+})
+    .passthrough();

package/package.json

@@ -0,0 +1,115 @@
+{
+	"name": "ebay-mcp",
+	"version": "1.4.3",
+	"description": "MCP server for eBay APIs - provides access to eBay developer functionality through MCP (Model Context Protocol)",
+	"type": "module",
+	"main": "build/index.js",
+	"types": "build/index.d.ts",
+	"bin": {
+		"ebay-mcp": "build/index.js"
+	},
+	"scripts": {
+		"build": "tsc && tsc-alias",
+		"watch": "tsc --watch",
+		"dev": "tsx src/index.ts",
+		"dev:http": "tsx src/server-http.ts",
+		"start": "node build/index.js",
+		"start:http": "node build/server-http.js",
+		"clean": "rm -rf build",
+		"prepare": "npm run build",
+		"postinstall": "npm run auto-setup --if-present || true",
+		"setup": "tsx src/scripts/interactive-setup.ts",
+		"auto-setup": "node build/scripts/auto-setup.js",
+		"diagnose": "tsx src/scripts/diagnostics.ts",
+		"diagnose:export": "tsx src/scripts/diagnostics.ts --export",
+		"typecheck": "tsc --noEmit",
+		"test": "vitest run",
+		"test:watch": "vitest",
+		"test:ui": "vitest --ui",
+		"test:coverage": "vitest run --coverage",
+		"test:integration": "vitest run tests/integration",
+		"download:specs": "tsx src/scripts/download-specs.ts",
+		"test:endpoints": "tsx src/scripts/test-endpoints.ts",
+		"generate:types": "bash src/scripts/generate-types.sh",
+		"lint": "eslint .",
+		"lint:fix": "eslint . --fix",
+		"format": "prettier --write \"src/**/*.{ts,js,json,md}\" \"tests/**/*.{ts,js,json}\"",
+		"format:check": "prettier --check \"src/**/*.{ts,js,json,md}\" \"tests/**/*.{ts,js,json}\"",
+		"check": "npm run typecheck && npm run lint && npm run format:check",
+		"docker:build": "docker-compose build",
+		"docker:up": "docker-compose up -d",
+		"docker:down": "docker-compose down",
+		"docker:logs": "docker-compose logs -f",
+		"docker:restart": "docker-compose restart"
+	},
+	"keywords": [
+		"mcp",
+		"ebay",
+		"ebay-api",
+		"model-context-protocol",
+		"ai-tools",
+		"ai",
+		"llm",
+		"mcp",
+		"documentation",
+		"api",
+		"ebay",
+		"server",
+		"backend"
+	],
+	"author": "Yosef Hayim Sabag",
+	"license": "MIT",
+	"files": [
+		"build",
+		"README.md"
+	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/YosefHayim/ebay-mcp.git"
+	},
+	"homepage": "https://github.com/YosefHayim/ebay-mcp#readme",
+	"bugs": {
+		"url": "https://github.com/YosefHayim/ebay-mcp/issues"
+	},
+	"dependencies": {
+		"@modelcontextprotocol/sdk": "^1.21.1",
+		"axios": "^1.7.9",
+		"chalk": "^5.6.2",
+		"cors": "^2.8.5",
+		"dotenv": "^16.4.7",
+		"express": "^5.1.0",
+		"helmet": "^8.1.0",
+		"jose": "^6.1.1",
+		"jsonwebtoken": "^9.0.2",
+		"prompts": "^2.4.2",
+		"zod": "3",
+		"zod-to-json-schema": "^3.24.6"
+	},
+	"devDependencies": {
+		"@eslint/js": "^9.39.1",
+		"@types/cors": "^2.8.19",
+		"@types/express": "^5.0.5",
+		"@types/jsonwebtoken": "^9.0.10",
+		"@types/node": "^22.10.2",
+		"@types/prompts": "^2.4.9",
+		"@types/supertest": "^6.0.3",
+		"@vitest/coverage-v8": "^4.0.8",
+		"@vitest/ui": "^4.0.8",
+		"eslint": "^9.39.1",
+		"eslint-config-prettier": "^10.1.8",
+		"eslint-plugin-n": "^17.23.1",
+		"eslint-plugin-vitest": "^0.5.4",
+		"nock": "^14.0.10",
+		"openapi-typescript": "^7.10.1",
+		"prettier": "^3.6.2",
+		"supertest": "^7.1.4",
+		"tsc-alias": "^1.8.16",
+		"tsx": "^4.19.2",
+		"typescript": "^5.9.3",
+		"typescript-eslint": "^8.46.4",
+		"vitest": "^4.0.8"
+	},
+	"engines": {
+		"node": ">=18.0.0"
+	}
+}