Skip to main content
Glama

vaiz-mcp

DEPRECATED. This package is no longer maintained and this repository is archived.

Vaiz now provides a hosted MCP server at https://api.vaiz.com/mcp with OAuth. You no longer need a local npx proxy or a VAIZ_API_TOKEN.

Cursor users: install the official Vaiz plugin from the Cursor Marketplace — https://github.com/vaizcom/vaiz-cursor-plugin

Any MCP client: point it at the remote server directly.

{
  "mcpServers": {
    "Vaiz": { "url": "https://api.vaiz.com/mcp" }
  }
}

Then authenticate when prompted (in Cursor: Settings → Tools & MCPs → Authenticate).

Guide: https://vaiz.com/help/tutorials/how-to-connect-vaiz-to-mcp · Support: https://vaiz.com/support

Existing installations of vaiz-mcp keep working for now, but will not receive updates or security fixes. Please migrate.


The original documentation is kept below for reference.

MCP (Model Context Protocol) client for Vaiz — connect Cursor/Claude to your Vaiz workspace.

Installation

npm install -g vaiz-mcp

Or use directly via npx:

npx vaiz-mcp

Related MCP server: Claude Code MCP for Cursor

Configuration

Environment Variables

Variable

Required

Description

VAIZ_API_TOKEN

Yes

Your Vaiz API key (Bearer token)

VAIZ_SPACE_ID

No

Your Vaiz Space ID

VAIZ_API_URL

No

