Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@plainly-videos/mcp-server) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Plainly's Official MCP Server

Implementation of MCP server for Plainly in NodeJS. Enables LLM clients to connect and interact with Plainly APIs.

🎥 Demo

📋 Prerequisites

Node.js ≥ 18 (required)
NPM
Plainly Account

▶️ How to Run

Install via npm

Get your Plainly API key

Go to Settings page
Create a new API key
Copy the new API key

Add config to your editor

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

🔑 Replace 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 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:

Clone, install, and build:

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

yarn install
yarn build

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

Start MCP server from .vscode/mcp.json

@plainly-videos/mcp-server