npm package: @helixcanvas/mcp
Description: MCP server for Helix — connect your AI coding tools to your Helix knowledge base
Author: Helix Canvas
Latest version: 0.1.1

# @helixcanvas/mcp

MCP server for [Helix](https://helixcanvas.ai) — connect your AI coding tools to your product's knowledge base, canvas, documents, and blueprint.

## Quick Setup

### 1. Get your API key

Create an API key from the [Helix dashboard](https://helixcanvas.ai) under **Settings > API Keys**. Each key is scoped to a specific product.

### 2. Connect your tool

<details open>
<summary><strong>Claude Code</strong></summary>

Run this command in your terminal:

```bash
claude mcp add helix -e HELIX_API_KEY=your-api-key -- npx @helixcanvas/mcp@latest
```

Or add to `.mcp.json` in your project root:

```json
{
  "mcpServers": {
    "helix": {
      "command": "npx",
      "args": ["@helixcanvas/mcp@latest"],
      "env": {
        "HELIX_API_KEY": "your-api-key"
      }
    }
  }
}
```

</details>

<details>
<summary><strong>Cursor</strong></summary>

Add to `.cursor/mcp.json` in your project root:

```json
{
  "mcpServers": {
    "helix": {
      "command": "npx",
      "args": ["@helixcanvas/mcp@latest"],
      "env": {
        "HELIX_API_KEY": "your-api-key"
      }
    }
  }
}
```

Then restart Cursor.

</details>

<details>
<summary><strong>Windsurf</strong></summary>

Add to your Windsurf MCP config file:

```json
{
  "mcpServers": {
    "helix": {
      "command": "npx",
      "args": ["@helixcanvas/mcp@latest"],
      "env": {
        "HELIX_API_KEY": "your-api-key"
      }
    }
  }
}
```

</details>

<details>
<summary><strong>Claude Desktop</strong></summary>

Open **Settings > Developer > Edit Config** and add:

```json
{
  "mcpServers": {
    "helix": {
      "command": "npx",
      "args": ["@helixcanvas/mcp@latest"],
      "env": {
        "HELIX_API_KEY": "your-api-key"
      }
    }
  }
}
```

Then restart Claude Desktop.

</details>

<details>
<summary><strong>VS Code</strong></summary>

Add to your VS Code `settings.json`:

```json
"mcp": {
  "servers": {
    "helix": {
      "command": "npx",
      "args": ["@helixcanvas/mcp@latest"],
      "env": {
        "HELIX_API_KEY": "your-api-key"
      }
    }
  }
}
```

</details>

## Configuration

| Variable | Required | Description |
|---|---|---|
| `HELIX_API_KEY` | Yes | Your Helix API key (created in the dashboard) |
| `HELIX_API_URL` | No | Override the API URL (defaults to `https://api.helixcanvas.ai`). Use for self-hosted or local development. |

## Available Tools

### Read

| Tool | Description |
|---|---|
| `list_canvases` | List all canvases for the product |
| `read_canvas` | Get a canvas with all its nodes and edges |
| `get_blueprint` | Get the product's research blueprint and progress |
| `search_knowledge` | AI-powered semantic search across all knowledge sources |
| `search_documents` | Search documents by filename |
| `search_files` | Search files by name (alias for search_documents) |
| `list_files` | List files and folders in a directory |
| `read_file` | Get file metadata and download URL |

### Write

| Tool | Description |
|---|---|
| `create_node` | Create a new node on a canvas |
| `update_node` | Update an existing node's properties |
| `delete_node` | Delete a node from a canvas |
| `create_edge` | Create a connection between two nodes |
| `delete_edge` | Delete a connection between nodes |
| `create_file` | Create a new text file in the knowledge base |
| `update_file_content` | Replace a file's content |
| `rename_file` | Rename a file |
| `delete_file` | Delete a file |
| `create_folder` | Create a new folder |
| `rename_folder` | Rename a folder |
| `delete_folder` | Delete a folder |
| `move_document` | Move a file to a different folder |

## Requirements

- Node.js 18+
- A Helix account with an API key

## License

MIT