Connect Wekan to external systems via REST API
Wekan MCP Server connects AI assistants to a self-hosted Wekan kanban board via an authenticated API token.
Why it matters
Integrate your Wekan project management system with external applications. This asset provides a REST API to programmatically manage tasks and boards, enabling automated workflows and data synchronization.
Outcomes
What it gets done
Add, edit, and delete Wekan tasks and boards via REST API
Automate Wekan API token generation and management
Configure Wekan integration using environment variables
Test authentication for Wekan API access
Install
Add it to your toolbox
Run in your project directory:
curl -fsSL https://spark.entire.vc/get/vb-wekan | bash Capabilities
Tools your agent gets
Add a new task to a Wekan board via REST API
Edit an existing task in a Wekan board via REST API
Delete a task from a Wekan board via REST API
Add a new board in Wekan via REST API
Edit an existing board in Wekan via REST API
Delete a board from Wekan via REST API
Overview
Wekan MCP Server
Wekan MCP Server handles authenticating an AI assistant against a self-hosted Wekan kanban instance, automating API token generation and environment configuration, with a test script and MCP Inspector support for development. Use it when you self-host Wekan and need to set up and verify authenticated MCP access to your instance before an assistant can work with it.
What it does
Wekan MCP Server is an MCP integration for Wekan, the open-source kanban board tool, that authenticates an AI assistant against your Wekan instance using a generated API token. It ships with platform-specific scripts to automate the login and token-generation flow, so you don't have to manually create credentials before the assistant can reach your Wekan API.
When to use - and when NOT to
Use this when you self-host Wekan and want an AI assistant to authenticate against your instance for board-related work through the MCP protocol. It is oriented around getting the connection authenticated and configured correctly, including a test script to verify the token works. It is not useful without an existing Wekan instance and account to authenticate against, and the setup scripts are platform-specific (PowerShell for Windows, Bash for Linux/macOS).
Capabilities
- Automated Wekan API token generation via
get-wekan-token.ps1(Windows) orget-wekan-token.sh(Linux/macOS), prompting for your Wekan endpoint, username, and password. - Automatic creation/update of a
.envfile containingWEKAN_BASE_URL,WEKAN_API_TOKEN,WEKAN_USER_ID, andWEKAN_TOKEN_EXPIRES. - A
test-auth.jsscript to verify the configured token authenticates successfully. - MCP Inspector integration for development and debugging, including a watch mode that rebuilds automatically on changes.
How to install
Generate your Wekan API token with the platform script:
./get-wekan-token.sh
Or configure manually by copying the example environment file:
cp .env.example .env
Then edit .env with your Wekan instance URL and API token. Verify the setup with node test-auth.js. For development, launch the MCP Inspector with npm run inspect (or npm run inspect:watch for automatic rebuilds).
Who it's for
Teams self-hosting Wekan who want to connect an AI assistant to their kanban instance via MCP, and need a straightforward way to generate and verify the API token that authenticates the connection.
Source README
Wekan MCP Server
made by namar0x0309 with ❤️ at GoAIX
This project includes scripts to automatically generate Wekan API tokens and configure your environment.
Getting Started
Generate Wekan API Token
Run the appropriate script for your platform to generate your API token:
Windows (PowerShell):
./get-wekan-token.ps1
Linux/macOS (Bash):
./get-wekan-token.sh
The script will prompt you for:
- Wekan endpoint (e.g., https://wekan.namar0x0309.com)
- Username
- Password
After successful authentication, it will:
- Generate an API token
- Create or update the
.envfile with your token and configuration
Manual Configuration
If you prefer to configure manually, copy .env.example to .env and fill in your details:
cp .env.example .env
Then edit the .env file with your Wekan instance details and API token.
Environment Variables
The .env file contains:
WEKAN_BASE_URL: Your Wekan instance URLWEKAN_API_TOKEN: Generated API token for authenticationWEKAN_USER_ID: Your Wekan user IDWEKAN_TOKEN_EXPIRES: Token expiration date
Testing
You can test your configuration by running:
node test-auth.js
This will verify that your API token is working correctly.
Development
MCP Inspector
For development and debugging the MCP server, you can use the MCP Inspector:
npm run inspect
This will launch the MCP Inspector with the configuration from mcp-inspector-config.json.
For development with automatic rebuilding:
npm run inspect:watch
This will build the project and launch the inspector, automatically rebuilding when changes are detected.
FAQ
Common questions
Discussion
Questions & comments · 0
Sign In Sign in to leave a comment.