JinDaGe - canva-mcp-server MCP Details

article

README

🚀 Canva API MCP 服务器

Canva API MCP 服务器是一个全面的 Model Context Protocol (MCP) 服务器，主要用于与 Canva 的 API 进行交互。它提供了一系列管理设计、品牌、资产和用户的工具与资源，极大地提升了与 Canva API 交互的效率和便捷性。

🚀 快速开始

若你想使用 Canva API MCP 服务器，可按以下步骤操作：

克隆此仓库。
安装依赖项：
```
npm install
```
复制 .env.example 到 .env 并添加您的 Canva API 凭证：
```
CANVA_APP_ID=your_app_id
CANVA_API_KEY=your_api_key
```
启动服务器：
```
npm run dev
```

✨ 主要特性

全面覆盖 Canva API 端点，让你能无死角地与 Canva API 进行交互。
提供所有主要 API 操作的工具，满足多样化的业务需求。
提供文档和技术细节等资源，方便你深入了解和使用。
支持测试使用的模拟数据，为测试和开发工作提供便利。

💻 使用示例

使用 MCP Inspector 进行测试

要使用 MCP Inspector 测试服务器，可执行以下命令：

npm run inspect

这将打开一个网络界面，你可以在其中：

检查和测试所有可用工具。
访问资源。
查看服务器日志。

可用工具

设计管理

get_design - 获取特定设计的信息。
list_designs - 列出设计，可选分页。

品牌管理

get_brand - 获取特定品牌的信息。
list_brands - 列出品牌，可选分页。

资产管理

get_asset - 获取特定资产的信息。
list_assets - 列出资产，可选过滤和分页。
upload_image - 从 URL 上载图像到 Canva。

用户管理

get_user - 获取特定用户的信息。
list_users - 列出用户，可选分页。

📚 详细文档

可用资源

文档

canva://overview - API 的总体概述。
canva://getting-started - 入门指南。
canva://authentication - 身份验证信息。
canva://designs - 设计 API 文档。
canva://brands - 品牌 API 文档。
canva://assets - 资产 API 文档。
canva://users - 用户 API 文档。

实体资源

canva://design/{designId} - 特定设计的信息。
canva://brand/{brandId} - 特定品牌的信息。
canva://asset/{assetId} - 特定资产的信息。

模拟数据

如果没有提供 API 凭证，服务器将使用模拟数据进行所有响应。这对于测试和开发非常有用。

📄 许可证

本项目采用 MIT 许可证。

canva-mcp-server