# MCP Server

> Use Orshot with Claude, Cursor, VS Code, Windsurf, ChatGPT, Codex, and other MCP-compatible applications

- **URL**: https://orshot.com/docs/integrations/mcp-server

---

**MCP Server URL:** `https://mcp.orshot.com/mcp`

<div className="flex flex-wrap gap-3 mt-4 mb-2 not-prose">
  
  
</div>

## Introduction

The Orshot MCP Server lets you generate dynamic images, manage templates, and control your Orshot workspace using natural language — directly inside AI tools like Cursor, VS Code (GitHub Copilot), Claude Desktop, Claude Code, Windsurf, ChatGPT, Codex, Cline, LM Studio, Zed, Goose, Antigravity, and any other MCP-compatible client.

No API keys needed. Authentication is handled automatically via OAuth — just connect and approve access through your browser.

## Connect + Generate Templates

<div className="mb-4">
  <iframe
    width="100%"
    height="420"
    src="https://www.youtube.com/embed/GE3UHU_Q2pQ"
    title="Orshot MCP Server Tutorial"
    frameBorder="0"
    allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
    allowFullScreen
    className="rounded-lg"
  ></iframe>
</div>

## Setup

Connect to the hosted Orshot MCP server. Authentication happens automatically via OAuth when you first use a tool.

### Cursor

1. Open **Settings → General → MCP Servers**
2. Click **+ Add new MCP server**
3. Select **Type: URL**
4. Enter URL: `https://mcp.orshot.com/mcp`
5. Click **Add**
6. When prompted, complete OAuth authorization in your browser

Or add manually to `~/.cursor/mcp.json`:```json
{
  "mcpServers": {
    "orshot": {
      "url": "https://mcp.orshot.com/mcp"
    }
  }
}
```### VS Code (GitHub Copilot)

Add to your `.vscode/mcp.json` (workspace) or global settings:```json
{
  "servers": {
    "orshot": {
      "url": "https://mcp.orshot.com/mcp"
    }
  }
}
```Or use the Command Palette:

1. Press `Cmd+Shift+P` (macOS) / `Ctrl+Shift+P` (Windows/Linux)
2. Run **MCP: Add Server**
3. Select **HTTP**
4. Enter URL: `https://mcp.orshot.com/mcp`
5. Name it `Orshot`

### Claude Desktop

Add to your Claude Desktop MCP configuration file:

**macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`  
**Windows:** `%APPDATA%\Claude\claude_desktop_config.json````json
{
  "mcpServers": {
    "orshot": {
      "url": "https://mcp.orshot.com/mcp"
    }
  }
}
```Restart Claude Desktop after saving.

### Claude.ai (Web)

1. Go to [claude.ai](https://claude.ai) → **Settings** → **Integrations**
2. Click **Add Integration**
3. Enter URL: `https://mcp.orshot.com/mcp`
4. Complete OAuth authorization when prompted

### Claude Code```bash
claude mcp add orshot --transport http https://mcp.orshot.com/mcp
```### Windsurf

1. Click the **MCP** icon in the Cascade panel (top right)
2. Click **Manage plugins** → **View raw config**
3. Add the Orshot configuration and save

Config file location: `~/.codeium/windsurf/mcp_config.json````json
{
  "mcpServers": {
    "orshot": {
      "serverUrl": "https://mcp.orshot.com/mcp"
    }
  }
}
```### ChatGPT

1. Go to [chatgpt.com](https://chatgpt.com) → **Settings** → **Connections**
2. Click **Add Connection**
3. Enter URL: `https://mcp.orshot.com/mcp`
4. Complete OAuth authorization when prompted

### Codex (OpenAI CLI)

Add to `~/.codex/config.json`:```json
{
  "mcpServers": {
    "orshot": {
      "url": "https://mcp.orshot.com/mcp"
    }
  }
}
```Or add via CLI:```bash
codex mcp add orshot --url https://mcp.orshot.com/mcp
```### Cline

1. Open Cline settings in VS Code
2. Go to **MCP Servers** section
3. Click **Add Server**
4. Enter:
   - **Name:** `orshot`
   - **URL:** `https://mcp.orshot.com/mcp`
5. Click **Save**

### LM Studio

1. Open **Settings → MCP**
2. Add a new MCP server with this configuration:```json
{
  "orshot": {
    "url": "https://mcp.orshot.com/mcp"
  }
}
```### Zed

Add to your Zed settings (`~/.config/zed/settings.json`):```json
{
  "context_servers": {
    "orshot": {
      "url": "https://mcp.orshot.com/mcp"
    }
  }
}
```### Goose```bash
goose mcp add orshot --transport http https://mcp.orshot.com/mcp
```Or add to `~/.config/goose/config.yaml`:```yaml
extensions:
  orshot:
    type: http
    url: https://mcp.orshot.com/mcp
```### Antigravity

1. Open [Antigravity](https://antigravity.dev) and go to **Settings** → **MCP Servers**
2. Add a new server with URL: `https://mcp.orshot.com/mcp`
3. Complete OAuth authorization when prompted

### Other MCP Clients

Any client that supports remote MCP servers can connect using:

**URL:** `https://mcp.orshot.com/mcp`

Look for "Remote MCP", "HTTP", or "Streamable HTTP" in your client's MCP settings and enter the URL above.

---

## Authentication

The MCP server uses **OAuth** to securely connect to your Orshot account. No API keys to copy or manage.

### How It Works

1. **Connect** — Add the MCP server URL to your client
2. **Authorize** — When you first use an Orshot tool, your browser opens to the Orshot login page
3. **Select workspaces** — Choose which workspace(s) the MCP server can access
4. **Done** — Your client receives an OAuth token and all subsequent tool calls are authenticated

