ebay-api-mcp-server-node-local 1.0.2 → 1.0.9
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/.yarn/plugins/@yarnpkg/plugin-version.cjs +550 -0
- package/.yarn/versions/74b6950d.yml +0 -0
- package/.yarn/versions/cda532b6.yml +0 -0
- package/.yarnrc.yml +7 -0
- package/CONTRIBUTING.md +41 -0
- package/LICENSE.txt +201 -0
- package/README.md +94 -155
- package/dist/constant/constants.js +7 -6
- package/dist/constant/constants.js.map +1 -1
- package/dist/helper/http-helper.js +7 -7
- package/dist/helper/http-helper.js.map +1 -1
- package/dist/helper/openapi-helper.js +4 -2
- package/dist/helper/openapi-helper.js.map +1 -1
- package/dist/helper/validation-helper.js +6 -0
- package/dist/helper/validation-helper.js.map +1 -1
- package/dist/index.js +1 -5
- package/dist/index.js.map +1 -1
- package/dist/service/openapi-service.js +101 -13
- package/dist/service/openapi-service.js.map +1 -1
- package/eslint.config.js +58 -0
- package/package.json +6 -5
- package/src/constant/constants.ts +54 -0
- package/src/helper/http-helper.ts +153 -0
- package/src/helper/openapi-helper.ts +119 -0
- package/src/helper/validation-helper.ts +296 -0
- package/src/index.ts +70 -0
- package/src/integration.test.ts +140 -0
- package/src/service/openapi-service.ts +339 -0
- package/tsconfig.build.json +9 -0
- package/tsconfig.json +115 -0
- package/tsconfig.node.json +7 -0
- package/vitest.config.ts +20 -0
- package/vitest.setup.ts +6 -0
|
File without changes
|
|
File without changes
|
package/.yarnrc.yml
ADDED
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Contributing to npm-public-api-mcp
|
|
2
|
+
|
|
3
|
+
Thank you for your interest in contributing to this project! We welcome all contributions, including bug fixes, new features, documentation improvements, and more.
|
|
4
|
+
|
|
5
|
+
## How to Contribute
|
|
6
|
+
|
|
7
|
+
1. **Fork the repository**
|
|
8
|
+
Click the "Fork" button at the top right to create your own copy of the repository.
|
|
9
|
+
|
|
10
|
+
2. **Create a branch**
|
|
11
|
+
Create a new branch for your work with a descriptive name.
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
git checkout -b feature/your-feature-name
|
|
15
|
+
|
|
16
|
+
3. **Make your changes**
|
|
17
|
+
Implement your changes and commit them with clear commit messages.
|
|
18
|
+
```sh
|
|
19
|
+
git add .
|
|
20
|
+
git commit -m "Describe your changes"
|
|
21
|
+
|
|
22
|
+
4. **Push your branch and open a Pull Request**
|
|
23
|
+
Push your branch to your fork and open a Pull Request on GitHub.
|
|
24
|
+
```sh
|
|
25
|
+
git push origin feature/your-feature-name
|
|
26
|
+
|
|
27
|
+
5. **Respond to review**
|
|
28
|
+
Project maintainers will review your Pull Request and may request changes. Please respond promptly.
|
|
29
|
+
|
|
30
|
+
## Code Style
|
|
31
|
+
- Follow the project's ESLint rules.
|
|
32
|
+
- Use Prettier for code formatting.
|
|
33
|
+
- Add or update tests for any new features or bug fixes.
|
|
34
|
+
|
|
35
|
+
## Reporting Issues
|
|
36
|
+
If you find a bug or have a suggestion, please open an Issue and provide as much detail as possible.
|
|
37
|
+
|
|
38
|
+
## Contact
|
|
39
|
+
For questions, use Issues or Pull Requests to communicate with maintainers.
|
|
40
|
+
|
|
41
|
+
Thank you for contributing!
|
package/LICENSE.txt
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,214 +1,153 @@
|
|
|
1
1
|
# eBay API MCP Server
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Seamlessly integrate eBay's APIs into your AI assistant workflow. This MCP server enables Claude Desktop, Cursor, Cline, and other AI tools to discover and call eBay marketplace APIs directly.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## What Does This Do?
|
|
6
6
|
|
|
7
|
-
This MCP server
|
|
7
|
+
This MCP server gives your AI assistant superpowers to:
|
|
8
|
+
- 🔍 **Search for eBay APIs** - Find the right endpoint for any marketplace need
|
|
9
|
+
- 📋 **Browse API documentation** - Get detailed specs, parameters, and examples
|
|
10
|
+
- 🚀 **Make real API calls** - Execute live requests to eBay's production or sandbox APIs
|
|
11
|
+
- 💬 **Natural language interface** - Just describe what you want, no need to memorize endpoints
|
|
8
12
|
|
|
9
|
-
|
|
13
|
+
## Quick Start
|
|
10
14
|
|
|
11
|
-
|
|
12
|
-
- **Dynamic Tool Generation**: Generate tools based on OpenAPI specifications
|
|
13
|
-
- **Multi-Environment Support**: Works with both sandbox and production environments
|
|
14
|
-
- **Comprehensive API Coverage**: Supports eBay's full API ecosystem
|
|
15
|
-
- **Type-Safe Operations**: Built with TypeScript for robust API interactions
|
|
16
|
-
- **MCP Integration**: Compatible with popular MCP hosts and AI assistants
|
|
15
|
+
### 1. Get Your eBay API Token
|
|
17
16
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
- **Node.js**: Version 22 or higher
|
|
21
|
-
- **eBay Developer Account**: Required for API access tokens
|
|
22
|
-
- **MCP Host**: Claude Desktop, Cursor, Cline, or other MCP-compatible application
|
|
23
|
-
|
|
24
|
-
## Installation
|
|
25
|
-
|
|
26
|
-
### 1. Clone and Setup
|
|
27
|
-
|
|
28
|
-
```bash
|
|
29
|
-
git clone <repository-url>
|
|
30
|
-
cd ebay-api-mcp-server-node-local
|
|
31
|
-
npm install
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
### 2. Build the Project
|
|
35
|
-
|
|
36
|
-
```bash
|
|
37
|
-
npm run build
|
|
38
|
-
# or
|
|
39
|
-
yarn build
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
### 3. Environment Configuration
|
|
43
|
-
|
|
44
|
-
Set the following environment variables:
|
|
45
|
-
|
|
46
|
-
- `EBAY_CLIENT_TOKEN`: Your eBay API access token (required)
|
|
47
|
-
- `EBAY_API_ENV`: API environment - "sandbox" or "production" (default: "production")
|
|
48
|
-
|
|
49
|
-
## Authentication
|
|
50
|
-
|
|
51
|
-
### Obtaining an eBay API Token
|
|
52
|
-
|
|
53
|
-
#### Method 1: Using cURL
|
|
17
|
+
You'll need an eBay developer account and API token. Get one by running:
|
|
54
18
|
|
|
55
19
|
```bash
|
|
56
20
|
curl -v https://api.ebay.com/identity/v1/oauth2/token \
|
|
57
21
|
-H "Accept: application/json" \
|
|
58
22
|
-H "Accept-Language: en_US" \
|
|
59
|
-
-u "
|
|
60
|
-
-d "grant_type=client_credentials"
|
|
23
|
+
-u "YOUR_CLIENT_ID:YOUR_CLIENT_SECRET" \
|
|
24
|
+
-d "grant_type=client_credentials&scope=scopes"
|
|
61
25
|
```
|
|
26
|
+
scopes must be URL encoded value of space seperated scope values
|
|
62
27
|
|
|
63
28
|
For sandbox testing, use `https://api.sandbox.ebay.com/identity/v1/oauth2/token`
|
|
64
29
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
1. Create a POST request to `https://api.ebay.com/identity/v1/oauth2/token`
|
|
68
|
-
2. Set Authorization to Basic Auth with your Client ID and Client Secret
|
|
69
|
-
3. Add form data: `grant_type=client_credentials`
|
|
70
|
-
4. Send the request
|
|
71
|
-
|
|
72
|
-
Response format:
|
|
73
|
-
```json
|
|
74
|
-
{
|
|
75
|
-
"access_token": "your_access_token_here",
|
|
76
|
-
"expires_in": 7200,
|
|
77
|
-
"token_type": "Application Access Token"
|
|
78
|
-
}
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
## Usage
|
|
82
|
-
|
|
83
|
-
### Running the Server
|
|
84
|
-
|
|
85
|
-
#### With Environment Variables Set
|
|
86
|
-
|
|
87
|
-
```bash
|
|
88
|
-
npm start
|
|
89
|
-
# or
|
|
90
|
-
yarn start
|
|
91
|
-
```
|
|
30
|
+
### 2. Install and Run
|
|
92
31
|
|
|
93
|
-
|
|
32
|
+
The easiest way to use this server is via npx:
|
|
94
33
|
|
|
95
34
|
```bash
|
|
96
|
-
EBAY_CLIENT_TOKEN='your_token_here' EBAY_API_ENV='production' npm
|
|
35
|
+
EBAY_CLIENT_TOKEN='your_token_here' EBAY_API_ENV='production' npx @ebay/npm-public-api-mcp@latest
|
|
97
36
|
```
|
|
98
37
|
|
|
99
|
-
|
|
38
|
+
That's it! The server is now running and ready to be connected to your AI assistant.
|
|
100
39
|
|
|
101
|
-
|
|
40
|
+
## Configuration for AI Assistants
|
|
102
41
|
|
|
103
|
-
|
|
104
|
-
```bash
|
|
105
|
-
# First build the project
|
|
106
|
-
npm run build
|
|
42
|
+
### Claude Desktop
|
|
107
43
|
|
|
108
|
-
|
|
109
|
-
npx node dist/index.js
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
**Option 2: Run with environment variables**
|
|
113
|
-
```bash
|
|
114
|
-
# Build first
|
|
115
|
-
npm run build
|
|
116
|
-
|
|
117
|
-
# Run with environment variables
|
|
118
|
-
EBAY_CLIENT_TOKEN='your_token_here' EBAY_API_ENV='production' npx node dist/index.js
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
**Option 3: Use npx to run npm scripts**
|
|
122
|
-
```bash
|
|
123
|
-
npx npm run build
|
|
124
|
-
npx npm start
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
**Option 4: Run TypeScript directly (if you have ts-node)**
|
|
128
|
-
```bash
|
|
129
|
-
npx ts-node src/index.ts
|
|
130
|
-
```
|
|
131
|
-
|
|
132
|
-
## MCP Integration
|
|
133
|
-
|
|
134
|
-
### Configuration for Popular MCP Hosts
|
|
135
|
-
|
|
136
|
-
#### VS Code with MCP Extension
|
|
137
|
-
|
|
138
|
-
1. Create a `.vscode` folder in your project root
|
|
139
|
-
2. Create `mcp.json` with the following configuration:
|
|
44
|
+
Add to your Claude Desktop configuration:
|
|
140
45
|
|
|
141
46
|
```json
|
|
142
47
|
{
|
|
143
|
-
"
|
|
144
|
-
"ebay-api
|
|
145
|
-
"
|
|
146
|
-
"
|
|
147
|
-
|
|
48
|
+
"mcpServers": {
|
|
49
|
+
"ebay-api": {
|
|
50
|
+
"command": "npx",
|
|
51
|
+
"args": [
|
|
52
|
+
"-y",
|
|
53
|
+
"@ebay/npm-public-api-mcp@latest"
|
|
54
|
+
],
|
|
148
55
|
"env": {
|
|
149
|
-
"
|
|
150
|
-
"
|
|
56
|
+
"EBAY_CLIENT_TOKEN": "YOUR_ACCESS_TOKEN",
|
|
57
|
+
"EBAY_API_ENV": "production"
|
|
151
58
|
}
|
|
152
59
|
}
|
|
153
60
|
}
|
|
154
61
|
}
|
|
155
62
|
```
|
|
156
63
|
|
|
157
|
-
|
|
64
|
+
### VS Code with MCP Extension
|
|
158
65
|
|
|
159
|
-
|
|
66
|
+
Create `.vscode/mcp.json` in your project:
|
|
160
67
|
|
|
161
68
|
```json
|
|
162
69
|
{
|
|
163
|
-
"
|
|
70
|
+
"servers": {
|
|
164
71
|
"ebay-api": {
|
|
165
|
-
"
|
|
166
|
-
"
|
|
72
|
+
"type": "stdio",
|
|
73
|
+
"command": "npx",
|
|
74
|
+
"args": [
|
|
75
|
+
"-y",
|
|
76
|
+
"@ebay/npm-public-api-mcp@latest"
|
|
77
|
+
],
|
|
167
78
|
"env": {
|
|
168
|
-
"
|
|
169
|
-
"
|
|
79
|
+
"EBAY_API_ENV": "production",
|
|
80
|
+
"EBAY_CLIENT_TOKEN": "YOUR_ACCESS_TOKEN"
|
|
170
81
|
}
|
|
171
82
|
}
|
|
172
83
|
}
|
|
173
84
|
}
|
|
174
85
|
```
|
|
175
86
|
|
|
176
|
-
|
|
87
|
+
### Cursor
|
|
177
88
|
|
|
178
|
-
Configure in
|
|
89
|
+
Configure in Cursor's MCP settings using the same JSON structure as Claude Desktop.
|
|
179
90
|
|
|
180
|
-
|
|
91
|
+
## Usage Examples
|
|
181
92
|
|
|
182
|
-
Once
|
|
93
|
+
Once connected, ask your AI assistant things like:
|
|
183
94
|
|
|
184
|
-
- "Find
|
|
185
|
-
-
|
|
186
|
-
- "Get documentation for the Trading API"
|
|
187
|
-
- "Invoke the getBuyerRequirements endpoint"
|
|
95
|
+
- **"Find eBay APIs for listing products"**
|
|
96
|
+
- Discovers endpoints for creating and managing listings
|
|
188
97
|
|
|
189
|
-
|
|
98
|
+
- **"Search for order management APIs"**
|
|
99
|
+
- Returns APIs for processing orders, shipping, and fulfillment
|
|
100
|
+
|
|
101
|
+
- **"Get details about the findItemsByKeywords endpoint"**
|
|
102
|
+
- Shows parameters, response format, and usage examples
|
|
103
|
+
|
|
104
|
+
- **"Call the getItem API for item ID 123456789"**
|
|
105
|
+
- Makes a real API call and returns the item details
|
|
106
|
+
|
|
107
|
+
- **"What APIs can I use for inventory management?"**
|
|
108
|
+
- Finds all relevant inventory APIs with documentation
|
|
190
109
|
|
|
191
|
-
|
|
110
|
+
## Environment Variables
|
|
192
111
|
|
|
193
|
-
|
|
194
|
-
|
|
112
|
+
| Variable | Description | Default |
|
|
113
|
+
|----------|-------------|---------|
|
|
114
|
+
| `EBAY_CLIENT_TOKEN` | Your eBay API access token (required) | - |
|
|
115
|
+
| `EBAY_API_ENV` | API environment: "sandbox" or "production" | "production" |
|
|
116
|
+
|
|
117
|
+
## API Coverage
|
|
118
|
+
|
|
119
|
+
This server provides access to eBay's complete API ecosystem:
|
|
120
|
+
|
|
121
|
+
- **Selling APIs**: Listings, inventory, orders, fulfillment
|
|
122
|
+
- **Buying APIs**: Shopping, checkout, bidding
|
|
123
|
+
- **Commerce APIs**: Catalog, taxonomy, translation
|
|
124
|
+
- **Marketing APIs**: Promotions, campaigns, analytics
|
|
125
|
+
- **Developer APIs**: Analytics, metadata, notifications
|
|
126
|
+
|
|
127
|
+
## Troubleshooting
|
|
128
|
+
|
|
129
|
+
### "Authentication Failed" Error
|
|
130
|
+
- Verify your token hasn't expired (tokens typically last 2 hours)
|
|
195
131
|
- Ensure you're using the correct environment (sandbox vs production)
|
|
196
|
-
- Check that your
|
|
132
|
+
- Check that your app has the necessary scopes
|
|
133
|
+
|
|
134
|
+
### "API Not Found" Error
|
|
135
|
+
- Some APIs may be restricted based on your eBay developer account type
|
|
136
|
+
- Verify the API name and try searching with different keywords
|
|
137
|
+
|
|
138
|
+
### Connection Issues
|
|
139
|
+
- Make sure npx is installed and working: `npx --version`
|
|
140
|
+
- Check that Node.js version 22+ is installed: `node --version`
|
|
141
|
+
- Verify environment variables are set correctly
|
|
197
142
|
|
|
198
|
-
|
|
199
|
-
- Verify the path to `dist/index.js` in your MCP configuration
|
|
200
|
-
- Ensure Node.js is in your system PATH
|
|
201
|
-
- Check that the server builds successfully with `npm run build`
|
|
143
|
+
## Getting Help
|
|
202
144
|
|
|
203
|
-
**API
|
|
204
|
-
-
|
|
205
|
-
-
|
|
206
|
-
- Check rate limiting and usage quotas
|
|
145
|
+
- **eBay API Documentation**: [developer.ebay.com](https://developer.ebay.com/)
|
|
146
|
+
- **MCP Protocol**: [modelcontextprotocol.io](https://modelcontextprotocol.io/)
|
|
147
|
+
- **Issues**: Open an issue in this repository
|
|
207
148
|
|
|
149
|
+
## License
|
|
208
150
|
|
|
209
|
-
|
|
151
|
+
Apache 2.0 - See [LICENSE][license-url] for more information.
|
|
210
152
|
|
|
211
|
-
|
|
212
|
-
- **eBay API**: Consult the [eBay Developer Documentation](https://developer.ebay.com/)
|
|
213
|
-
- **MCP Protocol**: Visit the [Model Context Protocol documentation](https://modelcontextprotocol.io/)
|
|
214
|
-
- **This Server**: Open an issue in this repository
|
|
153
|
+
[license-url]:https://github.corp.ebay.com/globalcommerce/npm-public-api-mcp/blob/main/LICENSE
|
|
@@ -11,26 +11,27 @@ export var ApiEnvironment;
|
|
|
11
11
|
})(ApiEnvironment || (ApiEnvironment = {}));
|
|
12
12
|
/**
|
|
13
13
|
* Utility to find ApiEnvironment by string value
|
|
14
|
-
* Returns
|
|
14
|
+
* Returns PRODUCTION if no match is found
|
|
15
15
|
*/
|
|
16
|
-
|
|
16
|
+
function findApiEnvironmentByValue(value) {
|
|
17
17
|
const lowercaseValue = value?.toLowerCase();
|
|
18
18
|
const matchedEnv = Object.entries(ApiEnvironment)
|
|
19
19
|
.find(([_key, val]) => typeof val === "string" && val.toLowerCase() === lowercaseValue);
|
|
20
|
-
return matchedEnv ? matchedEnv[1] : ApiEnvironment.
|
|
20
|
+
return matchedEnv ? matchedEnv[1] : ApiEnvironment.PRODUCTION;
|
|
21
21
|
}
|
|
22
|
+
export const USER_ENVIRONMENT = findApiEnvironmentByValue(process.env.EBAY_API_ENV || "");
|
|
22
23
|
/**
|
|
23
24
|
* Recall apiDoc url by prompt
|
|
24
25
|
*/
|
|
25
|
-
export const RECALL_SPEC_BY_PROMPT_URL = "https://
|
|
26
|
+
export const RECALL_SPEC_BY_PROMPT_URL = "https://api.ebay.com/developer/mcp/v1/search?query=%s";
|
|
26
27
|
/**
|
|
27
28
|
* url for query apiSpec with fields such as specTitle、operationId
|
|
28
29
|
*/
|
|
29
|
-
export const RECALL_SPEC_WITH_FIELD_URL = "https://
|
|
30
|
+
export const RECALL_SPEC_WITH_FIELD_URL = "https://api.ebay.com/developer/mcp/v1/search/%s?operationId=%s";
|
|
30
31
|
/**
|
|
31
32
|
* Required environment variable names for the application
|
|
32
33
|
*/
|
|
33
|
-
export const REQUIRED_ENV_VARS = ["EBAY_CLIENT_TOKEN"
|
|
34
|
+
export const REQUIRED_ENV_VARS = ["EBAY_CLIENT_TOKEN"];
|
|
34
35
|
/**
|
|
35
36
|
* API domain name, differentiated by api environment
|
|
36
37
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constant/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,CAAN,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,2CAAyB,CAAA;AAC3B,CAAC,EAHW,cAAc,KAAd,cAAc,QAGzB;AACD;;;GAGG;AACH,
|
|
1
|
+
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constant/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,CAAN,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,2CAAyB,CAAA;AAC3B,CAAC,EAHW,cAAc,KAAd,cAAc,QAGzB;AACD;;;GAGG;AACH,SAAS,yBAAyB,CAAC,KAAa;IAC9C,MAAM,cAAc,GAAG,KAAK,EAAE,WAAW,EAAE,CAAC;IAC5C,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC;SAC9C,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAC;IAC1F,OAAO,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAmB,CAAC,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC;AAClF,CAAC;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,yBAAyB,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC;AAG1F;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,uDAAuD,CAAC;AACjG;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,gEAAgE,CAAC;AAE3G;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,mBAAmB,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,sBAAsB;IAChD,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,cAAc;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC;IAC/F,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,CAAC;CACrC,CAAC"}
|
|
@@ -2,8 +2,7 @@
|
|
|
2
2
|
* Helper functions for HTTP requests
|
|
3
3
|
*/
|
|
4
4
|
import axios from "axios";
|
|
5
|
-
import { DOMAIN_NAME,
|
|
6
|
-
const USER_ENVIRONMENT = findApiEnvironmentByValue(process.env.EBAY_API_ENV || "");
|
|
5
|
+
import { ApiEnvironment, DOMAIN_NAME, USER_ENVIRONMENT } from "../constant/constants.js";
|
|
7
6
|
const USER_TOKEN = process.env.EBAY_CLIENT_TOKEN || "";
|
|
8
7
|
const SCHEMA_REQUEST_BODY = "requestBody";
|
|
9
8
|
/**
|
|
@@ -19,9 +18,10 @@ export function formatAxiosError(error) {
|
|
|
19
18
|
return errorMessage;
|
|
20
19
|
}
|
|
21
20
|
/**
|
|
21
|
+
* needSetHostByEnv indicates whether to set the Host header based on the environment : If false, it uses the default production domain
|
|
22
22
|
* Build headers from input headers and fill with default headers
|
|
23
23
|
*/
|
|
24
|
-
export function buildHeadersFromInput(inputHeaders) {
|
|
24
|
+
export function buildHeadersFromInput(inputHeaders, needSetHostByEnv) {
|
|
25
25
|
const headers = {};
|
|
26
26
|
if (inputHeaders) {
|
|
27
27
|
for (const [key, value] of Object.entries(inputHeaders)) {
|
|
@@ -29,11 +29,11 @@ export function buildHeadersFromInput(inputHeaders) {
|
|
|
29
29
|
}
|
|
30
30
|
}
|
|
31
31
|
// Add default headers
|
|
32
|
-
fillDefaultHeaderInfo(headers);
|
|
32
|
+
fillDefaultHeaderInfo(headers, needSetHostByEnv);
|
|
33
33
|
return headers;
|
|
34
34
|
}
|
|
35
|
-
export function fillDefaultHeaderInfo(headers) {
|
|
36
|
-
headers["Host"] = DOMAIN_NAME[USER_ENVIRONMENT];
|
|
35
|
+
export function fillDefaultHeaderInfo(headers, needSetHostByEnv) {
|
|
36
|
+
headers["Host"] = needSetHostByEnv ? DOMAIN_NAME[USER_ENVIRONMENT] : DOMAIN_NAME[ApiEnvironment.PRODUCTION];
|
|
37
37
|
headers["User-Agent"] = "EBAY-API-MCP-Tool/1.0";
|
|
38
38
|
headers["Authorization"] = `Bearer ${USER_TOKEN}`;
|
|
39
39
|
headers["Content-Type"] = headers["Content-Type"] || "application/json";
|
|
@@ -131,7 +131,7 @@ export function prepareRequestData(input, operation, path) {
|
|
|
131
131
|
}
|
|
132
132
|
}
|
|
133
133
|
});
|
|
134
|
-
fillDefaultHeaderInfo(headers);
|
|
134
|
+
fillDefaultHeaderInfo(headers, false);
|
|
135
135
|
if (Object.keys(pathParams).length > 0) {
|
|
136
136
|
resolvedPath = resolvePath(resolvedPath, pathParams);
|
|
137
137
|
}
|