vaiz

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

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

License

MIT