### Token Details

- Access tokens are short-lived (15 minutes) and automatically refreshed
- If your session expires, you'll be prompted to re-authorize
- You can revoke access anytime from your Orshot dashboard
- Each user's data is completely isolated — the server never stores tokens

---

## Available Tools

The MCP server provides **32 tools** across six categories:

### Workspace & Auth

| Tool                          | Description                                                |
| ----------------------------- | ---------------------------------------------------------- |
| `orshot_auth_status`          | Check if you're authenticated and see available workspaces |
| `orshot_list_workspaces`      | List all workspaces you have access to                     |
| `orshot_set_active_workspace` | Switch which workspace to use                              |

### Template Management

| Tool                                       | Description                                                                   |
| ------------------------------------------ | ----------------------------------------------------------------------------- |
| `orshot_list_studio_templates`             | List all studio templates in the active workspace                             |
| `orshot_get_studio_template`               | Get full template details including design structure                          |
| `orshot_get_studio_template_modifications` | Get available modification parameters for a template (dynamic fields listing) |
| `orshot_create_template_design`            | Create a new template with design elements                                    |
| `orshot_update_template_design`            | Update an existing template's design, name, or dimensions                     |
| `orshot_delete_template`                   | Delete a studio template                                                      |
| `orshot_duplicate_template`                | Create a copy of an existing template                                         |

### Image Generation

| Tool                                 | Description                                                                      |
| ------------------------------------ | -------------------------------------------------------------------------------- |
| `orshot_generate_image`              | Generate an image, PDF, or video from a studio template with modifications       |
| `orshot_generate_image_from_library` | Generate images from library templates (website screenshots, tweet images, etc.) |

### Library Templates

| Tool                                        | Description                                           |
| ------------------------------------------- | ----------------------------------------------------- |
| `orshot_list_library_templates`             | List all available pre-built Orshot library templates |
| `orshot_get_library_template_modifications` | Get available parameters for a library template       |

### Brand Assets

Manage your workspace brand kit — images, colors, fonts, and videos used across templates.

| Tool                             | Description                                                                                |
| -------------------------------- | ------------------------------------------------------------------------------------------ |
| `orshot_get_brand_kit`           | Fetch all brand assets at once (images, colors, fonts, videos) with optional tag filtering |
| **Images**                       |                                                                                            |
| `orshot_get_brand_images`        | List brand images, optionally filtered by tag                                              |
| `orshot_upload_brand_image`      | Upload a new brand image from a URL                                                        |
| `orshot_update_brand_image_tags` | Update tags on a brand image                                                               |
| `orshot_delete_brand_image`      | Delete a brand image                                                                       |
| **Colors**                       |                                                                                            |
| `orshot_get_brand_colors`        | List brand colors, optionally filtered by tag                                              |
| `orshot_add_brand_color`         | Add a new brand color (hex value + tags)                                                   |
| `orshot_update_brand_color_tags` | Update tags on a brand color                                                               |
| `orshot_delete_brand_color`      | Delete a brand color                                                                       |
| **Fonts**                        |                                                                                            |
| `orshot_get_brand_fonts`         | List brand fonts, optionally filtered by tag                                               |
| `orshot_upload_brand_font`       | Upload a new brand font from a URL                                                         |
| `orshot_update_brand_font_tags`  | Update tags on a brand font                                                                |
| `orshot_delete_brand_font`       | Delete a brand font                                                                        |
| **Videos**                       |                                                                                            |
| `orshot_get_brand_videos`        | List brand videos, optionally filtered by tag                                              |
| `orshot_upload_brand_video`      | Upload a new brand video from a URL                                                        |
| `orshot_update_brand_video_tags` | Update tags on a brand video                                                               |
| `orshot_delete_brand_video`      | Delete a brand video                                                                       |

### Social Publishing

| Tool                          | Description                                                  |
| ----------------------------- | ------------------------------------------------------------ |
| `orshot_list_social_accounts` | List connected social media accounts in the active workspace |

Use `orshot_list_social_accounts` to get the numeric account IDs, then pass them in the `publish` parameter of `orshot_generate_image` to post renders directly to connected social accounts.

---

## Example Prompts

Once connected, try natural language prompts like:

**Image Generation:**

- "Generate a website screenshot of github.com using Orshot"
- "Create an ad banner with heading 'Grow your business' using studio template 64"
- "Generate a tweet screenshot of this tweet https://x.com/example/status/123"
- "Render my certificate template with the name 'Jane Doe'"
- "Generate a PNG and a PDF of template 100 with my updated headline"

**Template Management:**

- "List all my studio templates"
- "Show me the details of template 222"
- "What modification parameters does template 150 accept?"
- "Create a new social media template at 1080x1080 with my brand colors"
- "Update template 100 with a new background color"
- "Duplicate template 200 so I can create a variant"
- "Delete template 300"

**Brand Assets:**

- "Show me all my brand assets"
- "What brand colors do I have tagged as 'primary'?"
- "Upload this logo image to my brand kit with tags 'logo' and 'dark'"
- "Add a new brand color #FF5733 tagged as 'accent'"
- "Create a social media post template using my brand fonts and colors"
- "Design a YouTube thumbnail using my brand images tagged 'product'"

**Workspace:**

- "Which workspaces do I have access to?"
- "Switch to my marketing workspace"

---

## Need Help?

- Check the [Orshot API documentation](https://orshot.com/docs/api-reference)
- Contact support at hi@orshot.com
- Use the chat button in your [Orshot dashboard](https://orshot.com/workspace)