WebSim MCP Server
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@WebSim MCP Server show me the latest trending projects"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
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
Related MCP server: CubeCobra MCP Server
π 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:
{
"mcpServers": {
"websim": {
"command": "node",
"args": ["/path/to/websim-mcp-server/server.js"],
"env": {}
}
}
}Generic MCP Setup
Use the provided mcp.json configuration file:
# Copy mcp.json to your MCP configuration directory
cp mcp.json ~/.config/claude/mcp-servers/websim.jsonπ 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
// Tool call example
{
"tool": "get_project_by_id",
"arguments": {
"project_id": "abc123xyz789"
}
}Example 2: Browsing Trending Content
// Tool call example
{
"tool": "get_trending_feed",
"arguments": {
"limit": 10,
"offset": 0
}
}Example 3: Searching for Developers
// Tool call example
{
"tool": "search_users",
"arguments": {
"query": "developer",
"limit": 20,
"offset": 0
}
}Example 4: Finding Assets
// Tool call example
{
"tool": "search_assets",
"arguments": {
"query": "game sprites",
"limit": 15
}
}Example 5: Bulk Asset Search
// Tool call example
{
"tool": "bulk_asset_search",
"arguments": {
"assets": [
{ "query": "game UI", "limit": 5 },
{ "query": "character sprites", "limit": 5 },
{ "query": "sound effects", "limit": 5 }
]
}
}π§ Configuration
Environment Variables
Copy .env.example to .env and customize:
# WebSim API Configuration
WEBSIM_API_BASE_URL=https://api.websim.com
WEBSIM_API_TIMEOUT=30000
# Server Configuration
MCP_SERVER_NAME=websim-mcp-server
MCP_SERVER_VERSION=1.0.0
# Logging
LOG_LEVEL=info
LOG_FORMAT=jsonCustom API Base URL
If WebSim provides a different API endpoint, update the configuration:
// In server.js, modify the WEBSIM_API_BASE constant
const WEBSIM_API_BASE = 'https://your-custom-api-endpoint.com';π₯ Health Monitoring
The server includes a built-in health check system:
// Health check tool call
{
"tool": "health_check",
"arguments": {}
}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
{
"success": false,
"error": "Project not found",
"timestamp": "2025-10-28T01:41:35.000Z"
}π 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
# Install dependencies
npm install
# Run in development mode
npm run dev
# Run tests
npm test
# Lint code
npm run lint
# Format code
npm run formatπ 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
Available Tools
25 toolsbulk_asset_searchC
Search for multiple asset queries in bulk
Inputs: assets (required).
get_comment_repliesC
Get replies to a specific comment
Inputs: project_id (required), comment_id (required), limit, offset.
get_posts_feedC
Get latest posts from WebSim feed
Inputs: limit, offset.
get_project_assetsC
Get assets for a specific project version
Inputs: project_id (required), version.
get_project_by_idC
Get a WebSim project by its ID
Inputs: project_id (required).
get_project_by_slugB
Get a WebSim project by user and slug
Inputs: user (required), slug (required).
get_project_commentsC
Get comments for a WebSim project
Inputs: project_id (required), limit, offset.
get_project_descendantsC
Get projects that are descendants of a WebSim project
Inputs: project_id (required), limit, offset.
get_project_revisionsC
Get all revisions of a WebSim project
Inputs: project_id (required), limit, offset.
get_project_statsC
Get statistics for a WebSim project
Inputs: project_id (required).
get_top_searchesC
Get top search queries on WebSim
Inputs: limit, offset.
get_trending_feedB
Get trending WebSim projects feed
Inputs: limit, offset.
get_trending_roomsC
Get trending WebSim rooms
Inputs: limit, offset.
get_userC
Get details for a specific WebSim user
Inputs: user (required).
get_user_followersC
Get followers of a specific WebSim user
Inputs: user (required), limit, offset.
get_user_followingC
Get users that a specific user is following
Inputs: user (required), limit, offset.
get_user_statsC
Get statistics for a specific WebSim user
Inputs: user (required).
health_checkB
Check if the WebSim API is accessible
Inputs: no named parameters.
list_all_projectsB
List all public WebSim projects with pagination
Inputs: limit, offset.
list_user_projectsC
List all projects for a specific user
Inputs: user (required), limit, offset.
search_assetsC
Search for WebSim assets
Inputs: query (required), limit, offset.
search_feedC
Search WebSim feed with sorting options
Inputs: sort (required), search (required), limit, offset.
search_relevant_assetsC
Search for assets relevant to a query
Inputs: query (required), limit.
search_usersC
Search for WebSim users
Inputs: query (required), limit, offset.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelogβ¦
TDQS
Scored across 25 tools
Most tools have distinct purposes targeting different WebSim entities (projects, users, assets, feeds, comments), but there is some overlap in search functionality. For example, search_assets, search_relevant_assets, and bulk_asset_search all involve asset searching, which could cause minor confusion. However, their descriptions help differentiate them by focusing on different aspects (general search, relevance-based, bulk operations).
Tool names follow a highly consistent verb_noun pattern throughout, using snake_case uniformly. All tools start with verbs like 'get', 'list', 'search', or 'health_check', followed by specific nouns (e.g., get_project_by_id, list_user_projects, search_assets). This predictability makes it easy for agents to understand and select tools based on naming conventions.
With 25 tools, the count is on the high side for a single server, bordering on heavy. While WebSim appears to be a platform with multiple entities (projects, users, assets, feeds), the tool set might be slightly overextended, potentially making it cumbersome for agents to navigate. A more focused subset could improve usability without sacrificing functionality.
The tool surface provides comprehensive coverage for querying and retrieving data across WebSim's domain, including projects, users, assets, feeds, comments, and statistics. It supports key operations like search, listing, and getting details. However, there are minor gaps in write operations (e.g., no tools for creating or updating projects, users, or comments), which limits full CRUD lifecycle coverage but still allows for robust read-only workflows.
Maintenance
Related MCP Connectors
Browse and manage Reddit posts, comments, and threads. Fetch user activity, explore hot/new/risingβ¦
Access the GitHub API, enabling file operations, repository management, search functionality, andβ¦
Public social-data API and live docs for AI coding agents.
Create, update, and publish real hosted websites from your agent via the Aveiro API.
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceEnables interaction with the dev.to platform through its public API. Allows users to retrieve articles, user profiles, tags, comments, and perform article searches without requiring authentication.46MIT
- AlicenseNot gradedqualityDmaintenanceEnables interaction with CubeCobra's API to access and manage Magic: The Gathering cube data, including cube lists, records, and draft analytics through both public and authenticated endpoints.ISC
- AlicenseCqualityDmaintenanceEnables AI agents to interact with Webflow APIs for managing sites, pages, components, CMS collections, and custom code.323,649 npmMIT
- FlicenseNot gradedqualityAmaintenanceEnables users to interact with Interactive Brokers through the official Web API, supporting account management, market data, and trading-related endpoints.-