ebay-mcp 1.6.1 → 1.6.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -98
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -99,6 +99,7 @@ For official eBay API support, please refer to the [eBay Developer Program](http
|
|
|
99
99
|
- [⚠️ Disclaimer](#️-disclaimer)
|
|
100
100
|
- [Features](#features)
|
|
101
101
|
- [Quick Start](#quick-start)
|
|
102
|
+
- [Demo](#demo)
|
|
102
103
|
- [Visual Setup Guide](#visual-setup-guide)
|
|
103
104
|
- [Configuration](#configuration)
|
|
104
105
|
- [Available Tools](#available-tools)
|
|
@@ -147,122 +148,65 @@ npm install
|
|
|
147
148
|
npm run build
|
|
148
149
|
```
|
|
149
150
|
|
|
150
|
-
### 3.
|
|
151
|
+
### 3. Run Setup Wizard
|
|
151
152
|
|
|
152
|
-
|
|
153
|
+
The interactive setup wizard handles everything for you:
|
|
153
154
|
|
|
154
155
|
```bash
|
|
155
156
|
npm run setup
|
|
156
157
|
```
|
|
157
158
|
|
|
158
|
-
|
|
159
|
+
The wizard will:
|
|
160
|
+
- Configure your eBay credentials
|
|
161
|
+
- Set up OAuth authentication (for higher rate limits)
|
|
162
|
+
- Auto-detect and configure your MCP client (Claude Desktop, etc.)
|
|
163
|
+
- Save all configuration automatically
|
|
159
164
|
|
|
160
165
|
---
|
|
161
166
|
|
|
162
|
-
##
|
|
167
|
+
## Demo
|
|
163
168
|
|
|
164
|
-
|
|
169
|
+
See the eBay MCP Server in action with Claude Desktop:
|
|
165
170
|
|
|
166
|
-
|
|
171
|
+
https://github.com/user-attachments/assets/0173c8df-221c-4943-a4ce-cd20bce79f4b
|
|
167
172
|
|
|
168
|
-
|
|
173
|
+
---
|
|
169
174
|
|
|
170
|
-
|
|
175
|
+
## Visual Setup Guide
|
|
171
176
|
|
|
172
|
-
|
|
173
|
-
```bash
|
|
174
|
-
EBAY_CLIENT_ID=your_app_id_here
|
|
175
|
-
EBAY_CLIENT_SECRET=your_cert_id_here
|
|
176
|
-
EBAY_ENVIRONMENT=sandbox # or "production"
|
|
177
|
-
```
|
|
177
|
+
The setup wizard (`npm run setup`) handles OAuth authentication automatically. Here's where to find your credentials in the eBay Developer Portal:
|
|
178
178
|
|
|
179
|
-
###
|
|
179
|
+
### Finding Your Credentials
|
|
180
180
|
|
|
181
|
-
|
|
181
|
+
**Step 1:** Navigate to [eBay Developer Portal](https://developer.ebay.com/my/keys) and copy your **App ID (Client ID)** and **Cert ID (Client Secret)**:
|
|
182
182
|
|
|
183
|
-

|
|
184
184
|
|
|
185
|
-
|
|
186
|
-
```bash
|
|
187
|
-
EBAY_REDIRECT_URI=your_runame_here
|
|
188
|
-
```
|
|
185
|
+
**Step 2:** In your app's **User Tokens** settings, copy the **RuName** (eBay Redirect URL):
|
|
189
186
|
|
|
190
|
-
|
|
187
|
+

|
|
191
188
|
|
|
192
|
-
|
|
189
|
+
### Running the Setup Wizard
|
|
193
190
|
|
|
194
|
-
|
|
195
|
-
npm run setup
|
|
196
|
-
```
|
|
191
|
+
Run `npm run setup` and enter your credentials when prompted. The wizard will:
|
|
197
192
|
|
|
198
|
-
|
|
193
|
+
1. Open your browser for OAuth login automatically
|
|
194
|
+
2. Guide you through the eBay sign-in process
|
|
199
195
|
|
|
200
196
|

|
|
201
197
|
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
After granting permissions, you'll be redirected to a URL containing an authorization code. Copy the **code** parameter from the URL and paste it into the setup wizard terminal.
|
|
198
|
+
3. Ask you to paste the authorization code from the callback URL
|
|
205
199
|
|
|
206
200
|

|
|
207
201
|
|
|
208
|
-
|
|
202
|
+
4. Exchange the code for tokens and save them automatically
|
|
203
|
+
5. Configure your MCP client (Claude Desktop, etc.)
|
|
209
204
|
|
|
210
205
|
**Success!** You now have user token authentication with 10k-50k requests/day instead of the default 1k/day.
|
|
211
206
|
|
|
212
207
|
---
|
|
213
208
|
|
|
214
|
-
### 4.
|
|
215
|
-
|
|
216
|
-
Add this server to your MCP client configuration:
|
|
217
|
-
|
|
218
|
-
**Claude Desktop:**
|
|
219
|
-
|
|
220
|
-
Edit your Claude Desktop config file:
|
|
221
|
-
|
|
222
|
-
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
223
|
-
- Windows: `%APPDATA%/Claude/claude_desktop_config.json`
|
|
224
|
-
- Linux: `~/.config/Claude/claude_desktop_config.json`
|
|
225
|
-
|
|
226
|
-
Add the server configuration:
|
|
227
|
-
|
|
228
|
-
```json
|
|
229
|
-
{
|
|
230
|
-
"mcpServers": {
|
|
231
|
-
"ebay": {
|
|
232
|
-
"command": "npx",
|
|
233
|
-
"args": ["-y", "ebay-mcp"],
|
|
234
|
-
"env": {
|
|
235
|
-
"EBAY_CLIENT_ID": "your_client_id",
|
|
236
|
-
"EBAY_CLIENT_SECRET": "your_client_secret",
|
|
237
|
-
"EBAY_ENVIRONMENT": "sandbox",
|
|
238
|
-
"EBAY_REDIRECT_URI": "your_runame"
|
|
239
|
-
}
|
|
240
|
-
}
|
|
241
|
-
}
|
|
242
|
-
}
|
|
243
|
-
```
|
|
244
|
-
|
|
245
|
-
**Alternative: Use locally installed version**
|
|
246
|
-
|
|
247
|
-
If you installed from source:
|
|
248
|
-
|
|
249
|
-
```json
|
|
250
|
-
{
|
|
251
|
-
"mcpServers": {
|
|
252
|
-
"ebay": {
|
|
253
|
-
"command": "node",
|
|
254
|
-
"args": ["/absolute/path/to/ebay-mcp/build/index.js"],
|
|
255
|
-
"env": {
|
|
256
|
-
"EBAY_CLIENT_ID": "your_client_id",
|
|
257
|
-
"EBAY_CLIENT_SECRET": "your_client_secret",
|
|
258
|
-
"EBAY_ENVIRONMENT": "sandbox"
|
|
259
|
-
}
|
|
260
|
-
}
|
|
261
|
-
}
|
|
262
|
-
}
|
|
263
|
-
```
|
|
264
|
-
|
|
265
|
-
### 5. Use
|
|
209
|
+
### 4. Use
|
|
266
210
|
|
|
267
211
|
Restart your MCP client (Claude Desktop, etc.) and start using eBay tools through your AI assistant.
|
|
268
212
|
|
|
@@ -272,32 +216,21 @@ Restart your MCP client (Claude Desktop, etc.) and start using eBay tools throug
|
|
|
272
216
|
|
|
273
217
|
### Environment Variables
|
|
274
218
|
|
|
275
|
-
|
|
219
|
+
The setup wizard (`npm run setup`) automatically creates and configures your `.env` file. For reference, these are the environment variables used:
|
|
276
220
|
|
|
277
221
|
```bash
|
|
278
222
|
EBAY_CLIENT_ID=your_client_id
|
|
279
223
|
EBAY_CLIENT_SECRET=your_client_secret
|
|
280
224
|
EBAY_ENVIRONMENT=sandbox # or "production"
|
|
281
225
|
EBAY_REDIRECT_URI=your_runame
|
|
282
|
-
|
|
283
|
-
# Optional: For higher rate limits (10k-50k req/day)
|
|
284
|
-
EBAY_USER_REFRESH_TOKEN=your_refresh_token
|
|
226
|
+
EBAY_USER_REFRESH_TOKEN=your_refresh_token # For higher rate limits
|
|
285
227
|
```
|
|
286
228
|
|
|
287
229
|
### OAuth Authentication
|
|
288
230
|
|
|
289
|
-
**Client Credentials (
|
|
290
|
-
|
|
291
|
-
- Default authentication method
|
|
292
|
-
- 1,000 requests/day
|
|
293
|
-
- No setup required beyond client ID and secret
|
|
294
|
-
|
|
295
|
-
**User Tokens (Recommended for Production):**
|
|
231
|
+
**Client Credentials (Default):** 1,000 requests/day - works automatically with just Client ID and Secret.
|
|
296
232
|
|
|
297
|
-
|
|
298
|
-
- Use `ebay_get_oauth_url` tool to generate authorization URL
|
|
299
|
-
- Add `EBAY_USER_REFRESH_TOKEN` to `.env` after OAuth flow
|
|
300
|
-
- Tokens refresh automatically
|
|
233
|
+
**User Tokens (Recommended):** 10,000-50,000 requests/day - the setup wizard handles the OAuth flow automatically. Tokens refresh automatically.
|
|
301
234
|
|
|
302
235
|
For detailed OAuth setup and comprehensive configuration guide, see the [Configuration Documentation](docs/auth/CONFIGURATION.md).
|
|
303
236
|
|
package/package.json
CHANGED