# Plainly's Official MCP Server

[![smithery badge](https://smithery.ai/badge/@plainly-videos/mcp-server)](https://smithery.ai/server/@plainly-videos/mcp-server)

Implementation of MCP server for [Plainly](https://www.plainlyvideos.com/) in NodeJS. Enables LLM clients to connect and interact with Plainly APIs.

## 🎥 Demo

<p align="center">
  <a href="https://plainlyvideos.wistia.com/medias/j099l7maqm" title="Watch demo video" target="_blank" rel="noopener noreferrer">
    <img src="https://embed-ssl.wistia.com/deliveries/fc2521adb70dc7d665cac3976386aebee68f21ba.jpg?image_crop_resized=1000x698&image_play_button_rounded=true&image_play_button_size=2x&image_play_button_color=174bd2e0" alt="Plainly Videos - MCP showcase single product" width="500" height="349">
  </a>
</p>

## 📋 Prerequisites

- [Node.js](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) **≥ 18** (required)
- [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- [Plainly Account](https://app.plainlyvideos.com)

## ▶️ How to Run

### Install via npm

1. **Get your Plainly API key**

- Go to [Settings page](https://app.plainlyvideos.com/dashboard/user/settings/general)
- Create a new API key
- Copy the new API key

2. **Add config to your editor**

   ```json
   {
     "servers": {
       "plainly": {
         "command": "npx",
         "args": ["-y", "@plainly-videos/mcp-server@latest"],
         "env": {
           "PLAINLY_API_KEY": "<PLAINLY_API_KEY>"
         }
       }
     }
   }
   ```

   > 🔑 Replace <PLAINLY_API_KEY> with your actual API key.

### Install via Smithery

Go to [Smithery Plainly MCP page](https://smithery.ai/server/@plainly-videos/mcp-server), select your LLM client, and copy the generated command.

For example, with Claude as the client:

```bash
npx -y @smithery/cli@latest install @plainly-videos/mcp-server --client claude --key <YOUR_SMITHERY_KEY>
```

> 🔑 Replace <YOUR_SMITHERY_KEY> with your Smithery API key.

## 🛠️ Available Tools

- `list_renderable_items` - returns a list of all criteria matching designs and custom projects for authenticated user
- `get_renderable_items_details` - returns details of a single design or custom project, such as: required and optional parameters, preview links, aspect ratios, etc.
- `render_item` - submits a render with all needed parameters
- `check_render_status` - checks the render status and report error or preview links

## 🗣️ Prompts & Resources

This implementation **does not** include `prompts` or `resources` from the MCP specification. However, this may change in the future when there is broader support across popular MCP clients.

## 🚧 Development Mode

If you want to run the server in development mode, you can install dependencies and run the server using the following command:

1. Clone, install, and build:

```shell
git clone git@github.com:plainly-videos/mcp-server.git
cd mcp-server

yarn install
yarn build
```

2. Add your API key in `.vscode/mcp.json`

```json
{
  "servers": {
    "plainly": {
      "command": "node",
      "args": ["<FULL PATH TO dist/cli.js>"],
      "env": {
        "PLAINLY_API_KEY": "<PLAINLY_API_KEY>"
      }
    }
  }
}
```

3. Start MCP server from `.vscode/mcp.json`

## 📄 Plainly Developer Resources

- [Help center](https://help.plainlyvideos.com/)
- [API reference](https://app.plainlyvideos.com/api-reference.html)