Installation

Install the eBay MCP Server on your system

This guide covers installing the eBay MCP Server on your local machine.

System Requirements

Before installing, ensure your system meets these requirements:

Node.js

Version 18.0.0 or higher

Check your version: node --version

npm

Version 8.0.0 or higher

Check your version: npm --version

Git

Latest version recommended

Check your version: git --version

Operating System

macOS, Linux, or Windows

Windows users: Use WSL2 or PowerShell

Need to install Node.js?

Download and install Node.js from nodejs.org

Recommended: Use the LTS (Long Term Support) version

Verify installation:

node --version
npm --version

Installation Methods

Choose the installation method that works best for you:

Standard Installation

The recommended method for most users.

1. Clone the Repository

   git clone https://github.com/YosefHayim/ebay-mcp-server.git
   

   This creates an ebay-mcp-server directory with all source code.

2. Navigate to Directory

   cd ebay-mcp-server
   
3. Install Dependencies

   npm install
   

   This installs:

   • Model Context Protocol SDK
   • eBay API client libraries
   • TypeScript compiler
   • Testing frameworks
   • All development dependencies

   Installation typically takes 30-60 seconds. First-time installs may take longer.

4. Build the Project

   npm run build
   

   This compiles TypeScript to JavaScript in the build/ directory.

5. Verify Installation

   npm run version
   

   You should see the server version and environment information.

Development Installation

For contributors and developers who want to modify the code.

1. Fork the Repository

   1. Visit github.com/YosefHayim/ebay-mcp-server
   2. Click the Fork button in the top right
   3. Clone your fork:
      git clone https://github.com/YOUR_USERNAME/ebay-mcp-server.git
      cd ebay-mcp-server
      
2. Install All Dependencies

   npm install
   

   This includes dev dependencies for testing and development.

3. Set Up Development Environment

   # Build in watch mode (auto-recompiles on changes)
   npm run dev
   
   # In another terminal, run tests in watch mode
   npm run test:watch
   
4. Create a Development Branch

   git checkout -b feature/your-feature-name
   

Contributing Guide

Learn more about contributing to the project

Docker Installation

Run the server in an isolated container (coming soon).

Docker support is currently in development. Use standard installation for now.

Planned Docker Support

We’re working on official Docker images for easy deployment:

# Planned usage (not yet available)
docker pull yosefhayim/ebay-mcp-server
docker run -e EBAY_CLIENT_ID=xxx ebay-mcp-server

Track progress: GitHub Issue #123

Post-Installation

After installation, configure your credentials:

1. Run Setup Wizard

   npm run setup
   

   The interactive wizard will guide you through configuration.

2. Verify Setup

   npm test
   

   Run the test suite to ensure everything works correctly.

3. Start the Server

   npm start
   

   The server starts in STDIO mode, ready for MCP client connections.

Configuration Guide

Learn how to configure your eBay credentials

Directory Structure

After installation, your project will have this structure:

ebay-mcp-server/
├── src/                    # TypeScript source code
│   ├── tools/             # Individual eBay API tool implementations
│   ├── auth/              # Authentication logic
│   ├── types/             # TypeScript type definitions
│   └── index.ts           # Server entry point
├── build/                 # Compiled JavaScript (generated)
├── tests/                 # Test files
├── .env.example           # Example environment variables
├── package.json           # Project dependencies
├── tsconfig.json          # TypeScript configuration
└── README.md              # Project documentation

Troubleshooting Installation

Error: Node version too old

Problem: Your Node.js version is below 18.0.0

Solution:

1. Update Node.js from nodejs.org
2. Or use a version manager like nvm:
   nvm install 18
   nvm use 18
   

Error: npm install fails

Problem: Dependency installation errors

Solutions:

1. Clear npm cache:

   npm cache clean --force
   npm install
   

2. Delete node_modules and reinstall:

   rm -rf node_modules package-lock.json
   npm install
   

3. Check your internet connection and firewall settings

Error: Permission denied

Problem: Insufficient permissions during installation

Solutions:

macOS/Linux:

sudo chown -R $USER:$USER ebay-mcp-server
cd ebay-mcp-server
npm install

Windows:

• Run PowerShell or Command Prompt as Administrator
• Or adjust folder permissions in File Explorer

Error: Build fails

Problem: TypeScript compilation errors

Solutions:

1. Ensure TypeScript is installed:

   npm install -g typescript
   npm run build
   

2. Check for syntax errors in the output

3. Try a clean build:

   npm run clean
   npm run build
   

Git clone fails

Problem: Cannot clone the repository

Solutions:

1. Check your internet connection
2. Verify Git is installed: git --version
3. Try using HTTPS instead of SSH:
   git clone https://github.com/YosefHayim/ebay-mcp-server.git
   
4. Check if you’re behind a corporate firewall

Updating the Server

Keep your installation up to date:

1. Pull Latest Changes

   cd ebay-mcp-server
   git pull origin main
   
2. Update Dependencies

   npm install
   

   This updates any changed dependencies.

3. Rebuild

   npm run build
   
4. Run Tests

   npm test
   

   Ensure everything still works after the update.

Subscribe to the GitHub repository to receive notifications about updates and releases.

Uninstalling

To remove the eBay MCP Server:

# Remove the directory
cd ..
rm -rf ebay-mcp-server

# Optional: Remove from MCP client config
# Edit your MCP client's config file and remove the ebay server entry

Next Steps

Configuration

Set up your eBay API credentials

Quickstart Guide

Complete setup and connect to MCP client

Development Setup

Set up for local development

Testing

Run and write tests