Metadata-Version: 2.4
Name: paraview-mcp-server
Version: 0.2.1
Summary: ParaView integration through the Model Context Protocol
License: MIT
Project-URL: Homepage, https://github.com/failed33/paraview-mcp
Project-URL: Repository, https://github.com/failed33/paraview-mcp
Project-URL: Issues, https://github.com/failed33/paraview-mcp/issues
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.13
Description-Content-Type: text/markdown
Requires-Dist: fastmcp<4,>=3.4.7
Provides-Extra: dev
Requires-Dist: ruff<0.17,>=0.16.2; extra == "dev"
Requires-Dist: pyrefly<2,>=1.2.0; extra == "dev"
Requires-Dist: pytest<10,>=9.1.1; extra == "dev"
Requires-Dist: pytest-cov<8,>=7.1.0; extra == "dev"
Requires-Dist: pip-licenses<6,>=5.5.5; extra == "dev"
Requires-Dist: licensecheck<2027,>=2026.0.8; extra == "dev"

<!-- mcp-name: io.github.failed33/paraview-mcp-server -->
# ParaView MCP Server

This package is the external [FastMCP](https://gofastmcp.com/) server that talks to the
ParaView MCP plugin over TCP.

It expects the ParaView-side C++ plugin to be loaded and listening first.

## Requirements

- Python `>=3.13`
- `fastmcp>=3.4.7,<4`

## Install

Run without installing (recommended):

```bash
uvx paraview-mcp-server
```

Or install the command from PyPI:

```bash
uv tool install paraview-mcp-server
```

For development, install in editable mode from the repository:

```bash
cd Wrapping/Python/MCPServer
uv sync
```

## Optional Environment Configuration

- `PARAVIEW_HOST` defaults to `127.0.0.1`; set it for remote connections
- `PARAVIEW_PORT` defaults to `9877`
- `PARAVIEW_AUTH_TOKEN` is required for non-loopback targets

## Bridge Protocol

The server speaks protocol version `2` to the ParaView plugin and sends:

- `hello`
- `ping`
- `execute_python`
- `inspect_pipeline`
- `capture_screenshot`

The public MCP tools remain:

- `execute_paraview_code`
- `get_pipeline_info`
- `get_screenshot`

## Run

```bash
paraview-mcp-server
```