MCP API URL (default: https://api.vaiz.com/mcp)

VAIZ_DEBUG

No

Set to true for debug output to stderr

Cursor Configuration

Create or edit ~/.cursor/mcp.json:

{
  "mcpServers": {
    "vaiz": {
      "command": "npx",
      "args": ["vaiz-mcp@latest"],
      "env": {
        "VAIZ_API_TOKEN": "your-api-key",
        "VAIZ_SPACE_ID": "your-space-id"
      }
    }
  }
}

Or after global installation (npm install -g vaiz-mcp):

{
  "mcpServers": {
    "vaiz": {
      "command": "vaiz-mcp@latest",
      "env": {
        "VAIZ_API_TOKEN": "your-api-key",
        "VAIZ_SPACE_ID": "your-space-id"
      }
    }
  }
}

Claude Desktop Configuration

Add to claude_desktop_config.json:

{
  "mcpServers": {
    "vaiz": {
      "command": "npx",
      "args": ["vaiz-mcp@latest"],
      "env": {
        "VAIZ_API_TOKEN": "your-api-key",
        "VAIZ_SPACE_ID": "your-space-id"
      }
    }
  }
}

Usage

After configuration, Cursor/Claude will automatically connect to your Vaiz workspace and gain access to:

  • 🔍 Search tasks, projects, users

  • 📋 Task management (create, edit, comments)

  • 📊 View boards and projects

  • 👥 Team member information

  • 📝 Work with documents and milestones

Debugging

To enable debug output, add the VAIZ_DEBUG variable:

{
  "mcpServers": {
    "vaiz": {
      "command": "npx",
      "args": ["vaiz-mcp@latest"],
      "env": {
        "VAIZ_API_TOKEN": "your-api-key",
        "VAIZ_DEBUG": "true"
      }
    }
  }
}

Debug messages will be output to stderr.

Programmatic Usage

You can also use the library programmatically:

import { createVaizMCPClient } from 'vaiz-mcp';

const client = createVaizMCPClient({
  apiKey: 'your-api-key',
  spaceId: 'your-space-id',
});

// Initialize connection
const initResult = await client.initialize();

// Get list of tools
const tools = await client.listTools();

// Call a tool
const result = await client.callTool('search', { 
  query: 'important task',
  entityType: 'task' 
});

Development

# Clone the repository
git clone https://github.com/vaiz/vaiz-mcp.git
cd vaiz-mcp

# Install dependencies
npm install

# Build the project
npm run build

# Run in development mode
npm run dev

Platforms

LobeHub

License

MIT

Available Tools

33 tools
create_milestoneA

Create a new milestone in a board. The description field is a short plain-text summary (NOT Markdown). To add rich document content, use edit_document_content after creation.

Inputs: name (required), boardId (required), description, dueStart, +1 more.

create_taskC

Create a new task in the Vaiz workspace

Inputs: data (required).

create_task_commentB

Create a new comment on a task by database ID or HRID (e.g., "PRJ-123")

Inputs: taskId (required), content (required), replyTo.

current_userA

Get detailed information about current authenticated user

Inputs: no named parameters.

edit_document_contentA

Edit the document content (description) of a task, milestone, or standalone document. Can append to existing content or replace it entirely.

Inputs: data (required).

edit_taskC

Edit an existing task in the Vaiz workspace

Inputs: data (required).

get_automationsB

Get all automations (workflows) for a specific board

Inputs: boardId (required).

get_boardC

Get detailed information about a specific board by ID

Inputs: boardId (required).

get_documentB

Get detailed information about a USER document in workspace. For SYSTEM help, use read_resource!

Inputs: documentId (required).

get_document_commentsC

Get all comments for a specific document

Inputs: documentId (required).

get_document_historyC

Get history of changes for a specific document

Inputs: documentId (required), limit, keys, excludeKeys, +3 more.

get_memberB

Get detailed information about a specific workspace member by ID

Inputs: memberId (required).

get_milestoneB

Get detailed information about a specific milestone by ID

Inputs: milestoneId (required).

get_notificationsC

Get user notifications with filtering and pagination support

Inputs: limit, lastLoadedDate, readStatus, groups, +1 more.

get_projectC

Get detailed information about a specific project by ID

Inputs: projectId (required).

get_project_historyC

Get history of all activities in a specific project across the workspace

Inputs: projectId (required), limit, keys, excludeKeys, +6 more.

get_taskA

Get detailed information about a specific task by database ID or HRID (e.g., "PRJ-123")

Inputs: taskId (required).

get_task_commentsA

Get all comments for a specific task by database ID or HRID (e.g., "PRJ-123")

Inputs: taskId (required).

get_task_historyC

Get history of changes for a specific task

Inputs: taskId (required), limit, keys, excludeKeys, +3 more.

get_tasksA

Get a filtered list of tasks with pagination. Supports filtering by board, project, assignees, completion status, priorities, milestones, types, and creator.

Examples:

  • My tasks: get_tasks(assignees: [myMemberId])

  • All uncompleted: get_tasks(completed: false)

  • High priority: get_tasks(priorities: ["3"])

  • Specific board: get_tasks(boardId: "...")

  • By type: get_tasks(types: ["typeId1", "typeId2"])

  • By group: get_tasks(boardId: "...", groupId: "...")

  • Created by member: get_tasks(createdBy: "memberId")

  • Next page: get_tasks(skip: 50, limit: 50)

Inputs: boardId, projectId, assignees, completed, +7 more.

get_user_historyC

Get history of all activities performed by a specific user in the current workspace

Inputs: memberId (required), limit, keys, excludeKeys, +7 more.

list_boardsA

List all accessible boards in the current space, optionally filtered by project.

Examples:

  • All boards: list_boards()

  • Boards in project: list_boards(projectId: "...")

Inputs: projectId.

list_membersA

List all members in the current space

Inputs: no named parameters.

list_milestonesB

List all milestones in the current space, optionally filtered by board or project

Inputs: boardId, projectId.

list_projectsA

List all projects in the current space

Inputs: no named parameters.

list_resourcesA

List all available MCP resources (dictionaries, workspace data, etc.)

Inputs: no named parameters.

list_spacesB

List all available spaces (spaces) for the current user

Inputs: no named parameters.

pingA

Simple ping tool for testing

Inputs: no named parameters.

read_resourceA

Read content of a specific MCP resource by name. For knowledge base articles, use "vaiz-help-" prefix + article name from the index.

Inputs: resourceName (required).

select_spaceC

Select a space to work with

Inputs: spaceId (required).

set_task_blockerA

Toggle a blocker relationship between two tasks. Direction is relative to taskId: "blockers" = tasks that block taskId, "blocking" = tasks that taskId blocks. taskId and blockerTaskId accept database IDs or HRIDs (e.g. "PRJ-21").

Inputs: taskId (required), blockerTaskId (required), direction (required).

space_infoA

Get detailed information about current space and user permissions

Inputs: no named parameters.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    B3.2/5.0

    Scored across 33 tools

    Disambiguation5/5

    Each tool targets a distinct entity or action (e.g., create_task vs edit_task vs get_task), and descriptions clarify boundaries like edit_document_content vs edit_task. No obvious overlap between tools.

    Naming Consistency4/5

    Most tools follow a consistent verb_noun pattern (create_, get_, list_, edit_), but 'current_user' deviates from verb_noun, and some singular/plural mismatches (get_task vs get_tasks) reduce consistency slightly.

    Tool Count4/5

    33 tools cover a broad project management domain (tasks, milestones, documents, boards, etc.) and is on the higher side but still reasonable for a comprehensive MCP server. Not excessive, but could be trimmed.

    Completeness2/5

    Missing critical lifecycle operations: no delete tool for any entity, no update for milestones or documents, no create document tool. The set covers reading and creation but lacks key CRUD operations, leading to potential agent dead-ends.

    Maintenance

    ActivityStale
    ResponsivenessLimited data

    Related MCP Connectors

    Related MCP Servers