使用说明
pix3lmcp
MCP服务器 像素3板 --通过以下方式将板、列表和卡管理作为Claude Code和Claude.ai的工具公开 模型上下文协议.
演示
可用工具
| 工具 | 说明 |
|---|---|
list_workspaces |
列出已配置的工作区ID |
list_boards |
列表板(可选按工作区筛选) |
get_board |
通过列表和卡片获取董事会详细信息 |
create_board |
创建新板 |
update_board |
更新板 |
delete_board |
删除板 |
list_lists |
在板中列出所有列表 |
create_list |
创建新列表 |
update_list |
更新列表 |
delete_list |
删除列表 |
list_cards |
列出板中的所有卡片 |
get_card |
获取卡详细信息 |
create_card |
创建新卡(请参见 卡片字段) |
update_card |
更新卡(请参阅 卡片字段) |
move_card |
将卡片移动到其他列表/位置 |
archive_card |
将卡片存档 |
delete_card |
删除卡片 |
卡片字段
create_card 和 update_card 支持以下字段:
| 字段 | 类型 | 描述 |
|---|---|---|
title |
string | 卡片标题 |
description |
string | 卡片描述 |
type |
string | 卡类型(task, bug, feature, meeting, text) |
priority |
string | 优先级 |
severity |
string | 严重性级别 |
effort |
string | 工作量估算 |
tags |
string[] | 标签列表 |
due_date |
string | ISO 8601格式的到期日期 |
responsible |
string | 负责人 |
job_number |
string | 作业编号(例如。 C-20-0001) |
rating |
number | 评分从1到5 |
links |
string[] |
与卡片关联的链接(URL数组) |
checklist |
{ id: string, text: string, checked: boolean }[] |
检查表项目 |
prompt |
string | 与卡片关联的AI提示 |
ai_tool |
string | 使用的AI工具 |
先决条件
- 跑步 像素3板 例子
- 从Pix3lboard生成的API键(用户菜单→ API密钥)
选项1:Vercel(推荐)
在Vercel上部署自己的实例。
部署
环境变量
在Vercel仪表板中设置这些(设置→ 环境变量):
| 变量 | 必填 | 描述 |
|---|---|---|
PIX3LBOARD_URL |
✅ | Pix3lboard实例的基本URL(例如。 https://board.pix3ltools.com) |
PIX3LBOARD_API_KEY |
✅ | 从Pix3lboard生成的API密钥 |
WORKSPACE_IDS |
✅ | 逗号分隔的工作区ID(在Pix3lboard URL中可见: /workspace/<id>) |
在克劳德代码中注册
claude mcp add --transport http --scope user pix3lboard -- https://<your-deployment>.vercel.app/api/mcp
在Claude.ai中注册
首选 设置→ 集成→ 添加MCP服务器 并输入:
https://<your-deployment>.vercel.app/api/mcp
选项2:Docker
用于自托管Pix3lboard部署。
环境变量
创建一个 .env 文件:
PIX3LBOARD_URL=http://pix3lboard:3000
PIX3LBOARD_API_KEY=pk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
WORKSPACE_IDS=ws_abc123,ws_def456
PORT=3010
注: 还支持电子邮件+密码身份验证作为回退(设置
PIX3LBOARD_EMAIL和PIX3LBOARD_PASSWORD而不是PIX3LBOARD_API_KEY),但强烈建议使用API密钥,特别是如果Pix3lboard部署在无法进行JWT缓存的Vercel上。
使用Docker运行
docker build -t pix3lmcp .
docker run --env-file .env -p 3010:3010 pix3lmcp
添加到docker编写
pix3lmcp:
image: pix3lmcp
ports:
- "3010:3010"
depends_on:
- pix3lboard
env_file:
- .env
在克劳德代码中注册
claude mcp add --transport http --scope user pix3lboard -- https://<your-domain>/mcp
发展
npm install
# Vercel variant
npm run dev:vercel # next dev
# Docker variant
npm run dev:docker # tsx watch server.ts
构建
npm run build:vercel # next build
npm run build:docker # esbuild → dist/server.js
建筑
src/
├── auth.ts # API Key or Email+Password authentication
├── api.ts # HTTP client for Pix3lboard REST API v1
└── tools/
├── boards.ts # Board tools
├── lists.ts # List tools
├── cards.ts # Card tools
└── index.ts # Tool registration + list_workspaces
app/api/mcp/ # Vercel: Next.js API route (Streamable HTTP)
server.ts # Docker: Express entry point
运输: 流式HTTP (无状态,每个请求一个McpServer实例)。
