Placid MCP Server 使用说明

项目简介

Placid MCP Server 是一个基于 Model Context Protocol (MCP) 构建的应用后端，它作为 LLM 客户端和 Placid.app 之间的桥梁。Placid.app 是一个用于自动化品牌内容创作的平台，提供丰富的模板资源和 API 接口。本 MCP 服务器通过集成 Placid.app 的 API，为 LLM 客户端提供了一系列工具，使其能够利用 Placid.app 的模板快速生成定制化的图片和视频内容。

主要功能点

模板列表检索: 允许 LLM 客户端检索 Placid.app 上可用的设计模板，并支持按集合、标签等条件进行过滤。
图片生成: 支持 LLM 客户端使用 Placid.app 的模板，并结合动态内容（如文本、图片）生成静态图片。
视频生成: 支持 LLM 客户端使用 Placid.app 的模板，并结合动态内容（如文本、图片、视频、音频）生成动态视频。
API Token 安全管理: 服务器端负责 Placid.app API Token 的管理，确保 API 调用的安全性。

安装步骤

本 MCP 服务器基于 Node.js 运行，请确保已安装 Node.js (版本 18 或更高) 和 npm。

安装方式一：NPX 快速安装 (推荐)

这是最快速的安装方式，无需下载仓库代码，只需将以下配置添加到您的 MCP 客户端（如 Claude Desktop 或 Cline）的服务器配置中即可：

{
  "mcpServers": {
    "placid": {
      "command": "npx",
      "args": ["@felores/placid-mcp-server"],
      "env": {
        "PLACID_API_TOKEN": "YOUR_PLACID_API_TOKEN"
      }
    }
  }
}

注意: 请将 'YOUR_PLACID_API_TOKEN' 替换为您在 Placid.app 账户设置中创建的 API Token。

安装方式二：手动安装 (适用于需要修改代码或贡献代码的开发者)

克隆仓库:

git clone https://github.com/felores/placid-mcp-server.git
cd placid-mcp-server

安装依赖:
```
npm install
```
构建项目:
```
npm run build
```

配置 MCP 客户端: 将以下配置添加到您的 MCP 客户端的服务器配置中：

{
  "mcpServers": {
    "placid": {
      "command": "node",
      "args": ["/path/to/placid-mcp-server/build/index.js"],
      "env": {
        "PLACID_API_TOKEN": "YOUR_PLACID_API_TOKEN"
      }
    }
  }
}

注意:

请将 '/path/to/placid-mcp-server' 替换为您克隆仓库的绝对路径。
请将 'YOUR_PLACID_API_TOKEN' 替换为您在 Placid.app 账户设置中创建的 API Token。

服务器配置 (MCP 客户端配置)

以下是在 MCP 客户端中配置 Placid MCP Server 的 JSON 格式配置信息。您需要根据您的安装方式选择相应的配置，并替换 'YOUR_PLACID_API_TOKEN' 为您的 Placid API Token。

NPX 安装配置:

{
  "mcpServers": {
    "placid": {
      "command": "npx",  // 启动命令，使用 npx 运行 npm 包
      "args": ["@felores/placid-mcp-server"], // 命令参数，指定要运行的 npm 包名称
      "env": {
        "PLACID_API_TOKEN": "YOUR_PLACID_API_TOKEN" // 环境变量，Placid.app API Token，用于服务器鉴权
      }
    }
  }
}

手动安装配置:

{
  "mcpServers": {
    "placid": {
      "command": "node", // 启动命令，使用 node 运行 JavaScript 文件
      "args": ["/path/to/placid-mcp-server/build/index.js"], // 命令参数，指定服务器入口文件路径，请替换为实际路径
      "env": {
        "PLACID_API_TOKEN": "YOUR_PLACID_API_TOKEN"  // 环境变量，Placid.app API Token，用于服务器鉴权
      }
    }
  }
}

基本使用方法

启动 MCP 客户端: 根据您的 MCP 客户端 (如 Claude Desktop 或 Cline) 的文档启动客户端。客户端会自动连接并加载配置的 Placid MCP Server。
在 LLM 中调用工具: 您可以在 LLM 的 Prompt 中指示其使用 Placid MCP Server 提供的工具。
- 检索模板: 使用 'placid_list_templates' 工具检索 Placid.app 上的模板。您可以选择性地添加参数，如 'collection_id' (集合 ID) 或 'tags' (标签) 进行过滤。
- 生成图片: 使用 'placid_generate_image' 工具，指定 'template_id' (模板 UUID) 和 'layers' (图层内容) 参数来生成图片。'layers' 参数允许您动态修改模板中的文本和图片内容。
- 生成视频: 使用 'placid_generate_video' 工具，指定 'template_id' (模板 UUID) 和 'layers' (图层内容) 参数来生成视频。'layers' 参数允许您动态修改模板中的文本、图片和视频内容。您还可以选择性地添加 'audio' (音频 URL) 等参数来为视频添加背景音乐。

示例：

假设您希望 LLM 生成一张 "欢迎来到我的应用" 的图片，并使用 ID 为 'template-uuid' 的 Placid 模板。您可以指示 LLM 调用 'placid_generate_image' 工具，并提供如下参数：

{
  "tool_calls": [
    {
      "id": "tool_call_id",
      "type": "function",
      "function": {
        "name": "placid_generate_image",
        "arguments": "{\"template_id\": \"template-uuid\", \"layers\": {\"headline\": {\"text\": \"欢迎来到我的应用\"}, \"background\": {\"image\": \"https://example.com/bg.jpg\"}}}"
      }
    }
  ]
}

LLM 将会调用 Placid MCP Server，服务器会调用 Placid.app API 生成图片，并将图片 URL 返回给 LLM 客户端。

获取 Placid API Token

登录 Placid.app 账户。
进入 "Settings" (设置) > "API"。
点击 "Create API Token" (创建 API Token)。
为您的 Token 命名 (例如 "MCP Server")。
复制生成的 Token。
将 Token 填入 MCP 客户端的服务器配置中 ('PLACID_API_TOKEN' 环境变量)。

通过以上步骤，您就可以成功配置并使用 Placid MCP Server，让您的 LLM 客户端具备调用 Placid.app 强大媒体生成能力。

关键词