Back to Vibe Kanban

Vibe Kanban MCP Server

docs/integrations/vibe-kanban-mcp-server.mdx

0.1.013.1 KB
Original Source

Vibe Kanban exposes a local MCP (Model Context Protocol) server, allowing you to manage organisations, projects, issues, workspaces, and repositories from external MCP clients like Claude Desktop, Raycast, or even coding agents running within Vibe Kanban itself.

<Note> This page covers connecting **external MCP clients** to Vibe Kanban's MCP server. For configuring MCP servers **within** Vibe Kanban for your coding agents, see the [MCP Server Configuration](/integrations/mcp-server-configuration) guide. </Note> <Info> Vibe Kanban's MCP server is **local-only** - it runs on your computer and can only be accessed by applications installed locally. It cannot be accessed via publicly accessible URLs. </Info>

<video controls className="w-full aspect-video rounded-xl" src="https://vkcdn.britannio.dev/vk-mcp-server.mp4"

</video>

Setting Up MCP Integration

Option 1: Using the Web Interface

This works if you're adding the Vibe Kanban MCP server to any supported coding agent within Vibe Kanban.

  1. In Vibe Kanban Settings, navigate to the "MCP Servers" page
  2. In the "Popular servers" section, click on the Vibe Kanban card
  3. Click the Save Settings button
<Frame> </Frame>

Option 2: Manual Configuration

You can manually add the MCP server to your coding agent's configuration. The exact syntax will depend on your coding agent or MCP client.

Add the following configuration to your agent's MCP servers configuration:

json
{
  "mcpServers": {
    "vibe_kanban": {
      "command": "npx",
      "args": ["-y", "vibe-kanban@latest", "--mcp"]
    }
  }
}

--mcp launches the local MCP stdio server. Any additional arguments after --mcp are passed through to the vibe-kanban-mcp binary.

Available MCP Tools

The Vibe Kanban MCP server provides tools for managing organisations, projects, issues, workspaces, and task execution.

<Note> Many tools accept an optional `project_id` or `organization_id` parameter. When running inside a workspace linked to a remote project, these are inferred automatically from context and can be omitted. The exception is `list_projects`, which always requires an explicit `organization_id`. </Note>

Context

ToolPurposeRequired ParametersOptional ParametersReturns
get_contextGet current workspace context (only available within an active workspace session)NoneNoneProject, issue, and workspace metadata

Organisation Operations

ToolPurposeRequired ParametersOptional ParametersReturns
list_organizationsList all available organisationsNoneNoneList of organisations with IDs, names, and slugs
list_org_membersList members of an organisationNoneorganization_idList of members with user IDs, roles, and profile info

Project Operations

ToolPurposeRequired ParametersOptional ParametersReturns
list_projectsList projects in an organisationorganization_idNoneList of projects with IDs and names

Issue Management

ToolPurposeRequired ParametersOptional ParametersReturns
list_issuesList issues in a projectNoneproject_id
status
priority
search
simple_id
parent_issue_id
assignee_user_id
tag_id
tag_name
limit
offsetPaginated list of issues with PR info
create_issueCreate a new issuetitleproject_id
description
priority
parent_issue_idCreated issue ID
get_issueGet detailed issue informationissue_idNoneFull issue details with tags, relationships, sub-issues, and PRs
update_issueUpdate an existing issueissue_idtitle
description
status
priority
parent_issue_idUpdated issue details
delete_issueDelete an issueissue_idNoneDeletion confirmation
list_issue_prioritiesList allowed priority valuesNoneNoneList of priorities: urgent, high, medium, low
<Tip> For `update_issue`, the `parent_issue_id` field supports three states: omit it entirely to leave the parent unchanged, pass `null` to un-nest the issue from its parent, or pass a UUID to set a new parent. </Tip>

Issue Assignees

ToolPurposeRequired ParametersOptional ParametersReturns
list_issue_assigneesList assignees for an issueissue_idNoneList of assignees with user IDs
assign_issueAssign a user to an issueissue_id
user_idNoneIssue assignee ID
unassign_issueRemove an assignee from an issueissue_assignee_idNoneUnassignment confirmation

Issue Tags

ToolPurposeRequired ParametersOptional ParametersReturns
list_tagsList tags for a projectNoneproject_idList of tags with IDs, names, and colours
list_issue_tagsList tags attached to an issueissue_idNoneList of issue-tag relations
add_issue_tagAttach a tag to an issueissue_id
tag_idNoneIssue-tag relation ID
remove_issue_tagRemove a tag from an issueissue_tag_idNoneRemoval confirmation

Issue Relationships

ToolPurposeRequired ParametersOptional ParametersReturns
create_issue_relationshipCreate a relationship between two issuesissue_id
related_issue_id
relationship_typeNoneRelationship ID
delete_issue_relationshipDelete a relationship between issuesrelationship_idNoneDeletion confirmation

Supported relationship types: blocking, related, has_duplicate.

Repository Management

ToolPurposeRequired ParametersOptional ParametersReturns
list_reposList all repositoriesNoneNoneList of repositories with IDs and names
get_repoGet repository details including scriptsrepo_idNoneRepository info with setup, cleanup, and dev server scripts
update_setup_scriptUpdate a repository's setup scriptrepo_id
scriptNoneUpdate confirmation
update_cleanup_scriptUpdate a repository's cleanup scriptrepo_id
scriptNoneUpdate confirmation
update_dev_server_scriptUpdate a repository's dev server scriptrepo_id
scriptNoneUpdate confirmation

