Wekan API自动化工具

提供自动化生成Wekan API令牌和配置环境的工具,支持AI代理与Wekan交互的多种管理功能。

  • by namar0x0309
  • TypeScript
  • 本地部署
  • 6 星标
  • 更新于
在 GitHub 查看 namar0x0309/wekan-mcp

使用说明

MCP 服务器

由namar0x0309制成❤️ 在GoAIX

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

支持的代理功能

Wekan MCP服务器为AI代理与Wekan交互提供了以下工具:

董事会管理

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

列表管理

  • list列表 -列出特定板内的所有列表

泳道管理

  • list泳道 -在板中列出所有泳道(用于垂直组织卡片)

卡片管理

  • 列表卡片 -列出特定板中的所有卡并列出
  • 创建卡 -创建支持以下功能的新卡:
    • 标题(必填)
    • 说明(可选)
    • 泳道分配(可选)
    • 到期日期(可选,ISO 8601日期时间格式)
    • 团队成员(可选,用户ID数组)
    • 标签(可选,标签ID数组)
  • 移动卡片 -将卡片移动到同一板中的另一个列表或泳道

卡片互动

  • 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 检查员

对于MCP服务器的开发和调试,您可以使用MCP检查器:

npm run inspect

这将启动MCP检查器,配置如下 mcp-inspector-config.json.

对于自动重建的开发:

npm run inspect:watch

这将构建项目并启动检查器,在检测到更改时自动重建。