MCP Platform Setup
Connect Ecommerce Data API to ChatGPT, Hermes, WorkBuddy, or Claude Code with browser OAuth, direct API key access, or local stdio.
MCP Platform Setup
Use the production MCP endpoint:
https://ecommercedataapi.com/mcpIt uses Streamable HTTP and exposes 49 tools: 45 individual business tools and
the original 4 generic tools, plus 1 MCP Prompt. Business tool names derive
from canonical API URLs, for example amazon_asin_detail and
amazon_asin_competitor. OCR file uploads remain REST only.
Fastest path: send your API key and this page to the AI
If your Agent can edit its own MCP configuration (for example WorkBuddy, Claude Code, Cursor, Codex, or Hermes), you do not need to edit config files yourself. Copy your full key from the API Keys page, put it in the template below, and send the whole message. With the key and the documentation link in one message, the AI can write the configuration without stopping to ask you for the key.
Copy for your AI to set up MCP
Replace the placeholder with your API key, then send it to an Agent that can edit its own MCP configuration.
Add Ecommerce Data API as an MCP server in the MCP configuration of your current client. Documentation: https://ecommercedataapi.com/en/docs/mcp-platforms My API key: <paste your API key here> Requirements: 1. Use the direct API key method from the documentation: Streamable HTTP transport, URL https://ecommercedataapi.com/mcp, header Authorization: Bearer <the key above> (one ASCII space after Bearer). 2. Add only one server named ecommerce-data-api and keep every other MCP configuration. Do not put the key in the URL. 3. Do not repeat the full key in your reply. 4. When done, tell me whether I need to restart or reconnect. After connecting, use ecommerce_account to check my remaining credits. Do not call paid data APIs yet.
The key stays in this chat history. Create a dedicated key for AI clients, and reset or delete it on the API Keys page when you no longer need it. ChatGPT web cannot have its configuration edited by the AI; use the OAuth steps below.
Which connection should I use?
| Client | Remote browser OAuth | Local stdio | Recommended path |
|---|---|---|---|
| ChatGPT web | Supported | No | Add a custom MCP server in Plugins |
| Hermes | Depends on its Streamable HTTP OAuth support | Depends on its stdio support | Use OAuth when available |
| WorkBuddy | This guide uses an API key | Depends on its stdio support | Use the direct API key configuration below |
| Claude Code | Supported | Supported | Use remote OAuth or local stdio |
OAuth clients need OAuth 2.1 with PKCE S256. Direct API key access remains a fallback for clients that only accept a fixed Bearer Token.
ChatGPT web
- Open the ChatGPT plugin settings at chatgpt.com/settings/plugins-settings and set Default permissions to Allow low-risk tools. Then open chatgpt.com/plugins, click Add, and choose Add custom MCP server.
- Enter the production URL as the server URL and choose OAuth.
- Sign in to Ecommerce Data API.
- Select an active key and confirm, or explicitly choose Create and authorize. A single existing key is preselected but still requires confirmation.
- Return to ChatGPT, start a new conversation, and ask:
Use ecommerce_account to check my credits. Do not call paid data APIs yet.
OAuth access tokens last 30 days by default. Refresh tokens last 90 days and are
rotated with a new expiration on successful refresh. Clients with refresh-token support
can renew access automatically. If an older connection disconnected after expiry,
recreate the app in ChatGPT and authorize it again to fetch the updated
offline_access configuration. You do not need to reset your API key.
ChatGPT client: connect with an API key in Plugins
If your client shows Settings → Plugins → MCP, you can also connect directly:
- Select Add → Add MCP server, choose Streamable HTTP, and name it
Ecommerce Data API. - Enter
https://ecommercedataapi.com/mcpas the URL. - Under Headers, add
Authorizationwith the valueBearer <YOUR_API_KEY>. Keep one ASCII space afterBearer; leave Bearer token environment variable empty. - Save and enable the server. In a new chat, use the credits check above to confirm
ecommerce_accountis available.
This method stores the raw API key in the client and does not start browser OAuth. Keep the key out of URLs, screenshots, and shared configuration files. Reset or delete the key to stop direct access.
Hermes
Add a remote server, choose Streamable HTTP, enter the production URL, and choose OAuth / browser authorization when the client offers it. Sign in, select or create and authorize a key, confirm, and refresh the connection.
If Hermes only accepts a fixed Bearer Token, use the direct API key fallback described below. Protocol compatibility alone does not establish that a particular Hermes build has completed the OAuth flow.
WorkBuddy
Use direct API key access for WorkBuddy. The easiest way is to send the template above, with your key and this page, to WorkBuddy and let it write the configuration. You can also configure it manually with the steps below.
The user configuration is ~/.workbuddy/mcp.json; Windows uses
%USERPROFILE%\\.workbuddy\\mcp.json. Project configuration is
.workbuddy/mcp.json. Add only this server entry to an existing
mcpServers object. Do not replace other MCP configurations.
WorkBuddy direct API key fallback
- Create a key on the API Keys page, or copy an existing full key.
- Replace
YOUR_API_KEYbelow with your key. Keep one space betweenBearerand the key. - Save the configuration, then enable or reconnect this MCP server in WorkBuddy.
{
"mcpServers": {
"ecommerce-data-api": {
"type": "http",
"url": "https://ecommercedataapi.com/mcp",
"headers": {
"Authorization": "Bearer YOUR_API_KEY"
}
}
}
}Keep the key out of the URL and local documentation. This method stores the raw key in the client and does not provide a browser authorization connection.
After connecting, confirm that individual tools such as amazon_asin_detail
and the generic ecommerce_api_search, ecommerce_api_describe,
ecommerce_api_call, and ecommerce_account are visible. The retained Prompt is named
ecommerce-data-api, titled Ecommerce Data API, with optional task up
to 4,000 characters. Selecting it only loads instructions; it does not query
data or charge credits. Slash-menu visibility depends on the client, and
natural-language requests remain available.
Claude Code remote OAuth
Install the plugin from inside Claude Code. It adds this MCP server and the Agent Skill together:
/plugin install ecommerce-data-api --marketplace ecommercedataapi/ecommerce-data-apiTo add only the MCP server:
claude mcp add --transport http ecommerce-data-api https://ecommercedataapi.com/mcpOpen /mcp, choose browser authorization, sign in, select or create and
authorize a key, confirm, and return to Claude Code.
Claude Code local stdio
The local installer and stdio connection still use an API key, not OAuth:
curl -fsSL https://ecommercedataapi.com/install.sh | bash -s -- --yes --only claude-codeEnter the key in the installer's local prompt. Use CLI 0.2.2 or later, then
run ecomdata doctor and ecomdata mcp status. Remote URL users do not need
the CLI.
Billing and key lifecycle
MCP and REST share the account balance. One chat request may trigger several billable data queries. Keys have no separate budgets, permissions, or rate limits. Resetting, deleting, or expiring the selected key invalidates access; switching an OAuth key requires new authorization.
Revoking an MCP connection does not delete or disable the REST key and does not stop direct API key access. Reset or delete the key to stop that access. Failed paid requests are not automatically retried.
See the official WorkBuddy connector guide and MCP guide.