ovito-mcp 2026.1.dev2__tar.gz → 2026.1.dev4__tar.gz

{ovito_mcp-2026.1.dev2 → ovito_mcp-2026.1.dev4}/.gitignore

@@ -222,12 +222,7 @@ poetry.toml
 pyrightconfig.json
 
 ### VisualStudioCode ###
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-!.vscode/*.code-snippets
+.vscode/
 
 # Local History for Visual Studio Code
 .history/

ovito_mcp-2026.1.dev4/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.4
+Name: ovito-mcp
+Version: 2026.1.dev4
+Summary: MCP server for interactive work in OVITO Pro
+Project-URL: Homepage, https://www.ovito.org
+Project-URL: Documentation, https://docs.ovito.org/reference/data_inspector/coding_agent.html
+Project-URL: Repository, https://gitlab.com/ovito-org/ovito-mcp-server
+Project-URL: Bug Tracker, https://gitlab.com/ovito-org/ovito-mcp-server/-/issues
+Author-email: OVITO GmbH <support@ovito.org>
+License: Proprietary
+License-File: LICENSE
+Keywords: mcp,molecular-dynamics,ovito,visualization
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.10
+Requires-Dist: jupyter-client>=8.0
+Requires-Dist: jupyter-core>=5.0
+Requires-Dist: mcp>=1.2.0
+Requires-Dist: numpy>=1.26
+Requires-Dist: sentence-transformers>=5.6.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Description-Content-Type: text/markdown
+
+# OVITO Pro MCP Server
+
+Connects an AI coding agent to a running **OVITO Pro** session, so you can work with your
+simulation data by describing what you want in plain language. The agent operates inside
+the session you already have open — it can load files, build and adjust pipelines, analyze
+results, and look things up in the OVITO documentation, while you watch each step happen
+live in the GUI and keep working in the same window yourself.
+
+Works with Claude Code, GitHub Copilot CLI, OpenAI Codex, OpenCode, Google Antigravity, and
+other coding agents that support MCP.
+
+## Requirements
+
+- **OVITO Pro 3.16 or later**, with a valid license
+- **Python 3.10 or later**
+- A supported coding agent, installed and set up separately (see
+  [Agent configuration](#agent-configuration))
+
+## Installation
+
+Install the server:
+
+```sh
+pip install ovito-mcp
+```
+
+Verify the installation and check the version with:
+
+```sh
+ovito-mcp --version
+```
+
+The documentation-search tools provided by the OVITO MCP server use two small sentence-transformers models that are downloaded
+once from the Hugging Face Hub (~180 MB total) and cached locally. The server downloads them
+automatically in the background the first time it starts, and never touches the network for
+them again. If you would rather do this one-time download up front — recommended on a slow or
+restricted network, so it can't slow down the first search — run:
+
+```sh
+ovito-mcp --download-models
+```
+
+Then register it with your coding agent, using the **absolute path** to the `ovito-mcp` console
+script. For Claude Code:
+
+```powershell
+# Windows (PowerShell)
+claude mcp add ovito-mcp --scope user -- (Get-Command ovito-mcp).Source
+```
+
+```sh
+# macOS / Linux
+claude mcp add ovito-mcp --scope user -- "$(which ovito-mcp)"
+```
+
+See [Agent configuration](#agent-configuration) below for the other agents.
+
+## Using it
+
+In OVITO Pro, open the
+[**AI Agent**](https://docs.ovito.org/reference/data_inspector/coding_agent.html) tab in
+the data inspector panel at the bottom of the main window, pick your coding agent, and
+press **Start**.
+
+OVITO launches the agent and connects it to the session in front of you. Anything the agent
+does appears live in the GUI, and you can keep interacting with the same scene while it
+works.
+
+No further setup is needed — the agent finds everything it needs from the running OVITO Pro
+session.
+
+See the [AI Agent manual page](https://docs.ovito.org/reference/data_inspector/coding_agent.html)
+for the OVITO-side documentation, including security considerations.
+
+## Agent configuration
+
+Register `ovito-mcp` by its **absolute path** in the configurations below. Find that path with:
+
+```powershell
+# Windows (PowerShell)
+(Get-Command ovito-mcp).Source
+```
+
+```sh
+# macOS / Linux
+which ovito-mcp
+```
+
+and substitute it for `/path/to/ovito-mcp` in the snippets below.
+
+### Claude Code / Claude Desktop
+
+Add this to your `~/.claude.json`:
+
+```json
+"mcpServers": {
+  "ovito-mcp": {
+    "type": "stdio",
+    "command": "/path/to/ovito-mcp"
+  }
+}
+```
+
+### OpenCode
+
+Add this to your `~/.opencode.json`:
+
+```json
+"mcp": {
+  "ovito-mcp": {
+    "type": "local",
+    "command": ["/path/to/ovito-mcp"],
+    "enabled": true
+  }
+}
+```
+
+### Google Antigravity
+
+Add this to your `~/.antigravity/config.json`:
+
+```json
+"mcpServers": {
+  "ovito-mcp": {
+    "command": "/path/to/ovito-mcp"
+  }
+}
+```
+
+### OpenAI Codex
+
+Add this to your `$HOME/.codex/config.toml`:
+
+```toml
+[mcp_servers.ovito-mcp]
+command = "/path/to/ovito-mcp"
+```
+
+### GitHub Copilot
+
+Add this to your `~/.copilot/mcp-config.json`:
+
+```json
+"mcpServers": {
+  "ovito-mcp": {
+    "command": "/path/to/ovito-mcp"
+  }
+}
+```
+
+## Advanced configuration
+
+Neither setting below is needed for normal use. Both are environment variables, intended
+for development and unusual setups.
+
+| Env var        | Purpose                                                                                                                                                                                                       |
+| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `OVITO_EXE`    | Path to the OVITO Pro executable (`ovito.exe` on Windows, `ovito` on Linux, `Ovito.app/Contents/MacOS/ovito` on macOS). Only needed to let the agent start OVITO Pro itself, instead of connecting to a session you already have running. |
+| `OVITO_RAG_DB` | Path to an alternative documentation database. Overrides the one that ships with OVITO Pro, for developing against a custom build.                                                                            |
+
+## Support
+
+Questions and bug reports: <support@ovito.org>

ovito_mcp-2026.1.dev4/README.md

@@ -0,0 +1,163 @@
+# OVITO Pro MCP Server
+
+Connects an AI coding agent to a running **OVITO Pro** session, so you can work with your
+simulation data by describing what you want in plain language. The agent operates inside
+the session you already have open — it can load files, build and adjust pipelines, analyze
+results, and look things up in the OVITO documentation, while you watch each step happen
+live in the GUI and keep working in the same window yourself.
+
+Works with Claude Code, GitHub Copilot CLI, OpenAI Codex, OpenCode, Google Antigravity, and
+other coding agents that support MCP.
+
+## Requirements
+
+- **OVITO Pro 3.16 or later**, with a valid license
+- **Python 3.10 or later**
+- A supported coding agent, installed and set up separately (see
+  [Agent configuration](#agent-configuration))
+
+## Installation
+
+Install the server:
+
+```sh
+pip install ovito-mcp
+```
+
+Verify the installation and check the version with:
+
+```sh
+ovito-mcp --version
+```
+
+The documentation-search tools provided by the OVITO MCP server use two small sentence-transformers models that are downloaded
+once from the Hugging Face Hub (~180 MB total) and cached locally. The server downloads them
+automatically in the background the first time it starts, and never touches the network for
+them again. If you would rather do this one-time download up front — recommended on a slow or
+restricted network, so it can't slow down the first search — run:
+
+```sh
+ovito-mcp --download-models
+```
+
+Then register it with your coding agent, using the **absolute path** to the `ovito-mcp` console
+script. For Claude Code:
+
+```powershell
+# Windows (PowerShell)
+claude mcp add ovito-mcp --scope user -- (Get-Command ovito-mcp).Source
+```
+
+```sh
+# macOS / Linux
+claude mcp add ovito-mcp --scope user -- "$(which ovito-mcp)"
+```
+
+See [Agent configuration](#agent-configuration) below for the other agents.
+
+## Using it
+
+In OVITO Pro, open the
+[**AI Agent**](https://docs.ovito.org/reference/data_inspector/coding_agent.html) tab in
+the data inspector panel at the bottom of the main window, pick your coding agent, and
+press **Start**.
+
+OVITO launches the agent and connects it to the session in front of you. Anything the agent
+does appears live in the GUI, and you can keep interacting with the same scene while it
+works.
+
+No further setup is needed — the agent finds everything it needs from the running OVITO Pro
+session.
+
+See the [AI Agent manual page](https://docs.ovito.org/reference/data_inspector/coding_agent.html)
+for the OVITO-side documentation, including security considerations.
+
+## Agent configuration
+
+Register `ovito-mcp` by its **absolute path** in the configurations below. Find that path with:
+
+```powershell
+# Windows (PowerShell)
+(Get-Command ovito-mcp).Source
+```
+
+```sh
+# macOS / Linux
+which ovito-mcp
+```
+
+and substitute it for `/path/to/ovito-mcp` in the snippets below.
+
+### Claude Code / Claude Desktop
+
+Add this to your `~/.claude.json`:
+
+```json
+"mcpServers": {
+  "ovito-mcp": {
+    "type": "stdio",
+    "command": "/path/to/ovito-mcp"
+  }
+}
+```
+
+### OpenCode
+
+Add this to your `~/.opencode.json`:
+
+```json
+"mcp": {
+  "ovito-mcp": {
+    "type": "local",
+    "command": ["/path/to/ovito-mcp"],
+    "enabled": true
+  }
+}
+```
+
+### Google Antigravity
+
+Add this to your `~/.antigravity/config.json`:
+
+```json
+"mcpServers": {
+  "ovito-mcp": {
+    "command": "/path/to/ovito-mcp"
+  }
+}
+```
+
+### OpenAI Codex
+
+Add this to your `$HOME/.codex/config.toml`:
+
+```toml
+[mcp_servers.ovito-mcp]
+command = "/path/to/ovito-mcp"
+```
+
+### GitHub Copilot
+
+Add this to your `~/.copilot/mcp-config.json`:
+
+```json
+"mcpServers": {
+  "ovito-mcp": {
+    "command": "/path/to/ovito-mcp"
+  }
+}
+```
+
+## Advanced configuration
+
+Neither setting below is needed for normal use. Both are environment variables, intended
+for development and unusual setups.
+
+| Env var        | Purpose                                                                                                                                                                                                       |
+| -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `OVITO_EXE`    | Path to the OVITO Pro executable (`ovito.exe` on Windows, `ovito` on Linux, `Ovito.app/Contents/MacOS/ovito` on macOS). Only needed to let the agent start OVITO Pro itself, instead of connecting to a session you already have running. |
+| `OVITO_RAG_DB` | Path to an alternative documentation database. Overrides the one that ships with OVITO Pro, for developing against a custom build.                                                                            |
+
+## Support
+
+Questions and bug reports: <support@ovito.org>

{ovito_mcp-2026.1.dev2 → ovito_mcp-2026.1.dev4}/RELEASING.md

@@ -60,15 +60,19 @@ PEP 440 pre-release — a dev release (`2026.1.dev1`), alpha (`2026.1a1`), beta
 (`2026.1b1`), or release candidate (`2026.1rc1`). The procedure is identical to above;
 the tag pattern in `.gitlab-ci.yml` already matches these.
 
-Pre-releases are **invisible to ordinary installs**: `pip install ovito-mcp` ignores
-them. Installing one is explicit:
+Once at least one stable version exists, pre-releases are skipped by an ordinary
+`pip install ovito-mcp`, and reaching one is explicit:
 
 ```sh
 pip install --pre ovito-mcp          # newest, including pre-releases
-pip install ovito-mcp==2026.1.dev1   # or pin it exactly
+pip install ovito-mcp==2026.1.dev2   # or pin it exactly
 ```
 
-So `2026.1.dev1` can be published while `2026.1` stays unreleased and unaffected.
+**Caveat while no stable release exists.** pip falls back to pre-releases when a project
+has *no* stable version to choose from, so until `2026.1` is published, a plain
+`pip install ovito-mcp` resolves to the newest pre-release. A pre-release is therefore not
+a private one before the first stable release — it is publicly installable by anyone who
+knows the name.
 
 **Write versions in canonical PEP 440 form.** `2026.1-rc1` and `2026.1.rc1` are accepted
 by the build but normalize to `2026.1rc1` in the artifact and on PyPI, which would make