Skip to main content

MCP (Model Context Protocol) server for ParaView visualization control

Project description

Paraview_MCP

ParaView-MCP is an autonomous agent that integrates multimodal large language models with ParaView through the Model Context Protocol, enabling users to create and manipulate scientific visualizations using natural language and visual inputs instead of complex commands or GUI operations. The system features visual feedback capabilities that allow it to observe the viewport and iteratively refine visualizations, making advanced visualization accessible to non-experts while augmenting expert workflows with intelligent automation.

Video Demo

Click the image below to watch the video:

Video Title

Installation

git clone https://github.com/LLNL/paraview_mcp.git
cd paraview_mcp

conda create -n paraview_mcp python=3.10
conda install conda-forge::paraview
conda install mcp[cli] httpx

Setup for LLM

To set up integration with claude desktop, add the following to claude_desktop_config.json

    "mcpServers": {
      "ParaView": {
        "command": "/path/to/python",
        "args": [
        "/path/to/paraview_mcp/src/paraview_mcp_server.py"
        ]
      }
    }

Running

1. Start paraview server

pvserver --multi-clients

2. Connect to paraview server from paraview GUI (file -> connect)

3. Start claude desktop app


Testing

Unit and Integration Tests

ParaView-MCP includes comprehensive unit and integration tests to ensure reliability.

Prerequisites

  1. Install test dependencies:
pip install pytest pytest-cov
  1. Start ParaView server (required for integration tests):
pvserver --multi-clients --server-port=11111
  1. Connect ParaView GUI to the server:
    • Open ParaView GUI
    • File -> Connect -> Add Server
    • Host: localhost, Port: 11111
    • Connect

Running Tests

# Run live integration tests (requires running ParaView server)
pytest tests/test_paraview_manager_live.py -v

# Run with coverage report
pytest tests/test_paraview_manager_live.py --cov=src --cov-report=html

# Run specific test class
pytest tests/test_paraview_manager_live.py::TestParaViewLive -v

# Run specific test method
pytest tests/test_paraview_manager_live.py::TestParaViewLive::test_create_sphere -v

Test Structure

  • tests/test_paraview_manager_live.py: Live integration tests with ParaView
    • Tests real ParaView operations
    • Verifies end-to-end functionality
    • Requires running ParaView server connected on port 11111

Evaluation

Promptfoo Evaluation Framework

For comprehensive feature testing using LLM evaluation:

Setup

  1. Install promptfoo:
npm install -g promptfoo
  1. Start ParaView server (if not already running):
pvserver --multi-clients --server-port=11111

Then connect ParaView GUI to the server (File -> Connect -> localhost:11111)

Run Evaluation Tests

# Run evaluation with Claude
promptfoo eval --no-cache -c eval/eval_claude.yaml --verbose

# Run simple action tests
promptfoo eval --no-cache -c eval/eval_claude.yaml -t eval/simple_action_eval.yaml --verbose

# Run basic feature validation
promptfoo eval --no-cache -c eval/eval_claude.yaml -t eval/basic_features_validation.yaml --verbose

The --no-cache flag ensures fresh test runs, and --verbose provides detailed debugging output.

Data Anonymization

To prevent evaluation bias from metadata or file naming patterns, ParaView-MCP includes a tool to anonymize datasets and test files.

Usage

# Anonymize a test file and copy all referenced datasets
python eval/anonymize_dataset.py test.yaml

# Quick mode - only update YAML paths without copying data files
python eval/anonymize_dataset.py test.yaml --quick

# Custom output directory
python eval/anonymize_dataset.py test.yaml -o my_output_dir

# Preview changes without writing files
python eval/anonymize_dataset.py test.yaml --dry-run

# Save mapping for later reference
python eval/anonymize_dataset.py test.yaml -m mapping.json

What Gets Anonymized

  • Dataset names: aneurismdataset_001
  • Descriptive filenames: aneurism_256x256x256_uint8.rawdata_001.raw
  • File paths in YAML: All paths updated to point to anonymized versions
  • Directory structure: Organized as output_dir/dataset_XXX/data/

Output

The tool creates:

  1. test_anonymized.yaml - Updated test file with anonymous paths
  2. eval/anonymized_datasets/ - Directory containing copied, anonymized data files
  3. mapping.json (optional) - Record of all name mappings

Example

Original YAML:

question: "Load ../SciVisAgentBench-tasks/aneurism/data/aneurism_256x256x256_uint8.raw"

Anonymized YAML:

question: "Load eval/anonymized_datasets/dataset_001/data/data_000.raw"

Citing Paraview_MCP

S. Liu, H. Miao, and P.-T. Bremer, “Paraview-MCP: Autonomous Visualization Agents with Direct Tool Use,” in Proc. IEEE VIS 2025 Short Papers, 2025, pp. 00

@inproceedings{liu2025paraview,
  title={Paraview-MCP: Autonomous Visualization Agents with Direct Tool Use},
  author={Liu, S. and Miao, H. and Bremer, P.-T.},
  booktitle={Proc. IEEE VIS 2025 Short Papers},
  pages={00},
  year={2025},
  organization={IEEE}
}

Authors

Paraview_MCP was originally created by Shusen Liu (liu42@llnl.gov) and Haichao Miao (miao1@llnl.gov)

License

Paraview_MCP is distributed under the terms of the BSD-3 license.

LLNL-CODE-2007260

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

paraview_mcp-0.1.1.tar.gz (45.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

paraview_mcp-0.1.1-py3-none-any.whl (41.5 kB view details)

Uploaded Python 3

File details

Details for the file paraview_mcp-0.1.1.tar.gz.

File metadata

  • Download URL: paraview_mcp-0.1.1.tar.gz
  • Upload date:
  • Size: 45.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for paraview_mcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 eb710ffcf55bef9dcb35989bb0243ba44252442b12dcb3cc63e292470e59636b
MD5 360bc7dc32d696d3455bffb132f95f8e
BLAKE2b-256 b4c677aeda3157a2be5c782c434d1c3ac06b4560f15e0dabb81b7e7e340a9d86

See more details on using hashes here.

File details

Details for the file paraview_mcp-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: paraview_mcp-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 41.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for paraview_mcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d46fe88fdeb85605c6701c33700e151ae3e9ba178a5c678b6f75ee94e950c0bb
MD5 36f3a57a4b2c6ed9a33694b8c588892c
BLAKE2b-256 60c6320f260dfa7758d1f94b886a71078013b4e12cbb5358b661972a2960bdb9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page