MCP Server

🚀 Plainly's Official MCP Server

This is an implementation of the MCP server for Plainly in NodeJS, which allows LLM clients to connect and interact with Plainly APIs.

🚀 Quick Start

🎥 Demo

📋 Prerequisites

• Node.js ≥ 18 (required)
• NPM
• Plainly Account

▶️ How to Run

Install via npm

1. Get your Plainly API key
   • Go to Settings page.
   • Create a new API key.
   • Copy the new API key.
2. Add config to your editor

   {
     "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, select your LLM client, and copy the generated command.

For example, with Claude as the client:

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.

✨ Features

🛠️ 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.

🔧 Technical Details

🚧 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:

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

{
  "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

📚 Documentation

📄 Plainly Developer Resources

• Help center
• API reference