MCP Server

🚀 Plainly的官方MCP服务器

这是使用NodeJS为Plainly实现的MCP服务器。它能让LLM客户端连接并与Plainly的API进行交互。

🚀 快速开始

🎥 演示

📋 前提条件

• Node.js ≥ 18 (必需)
• NPM
• Plainly账户

▶️ 运行方法

📦 通过npm安装

1. 获取你的Plainly API密钥
   • 访问设置页面
   • 创建一个新的API密钥
   • 复制新的API密钥
2. 在编辑器中添加配置

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

🔑 请将 <PLAINLY_API_KEY> 替换为你实际的API密钥。

📦 通过Smithery安装

访问Smithery Plainly MCP页面，选择你的LLM客户端，然后复制生成的命令。

例如，使用Claude作为客户端：

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

🔑 请将 <YOUR_SMITHERY_KEY> 替换为你的Smithery API密钥。

✨ 主要特性

🛠️ 可用工具

• list_renderable_items - 返回经过身份验证的用户所有符合标准的设计和自定义项目的列表
• get_renderable_items_details - 返回单个设计或自定义项目的详细信息，如：必需和可选参数、预览链接、纵横比等
• render_item - 使用所有必要参数提交渲染任务
• check_render_status - 检查渲染状态并报告错误或预览链接

🗣️ 提示与资源

此实现不包含MCP规范中的 prompts 或 resources。不过，当流行的MCP客户端有更广泛的支持时，这一点可能会改变。

🚧 开发模式

如果你想以开发模式运行服务器，可以使用以下命令安装依赖并启动服务器：

1. 克隆、安装并构建：

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

yarn install
yarn build

2. 在 .vscode/mcp.json 中添加你的API密钥

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

3. 从 .vscode/mcp.json 启动MCP服务器

📚 详细文档

📄 Plainly开发者资源

• 帮助中心
• API参考