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參考