Workspace Management

ToolPurposeRequired ParametersOptional ParametersReturns
list_workspacesList local workspacesNonearchived
pinned
branch
name_search
limit
offsetPaginated list of workspaces
update_workspaceUpdate a workspace's propertiesNoneworkspace_id
archived
pinned
nameUpdated workspace details
delete_workspaceDelete a local workspaceNoneworkspace_id
delete_remote
delete_branchesDeletion confirmation
link_workspace_issueLink a workspace to a remote issueworkspace_id
issue_idNoneLink confirmation

Workspace Sessions

ToolPurposeRequired ParametersOptional ParametersReturns
start_workspaceCreate a workspace and start its first coding-agent sessionname
executor
repositoriesprompt
variant
issue_idWorkspace ID
create_sessionCreate a session in an existing workspaceNoneworkspace_id
executorSession summary
list_sessionsList sessions for a workspaceNoneworkspace_idSession list
run_session_promptRun a coding-agent prompt inside an existing sessionsession_id
promptNoneExecution details
get_executionInspect execution status and final messageexecution_idNoneExecution details

The repositories parameter is an array of objects with:

  • repo_id: The repository ID (UUID)
  • branch: The branch for this repository

When issue_id is provided, the workspace is automatically linked to the remote issue. If prompt is omitted, the linked issue's title and description are used as the workspace prompt.

Supported Executors

When using start_workspace, the following executors are supported (case-insensitive, accepts hyphens or underscores):

  • claude-code / CLAUDE_CODE
  • amp / AMP
  • gemini / GEMINI
  • codex / CODEX
  • opencode / OPENCODE
  • cursor_agent / CURSOR_AGENT
  • qwen-code / QWEN_CODE
  • copilot / COPILOT
  • droid / DROID

Using the MCP Server

Once you have the MCP server configured, you can leverage it to streamline your project planning and execution workflow:

  1. Plan Your Work: Describe a large feature or project to your MCP client
  2. Request Issue Creation: At the end of your description, simply add "then turn this plan into issues"
  3. Automatic Issue Generation: Your MCP client will use the Vibe Kanban MCP server to automatically create structured issues in your project
  4. Start Workspaces: Use start_workspace to programmatically begin work on issues with specific coding agents

Example Usage

Planning and Issue Creation

I need to build a user authentication system with the following features:
- User registration with email validation
- Login/logout functionality
- Password reset capability
- Session management
- Protected routes

Then turn this plan into issues.

Your MCP client will use the create_issue tool to break this down into individual issues and add them to your Vibe Kanban project automatically.

Starting a Workspace Session

After issues are created, you can start work on them programmatically:

Start working on the user registration issue using Claude Code on the main branch.

Your MCP client will use the start_workspace tool with parameters like:

json
{
  "name": "User registration with email validation",
  "executor": "claude-code",
  "repositories": [
    {
      "repo_id": "987fcdeb-51a2-3d4e-b678-426614174001",
      "branch": "main"
    }
  ],
  "issue_id": "123e4567-e89b-12d3-a456-426614174000"
}

This creates a new workspace, links it to the issue, generates a feature branch, and starts the coding agent in an isolated environment.

Complete Workflow Example

1. List organisations to find the organisation ID
2. List projects in the organisation to find the project ID
3. List issues in the project filtered by status
4. Create a new issue for "Add user profile page"
5. Assign a team member to the issue
6. Start a workspace session for the issue using Amp on the develop branch

Each step uses the appropriate MCP tool (list_organizations, list_projects, list_issues, create_issue, assign_issue, start_workspace) to manage the complete workflow from planning to execution.

Internal Coding Agents (Within Vibe Kanban)

A powerful workflow involves using coding agents within Vibe Kanban that are also connected to the Vibe Kanban MCP server:

  1. Create a Planning Issue: Create an issue with a custom agent profile configured with a planning prompt. See Agent Configurations for details on creating custom profiles.
  2. Explore and Plan: The coding agent explores the codebase and develops a comprehensive plan
  3. Generate Issues: Ask the coding agent to "create a series of individual issues for this plan"
  4. Automatic Population: The agent uses the MCP server to populate individual issues directly in the Vibe Kanban interface

This creates a seamless workflow where high-level planning automatically generates actionable issues in your project board.

Installation Instructions for MCP Clients

Raycast Example

Raycast is a popular MCP client that can connect to Vibe Kanban's MCP server. Here's how to configure it:

For complete Raycast MCP configuration details, see the official Raycast MCP documentation.

<Tabs> <Tab title="Step 1: Open MCP Server Installer"> <Frame> </Frame>

Configure the Vibe Kanban MCP server in Raycast by adding the server details. </Tab>

<Tab title="Step 2: Supply Command"> <Frame> </Frame>

Once configured, you'll see the Vibe Kanban MCP server listed and ready to use in Raycast. </Tab> </Tabs>

<Note> Similar configuration steps apply to other MCP clients like Claude Desktop, VS Code with MCP extensions, or any custom MCP client implementations. </Note>