MCP Server

🚀 Plainlyの公式MCPサーバー

Plainly のMCPサーバーをNodeJSで実装したものです。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リファレンス