Wekan Mcp

Wekan MCP 服务

由 namar0x0309 在 GoAIX 用 ❤️ 制作

本项目包含可自动生成 Wekan API 令牌并配置环境的脚本。

支持的 Agent 功能

Wekan MCP 服务提供以下工具，供 AI Agent 与 Wekan 交互：

看板管理

• listBoards - 列出已通过身份验证的用户可访问的所有 Wekan 看板

列表管理

• listLists - 列出指定看板中的所有列表

泳道管理

• listSwimlanes - 列出看板中的所有泳道（用于垂直组织卡片）

卡片管理

• listCards - 列出指定看板和列表中的所有卡片
• createCard - 创建新卡片，支持以下内容：
  • 标题（必填）
  • 描述（可选）
  • 泳道分配（可选）
  • 到期日期（可选，ISO 8601 日期时间格式）
  • 团队成员（可选，用户 ID 数组）
  • 标签（可选，标签 ID 数组）
• moveCard - 将卡片移动到同一看板中的其他列表或泳道

卡片互动

• commentCard - 为现有卡片添加评论

入门指南

生成 Wekan API 令牌

根据你的平台运行相应脚本以生成 API 令牌：

Windows（PowerShell）：

./get-wekan-token.ps1

Linux/macOS（Bash）：

./get-wekan-token.sh

脚本会提示你输入：

• Wekan 端点（例如，https://wekan.namar0x0309.com）
• 用户名
• 密码

身份验证成功后，脚本将：

1. 生成 API 令牌
2. 使用你的令牌和配置创建或更新 .env 文件

手动配置

如果你希望手动配置，请将 .env.example 复制到 .env，并填写相关信息：

cp .env.example .env

然后编辑 .env 文件，填写你的 Wekan 实例信息和 API 令牌。

环境变量

.env 文件包含：

• WEKAN_BASE_URL：你的 Wekan 实例 URL
• WEKAN_API_TOKEN：用于身份验证的已生成 API 令牌
• WEKAN_USERNAME：你的 Wekan 用户名（API 令牌的替代方式）
• WEKAN_PASSWORD：你的 Wekan 密码（API 令牌的替代方式）
• WEKAN_USER_ID：你的 Wekan 用户 ID
• WEKAN_TOKEN_EXPIRES：令牌过期日期

**注意：**你可以通过以下任一方式进行身份验证：

1. WEKAN_API_TOKEN - 预先生成的令牌，或
2. WEKAN_USERNAME 和 WEKAN_PASSWORD - 每次请求时自动生成令牌

测试

你可以运行以下命令来测试配置：

node test-auth.js

这将验证你的 API 令牌是否正常工作。

你也可以测试所有可用方法：

node test-all-methods.js

开发

MCP Inspector

在开发和调试 MCP 服务时，你可以使用 MCP Inspector：

npm run inspect

这将使用 mcp-inspector-config.json 中的配置启动 MCP Inspector。

如需在开发时自动重新构建：

npm run inspect:watch

这将构建项目并启动 Inspector；检测到更改时会自动重新构建。