WebSim MCP Server
A comprehensive Model Context Protocol (MCP) server for interacting with WebSim's public API. This server provides access to WebSim's ecosystem of projects, users, feeds, assets, and comments through standardized MCP tools.
🌟 Features
Project Management
Get projects by ID or slug - Retrieve specific WebSim projects
List all public projects - Browse the complete public project catalog
List user projects - Access projects created by specific users
Project revisions - View historical versions of projects
Project statistics - Get detailed analytics for projects
Project descendants - Find projects that are based on or derived from others
User Management
User profiles - Retrieve comprehensive user information
User statistics - Get user activity and engagement metrics
User search - Find users by username or other criteria
Social connections - Access user's following and follower lists
Feed & Discovery
Trending feed - Discover popular and trending content
Latest posts - Get the most recent activity
Feed search - Search content with sorting options (trending, newest, popular)
Trending rooms - Find popular interactive rooms and experiences
Assets & Search
Asset search - Find specific assets and resources
Bulk asset search - Search multiple queries simultaneously
Relevant asset discovery - Find assets related to your interests
Related keywords - Get keyword suggestions for searches
Top searches - See what others are searching for
Project assets - Access assets within specific projects
Comments & Interaction
Project comments - Read community discussions on projects
Comment replies - View threaded conversations and replies
System Features
Health monitoring - Built-in health checks for API connectivity
Error handling - Comprehensive error recovery and reporting
Pagination support - Efficient data retrieval with limit/offset
Input validation - Robust parameter validation using Zod schemas
🚀 Quick Start
Prerequisites
Node.js 18.0.0 or higher
npm or yarn package manager
Installation
Clone or download the server:
# If using from source git clone https://github.com/minimax/websim-mcp-server.git cd websim-mcp-serverInstall dependencies:
npm installRun the server:
npm start
Usage with MCP Clients
Smithery Platform
The server is configured for direct deployment on Smithery. See the smithery.json file for deployment configuration.
Claude Desktop
Add to your Claude Desktop MCP configuration:
Generic MCP Setup
Use the provided mcp.json configuration file:
📋 Available Tools
Project Management
Tool | Description | Parameters |
| Get project by ID |
|
| Get project by user/slug |
|
| List all public projects |
|
| List projects for user |
|
| Get project versions |
|
| Get project statistics |
|
| Get related projects |
|
User Management
Tool | Description | Parameters |
| Get user profile |
|
| Get user statistics |
|
| Search users |
|
| Get user's follows |
|
| Get user's followers |
|
Feed & Discovery
Tool | Description | Parameters |
| Get trending projects |
|
| Get latest posts |
|
| Search feed with sorting |
|
| Get trending rooms |
|
Assets & Search
Tool | Description | Parameters |
| Search for assets |
|
| Search multiple queries |
|
| Find relevant assets |
|
| Get keyword suggestions |
|
| Get top searches |
|
| Get project assets |
|
Comments
Tool | Description | Parameters |
| Get project comments |
|
| Get comment replies |
|
System
Tool | Description | Parameters |
| Check API connectivity | None |
💡 Usage Examples
Example 1: Getting a Popular Project
Example 2: Browsing Trending Content
Example 3: Searching for Developers
Example 4: Finding Assets
Example 5: Bulk Asset Search
🔧 Configuration
Environment Variables
Copy .env.example to .env and customize:
Custom API Base URL
If WebSim provides a different API endpoint, update the configuration:
🏥 Health Monitoring
The server includes a built-in health check system:
This checks:
WebSim API connectivity
Response time
Error rate monitoring
🔒 Security & Privacy
No Authentication Required: Uses WebSim's public API endpoints
No Data Storage: Server doesn't store any user data
HTTPS Only: All API calls use secure connections
Input Validation: All parameters are validated before API calls
🐛 Error Handling
The server provides comprehensive error handling:
Network timeouts: Configurable request timeouts
API errors: Forwarded error messages with context
Validation errors: Clear parameter validation feedback
Recovery mechanisms: Automatic retry logic where appropriate
Common Error Responses
📊 Rate Limiting & Performance
Built-in timeouts: Prevents hanging requests
Pagination support: Efficient data retrieval
Error recovery: Graceful handling of API limits
Connection pooling: Optimized API call handling
🤝 Contributing
Fork the repository
Create a feature branch
Make your changes
Test thoroughly
Submit a pull request
Development
📝 API Reference
This MCP server wraps the WebSim public API. For detailed API documentation, visit:
API Base: https://api.websim.com
Documentation: https://api.websim.com/docs
Supported Endpoints
GET /api/v1/projects- Project listingGET /api/v1/projects/{id}- Project detailsGET /api/v1/users/{user}- User profilesGET /api/v1/feed/trending- Trending contentGET /api/v1/search/assets- Asset searchAnd many more...
📄 License
MIT License - see LICENSE file for details.
🙏 Acknowledgments
Model Context Protocol for the MCP standard
WebSim for the public API
Smithery for MCP hosting platform
📞 Support
For issues, questions, or contributions:
GitHub Issues: Create an issue
Documentation: WebSim API Docs
Built with ❤️ by MiniMax Agent
This server cannot be installed