README
🚀 MCP 服务端 - Trello
这是一个基于 Model Context Protocol (MCP) 的服务器,它提供了与 Trello 看板交互的工具。该服务器可无缝集成到 Trello 的 API 中,还能自动处理速率限制、类型安全和错误处理等问题,为用户带来更便捷的使用体验。
🚀 快速开始
本 MCP 服务端可帮助你轻松实现与 Trello 看板的交互,你只需按照后续的安装、配置步骤操作,就能快速使用各项功能。
✨ 主要特性
- 完整的 Trello 看板集成:可与卡片、列表和看板活动进行交互。
- 内置速率限制:严格遵守 Trello 的 API 限制(每个 API 密钥每 10 秒 300 次请求,每个令牌每 10 秒 100 次请求)。
- 类型安全实现:使用 TypeScript 编写,并带有全面的类型定义。
- 输入验证:对所有 API 输入进行 robust 验证。
- 错误处理:具备优雅的错误处理机制,能提供详细的错误信息。
📦 安装指南
使用以下命令进行安装:
npm install @modelcontextprotocol/mcp-server-trello
📚 详细文档
配置
将服务器添加到您的 MCP 设置文件中,示例如下:
{
"mcpServers": {
"trello": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-trello"],
"env": {
"TRELLO_API_KEY": "your-api-key", // 您的 Trello API 密钥(从 https://trello.com/app-key 获取)
"TRELLO_TOKEN": "your-token", // 您的 Trello 令牌
"TRELLO_BOARD_ID": "your-board-id" // 您的 Trello 看板 ID
}
}
}
}
必要的环境变量
TRELLO_API_KEY:您的 Trello API 密钥,可从 Trello 开发者网站 获取。TRELLO_TOKEN:用于身份验证的令牌,通过 OAuth 流程获取。TRELLO_BOARD_ID:您要操作的 Trello 看板的唯一标识符。
可用工具
以下是服务器提供的主要功能及使用示例:
1. 创建看板
创建一个新的 Trello 看板。
mcp trello create-board --name "我的新看板"
--name:指定看板的名称。
2. 删除看板
删除指定的 Trello 看板。
mcp trello delete-board --board-id "5a8b4e7a9d0ef356cccf17b"
--board-id:要删除的看板的唯一标识符。
3. 创建列表
在指定的看板上创建一个新列表。
mcp trello create-list --board-id "5a8b4e7a9d0ef356cccf17b" --name "待办事项"
--board-id:目标看板的唯一标识符。--name:指定列表的名称。
4. 删除列表
删除指定看板上的一个列表。
mcp trello delete-list --list-id "5a8b4e7a9d0ef356cccf17c"
--list-id:要删除的列表的唯一标识符。
5. 创建卡片
在指定的列表下创建一张新卡片。
mcp trello create-card --list-id "5a8b4e7a9d0ef356cccf17c" --name "完成项目"
--list-id:目标列表的唯一标识符。--name:指定卡片的名称。
6. 删除卡片
删除指定列表下的一张卡片。
mcp trello delete-card --card-id "5a8b4e7a9d0ef356cccf17d"
--card-id:要删除的卡片的唯一标识符。
速率限制
本服务器实现了 Trello 的 API 速率限制策略:
- 每个 API 密钥每 10 秒允许最多 300 次请求。
- 每个令牌每 10 秒允许最多 100 次请求。 超出限制的请求将被自动排队处理,确保您不会因速率限制而受到影响。
错误处理
服务器提供以下错误处理机制:
- 输入验证错误:当输入参数不符合要求时,返回详细的验证错误信息。
- API 错误:当调用 Trello API 失败时,捕获并重抛带有原始错误信息的异常。
- 网络错误:当发生网络问题时,记录错误日志并在下次尝试重新连接。
开发
先决条件
- Node.js 和 npm 已安装到您的系统中。
- 熟悉 TypeScript 和命令行工具开发。
设置步骤
- 克隆仓库:
git clone https://github.com/modelcontextprotocol/server-trello.git
cd server-trello
- 安装依赖项:
npm install
- 构建项目:
npm run build
运行测试
npm test
贡献指南
欢迎贡献!请阅读我们的 贡献指南 以了解代码规范和提交 Pull Request 的流程。
📄 许可证
本项目使用 MIT 许可证,具体信息见 LICENSE 文件。
致谢
- 使用 模型上下文协议 SDK 构建
- 采用 Trello REST API
Scan to join WeChat group