Yourware MCP

Project Overview

Yourware MCP is a Model Context Protocol (MCP) server that enables AI assistants like Claude to upload your projects directly to yourware.so. This integration allows for seamless deployment of web projects, making it easy to showcase your work online without leaving your development environment.

Whether you're building a simple HTML page, a complex web application, or any other web-based project, Yourware MCP streamlines the process of getting your work online and shareable.

Features & Capabilities

Installation & Setup

Getting started with Yourware MCP is straightforward:

1. Install the package

   pip install yourware-mcp

   Or use uvx directly as shown in the configuration examples below.

2. Configure your AI assistant

   Add the Yourware MCP server to your AI assistant's configuration:

   General Configuration

   {
     "mcpServers": {
       "yourware-mcp": {
         "command": "uvx",
         "args": ["yourware-mcp@latest", "stdio"],
         "env": {}
       }
     }
   }

   Cursor Configuration

   In Cursor settings → features → MCP Servers, add a new MCP Server named yourware-mcp and set the command to uvx yourware-mcp@latest stdio

   
3. Create an API key

   You can either:

   • Let your AI assistant guide you through creating an API key
   • Visit https://www.yourware.so/api/v1/api-keys/quick-create to create one manually
   • Set the YOURWARE_API_KEY environment variable

Usage Examples

Once configured, you can use Yourware MCP through your AI assistant with the following tools:

Check Credentials

// Check if your credentials exist and are valid
await use_mcp_tool({
  server_name: "yourware-mcp",
  tool_name: "check_credentials",
  arguments: {}
});

Create API Key

// Create a new API key
await use_mcp_tool({
  server_name: "yourware-mcp",
  tool_name: "create_api_key",
  arguments: {
    api_key: "your-api-key-here" // Optional, if not provided, will guide you to create one
  }
});

Upload Project

// Upload a file or directory to yourware
await use_mcp_tool({
  server_name: "yourware-mcp",
  tool_name: "upload_project",
  arguments: {
    file_path: "path/to/your/project" // Can be a directory or single file
  }
});

Example Workflow

A typical workflow might look like this:

1. Build your web project
2. Check if your credentials are valid
3. If not, create a new API key
4. Upload your project to Yourware
5. Get the project URL and share it with others

Resources & Links