MCP Server Integration

Viz Arc includes an MCP (Model Context Protocol) server that enables integration with AI assistants and development tools. MCP is an open standard (now under the Linux Foundation) that provides a universal way to connect AI tools to external data and capabilities.

Compatible MCP Clients

The Viz Arc MCP server works with any MCP-compatible client, including:

Client

Type

Notes

Claude Desktop

Desktop App

Anthropic's desktop application

ChatGPT Desktop

Desktop App

OpenAI's desktop application (MCP support added March 2025)

Cursor

IDE

AI-powered code editor with MCP support

VS Code + Copilot

IDE

GitHub Copilot agent mode supports MCP

Windsurf

IDE

Built-in MCP Plugin Store

Cline

VS Code Extension

Autonomous coding agent with MCP integration

Continue

IDE Extension

Open-source extension for VS Code and JetBrains

OpenAI Codex

CLI/IDE

Supports MCP servers in CLI and IDE extension

Architecture Overview

MCP Client VizArc.McpServer.exe Viz Arc
(Any compatible) <----> (Lightweight server) <----> (Main application)
stdio REST API

Benefits

  • Work with multiple AI tools, not locked to one provider.

  • Use your existing AI subscriptions.

  • Access Viz Arc documentation and templates from your preferred tool.

  • Create and modify templates through natural conversation.

  • Work alongside the main Viz Arc application.

Setup Instructions

Step 1: Locate the MCP Server

Find VizArc.McpServer.exe in your Viz Arc installation:

C:\Program Files\Vizrt\Viz Arc\VizArc.McpServer.exe

Step 2: Configure Your MCP Client

Configuration varies by client. Below are examples for popular MCP clients.

Claude Desktop
  1. Open configuration file: %APPDATA%\Claude\claude_desktop_config.json.

  2. Add the configuration:

    {
    "mcpServers": {
    "vizarc": {
    "command": "C:\\Program Files\\Vizrt\\Viz Arc\\VizArc.McpServer.exe",
    "args": []
    }
    }
    }
  3. Restart Claude Desktop completely (check system tray).

ChatGPT Desktop
  1. Open ChatGPT Desktop settings.

  2. Navigate to MCP Servers section.

  3. Add new server with command: C:\Program Files\Vizrt\Viz Arc\VizArc.McpServer.exe.

  4. Restart ChatGPT Desktop.

Cursor
  1. Open Cursor Settings (CTRL + ,).

  2. Navigate to MCP section.

  3. Add server configuration:

    {
    "vizarc": {
    "command": "C:\\Program Files\\Vizrt\\Viz Arc\\VizArc.McpServer.exe",
    "args": []
    }
    }
  4. Restart Cursor.

VS Code with GitHub Copilot
  1. Open VS Code Settings (CTRL + ,).

  2. Search for MCP.

  3. Edit settings.json and add:

    {
    "github.copilot.chat.mcpServers": {
    "vizarc": {
    "command": "C:\\Program Files\\Vizrt\\Viz Arc\\VizArc.McpServer.exe",
    "args": []
    }
    }
    }
  4. Reload VS Code.

Windsurf
  1. Open Windsurf's MCP Plugin Store.

  2. Search for VizArc or add custom server.

  3. Set command path: C:\Program Files\Vizrt\Viz Arc\VizArc.McpServer.exe.

OpenAI Codex CLI
codex --mcp-server "C:\Program Files\Vizrt\Viz Arc\VizArc.McpServer.exe"

Important: Use double backslashes (\\) in JSON paths for Windows.

Step 3: Verify Connection

After configuring your MCP client:

  1. Start a new conversation.

  2. Ask: "What Viz Arc tools do you have access to?".

The AI should respond with information about available Viz Arc tools.

Example Prompts

For documentation queries (Viz Arc not required)
  • "Show me the available parameter types in Viz Arc"

  • "How do callbacks work in Viz Arc templates?"

  • "What is the difference between SetControlObject and UpdateTemplate?"

For live template work (Viz Arc must be running)
  • "What template do I have open in Viz Arc?"

  • "Add a text input parameter called 'headline' to my current template"

  • "Show me the control objects available in my template"

  • "Link the 'score' parameter to the 'ScoreText' control object"

Available AI Tools

Static Tools (Always Available)

These tools work without Viz Arc running:

Tool

Description

get_documentation

Access Viz Arc API documentation.

get_parameters_reference

Get parameter types and properties reference.

get_sample_templates

Show example template implementations.

list_parameter_types

List all available UI parameter types.

query_documentation

Search documentation for specific topics.

Dynamic Tools (Require Viz Arc Running)

These tools require Viz Arc to be running and a valid AI license:

Tool

Description

get_current_project

Get information about the loaded project.

list_templates

List all templates in the current project.

get_template

Get details of a specific template.

validate_template_code

Validate JavaScript or VBScript code.

create_template

Create a new template and open it in Template Designer.

get_current_editing_template

Get the template currently open in Template Designer.

modify_current_template

Apply changes to the currently open template.

get_control_objects

Get available control objects for linking.

link_parameter_to_control_object

Create UI linkage between parameter and control object.

unlink_parameter

Remove linkage from a parameter.

get_parameter_linkages

View all current parameter linkages.

Modifying Parameters

When using modify_current_template, you can update various parameter properties:

Property

Description

x, y

Parameter position

width, height

Parameter dimensions

label

Display label

parameterColor / backgroundColor

Background color

Supported Color Formats

  • Hex: #FF5500 or #AARRGGBB

  • RGB function: RGB(255, 85, 0)

  • Comma-separated: 255, 85, 0

  • JSON object: {"R": 255, "G": 85, "B": 0}

Troubleshooting

AI Prompt Panel Not Visible

Cause: AI license not valid or not available.

Solution:

  1. Verify AI license status in System > Configuration > Info.

  2. Contact your Vizrt representative if license is missing.

MCP Server Not Connecting

Check 1: Configuration file syntax

  • Ensure claude_desktop_config.json has valid JSON syntax.

  • Verify double backslashes in Windows paths.

Check 2: Executable path

  • Confirm VizArc.McpServer.exe exists at the specified path.

  • Test by running the executable directly in a terminal.

Check 3: Restart Claude Desktop

  • Fully quit Claude Desktop (check system tray icon).

  • Relaunch the application.

"AI License Required" Error

Cause: Valid AI license not detected.

Solution:

  1. Ensure Viz Arc is running.

  2. Verify AI license in System > Configuration > Info.

  3. Contact your Vizrt representative for license issues.

Documentation Not Loading

Check that the documentation folder exists: %ProgramData%\Vizrt\VizArc\Resources\MCP\AI_Documentation\.

If missing, reinstall Viz Arc or contact support.

Dynamic Tools Not Working

Cause: Viz Arc application not running.

Solution:

  1. Start Viz Arc.

  2. Load a template in template editor.

  3. Try the tool again.

Note: Static tools (documentation, parameter types) work without Viz Arc running. Dynamic tools require Viz Arc to be running with a loaded template.