Comprehensive documentation for the eBay MCP Server - A Model Context Protocol implementation that provides AI assistants with full access to eBay's Sell APIs through 230+ tools.
Independent Open Source Project
This is an independent, community-driven open source project created to contribute to the eBay developer community. We do not claim ownership of eBay, its APIs, trademarks, or any related intellectual property. All eBay-related trademarks, service marks, and intellectual property belong to eBay Inc.
This project is not affiliated with, endorsed by, or officially connected to eBay Inc. in any way. We are developers who built this tool to help the community interact with eBay's publicly available APIs using the Model Context Protocol.
Use of eBay's APIs is subject to eBay's Developer Program Terms and API License Agreement.
Visit ebaymcp.com to browse the complete documentation with:
- ✅ Full search functionality
- ✅ Dark/light mode
- ✅ Mobile-optimized layout
- ✅ AI-powered contextual help
- ✅ Interactive code examples
Preview the documentation on your machine:
# Install Mintlify CLI
npm install -g mintlify
# Clone this repository
git clone https://github.com/YosefHayim/ebay-mcp-docs.git
cd ebay-mcp-docs
# Start local server
mintlify devOpen http://localhost:3000 in your browser.
| Resource | Description | Link |
|---|---|---|
| 📚 Live Docs | Complete documentation site | ebaymcp.com |
| 🚀 Quickstart | Get started in 10 minutes | View Guide |
| 💻 Server Repo | eBay MCP Server source code | GitHub |
| 🤝 Contribute | Help improve the docs | Contributing Guide |
| 🛡️ Security | Report security issues | Security Policy |
| 📜 Code of Conduct | Community guidelines | View Code of Conduct |
This documentation covers:
- Getting Started: Installation, configuration, and quickstart guides
- Authentication: OAuth 2.0 setup, token management, and client credentials
- Core Features: Inventory management, order fulfillment, marketing, analytics
- MCP Integration: Claude Desktop, Cursor, and other MCP clients
- API Reference: Complete documentation of all 230+ eBay tools
- Advanced Topics: Architecture, testing, contributing, and best practices
- Support: Troubleshooting, FAQ, and changelog
- API Coverage: 99.1% (110/111 eBay Sell APIs endpoints)
- Tools Available: 230+ eBay Sell APIs tools
- Test Coverage: 870+ tests with 99%+ function coverage
- Rate Limits: 10,000-50,000 requests/day with user tokens
- License: Apache 2.0
- Technology: TypeScript, Node.js 18+, MCP SDK 1.21.1
This documentation is built with Mintlify, a modern documentation platform optimized for developer experience and AI integration.
Install the Mintlify CLI:
npm install -g mintlifyPreview the documentation locally:
cd ebay-mcp-docs
mintlify devThe documentation will be available at http://localhost:3000.
ebay-mcp-docs/
├── docs.json # Mintlify configuration
├── index.mdx # Homepage
├── quickstart.mdx # Quick start guide
├── installation.mdx # Installation guide
├── configuration.mdx # Configuration guide
├── llms.txt # AI optimization (2025 best practice)
├── CLAUDE.md # Claude Code context file
├── authentication/ # Auth documentation
│ ├── overview.mdx
│ ├── oauth-setup.mdx
│ ├── token-management.mdx
│ └── client-credentials.mdx
├── features/ # Feature guides
│ ├── inventory-management.mdx
│ ├── order-fulfillment.mdx
│ ├── marketing-campaigns.mdx
│ ├── analytics-reporting.mdx
│ └── account-management.mdx
├── guides/ # Practical guides
│ ├── first-listing.mdx
│ ├── managing-orders.mdx
│ ├── running-promotions.mdx
│ ├── bulk-operations.mdx
│ └── best-practices.mdx
├── mcp/ # MCP client integration
│ ├── claude-desktop.mdx
│ ├── cursor.mdx
│ └── other-clients.mdx
├── api-reference/ # API documentation
│ ├── introduction.mdx
│ ├── account/
│ ├── inventory/
│ ├── fulfillment/
│ ├── marketing/
│ └── analytics/
├── advanced/ # Advanced topics
│ ├── architecture.mdx
│ ├── error-handling.mdx
│ ├── rate-limits.mdx
│ ├── testing.mdx
│ └── contributing.mdx
└── support/ # Support resources
├── troubleshooting.mdx
├── faq.mdx
└── changelog.mdx
This documentation uses Mintlify's rich component library:
- Cards & Card Groups: Feature showcases and navigation
- Steps: Sequential procedures and guides
- Accordions: Collapsible supplementary content
- Tabs: Alternative approaches or platforms
- Callouts: Notes, Tips, Warnings, Info boxes
- Code Groups: Multi-language code examples
- Frames: Styled images and screenshots
Following Mintlify's 2025 best practices:
- llms.txt: Prioritized content for AI ingestion
- MCP Server Ready: Auto-generated MCP servers for API docs
- Contextual Options: Copy, view, ChatGPT, Claude, Perplexity, MCP, Cursor, VSCode
- Semantic Structure: Optimized for LLM understanding
- Comprehensive ARIA attributes
- Keyboard navigation support
- Screen reader optimization
- Descriptive alt text on all images
- Skip to main content functionality
We welcome contributions from the community! Here's how you can help:
- 📝 Fix typos or improve clarity - Small improvements make a big difference
- 🐛 Report bugs - Found broken links or errors? Let us know
- ✨ Add examples - Share your use cases and code examples
- 🌍 Translate - Help make docs accessible in other languages
- 🎨 Improve design - Enhance UI/UX or accessibility
- 📚 Write new content - Add missing documentation
- Fork this repository on GitHub
- Clone your fork:
git clone https://github.com/YOUR_USERNAME/ebay-mcp-docs.git cd ebay-mcp-docs - Install Mintlify and preview locally:
npm install -g mintlify mintlify dev
- Make your changes and test locally
- Submit a Pull Request with a clear description
📖 Read our guides before contributing:
- CONTRIBUTING.md - Complete contribution guide
- CLAUDE.md - Detailed writing and style guidelines
- BRANDING.md - Brand colors and design system
- CODE_OF_CONDUCT.md - Community standards
Before submitting your PR:
- Followed style guide in CLAUDE.md
- Added/updated frontmatter (title, description)
- Tested all code examples
- Checked for broken links (
mintlify broken-links) - Previewed changes locally
- Added screenshots for visual changes
- Spell-checked and proofread
Use our templates when reporting issues:
mintlify broken-linksmintlify devNavigate through all pages to verify:
- All links work
- All images load
- All code blocks render correctly
- Navigation is intuitive
This documentation is configured for automatic deployment via Mintlify's GitHub integration.
- Install the Mintlify GitHub app from your dashboard
- Push changes to the
mainbranch - Mintlify automatically builds and deploys
If you prefer manual deployment:
- Connect your repository in the Mintlify dashboard
- Configure your deployment settings
- Push to deploy
- Clear, descriptive page titles
- Concise meta descriptions (50-160 characters)
- Keyword-rich headings
- Semantic HTML structure
- Fast page load times
Configure in docs.json:
- Open Graph tags
- Twitter cards
- Favicon and logo
- Brand colors
Learn how to use eBay MCP Server with popular AI assistants:
| AI Assistant | Guide | Features |
|---|---|---|
| Claude | claude.md | Native MCP support, 200K context, exceptional reasoning |
| Google Gemini | gemini.md | Multi-modal, vision capabilities, cost-effective |
| Cursor IDE | ebaymcp.com/mcp/cursor | AI-first code editor integration |
| Claude Desktop | ebaymcp.com/mcp/claude-desktop | Desktop app with built-in MCP |
- 🌐 Browse Docs: ebaymcp.com
- 🔍 Search: Use the search bar on the docs site
- ❓ FAQ: Support FAQ
- 🛠️ Troubleshooting: Common Issues
- Documentation bugs: Create issue
- Feature requests: Create issue
- Security concerns: Security Policy
- Documentation Questions: GitHub Discussions
- Server Issues: Server Repository
- Broken Link? Run
mintlify broken-links - Dev Server Won't Start? Run
npm install -g mintlify@latest - Page Shows 404? Check
docs.jsonnavigation
- Mintlify Docs: mintlify.com/docs
- MCP Specification: modelcontextprotocol.io
- eBay Developer Portal: developer.ebay.com
This documentation is part of the eBay MCP Server project and is licensed under the Apache License 2.0.
See the LICENSE file for details.
- Mintlify - Modern documentation platform
- MDX - Markdown with React components
- eBay Developer Program - API access and support
Thank you to all our contributors! 🎉
- The eBay Developer Relations team for API support
- The Model Context Protocol community
- All users who reported issues and suggested improvements
If you find this documentation helpful, please consider giving us a star! ⭐
Made with ❤️ for the eBay developer community
📚 View Docs • 🐛 Report Bug • ✨ Request Feature • 🤝 Contribute