Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Publish connector overview

on:
push:
branches: [main]
paths: ["site/**", ".github/workflows/pages.yml"]
workflow_dispatch:

permissions:
contents: read

concurrency:
group: github-pages
cancel-in-progress: false

jobs:
deploy:
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v6
- uses: actions/configure-pages@v5
- uses: actions/upload-pages-artifact@v4
with:
path: site
- uses: actions/deploy-pages@v4
id: deployment
34 changes: 33 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,37 @@ All notable changes to ViperMesh for Blender are documented here.

## [Unreleased]

## [1.3.0] - 2026-10-07

### Added

- Repository-connected GitHub Pages overview, setup and honest capability limits.
- Inline bounded PNG/JPEG output for image-aware MCP clients.
- Geometry/deformation diagnostics and guarded addon operations already present
in the current Blender tool surface, synchronized into the public distribution.

### Changed

- Finalize can preserve existing camera/lighting and render without saving a blend
file. Named spatial failures block final output and retain repair details.
- Removed fixed preview counts; require task-based visual review and disclose
unresolved defects instead of treating file health as a quality verdict.
- Blend saves are explicit and refuse existing destinations in staged finalize.
- Updated the public dependency lock and SDK floor; clean install audit is clear.
- Package validation checks every shipped skill reference.
- Corrected retarget rollback after backup or export failure, partial-import
cleanup, cancelled operator handling, enum-flag argument conversion and
implementation-aware addon fingerprints. Added Blender runtime regressions.

### Changed

- Replaced the exported private tool-guide corpus with a concise, installable
public agent skill and adaptable reference documents.
- Added explicit native stdio client setup and clarified the optional,
not-yet-supported Docker MCP Toolkit route.
- Added export checks that prevent private `data/tool-guides` content from
entering public releases.

## [1.2.0] - 2026-07-25

### Added
Expand All @@ -21,5 +52,6 @@ All notable changes to ViperMesh for Blender are documented here.
- Explicit `execute_code` fallback for genuinely custom Blender work.
- Local-only loopback transport and public release validation.

[Unreleased]: https://github.com/Ker102/vipermesh-blender/compare/v1.2.0...HEAD
[Unreleased]: https://github.com/Ker102/vipermesh-blender/compare/v1.3.0...HEAD
[1.3.0]: https://github.com/Ker102/vipermesh-blender/compare/v1.2.0...v1.3.0
[1.2.0]: https://github.com/Ker102/vipermesh-blender/releases/tag/v1.2.0
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
**A persistent Model Context Protocol server and deterministic Blender addon
for AI agents.**

[Project overview and setup](https://ker102.github.io/vipermesh-blender/)
| [ViperMesh Studio waitlist](https://vipermesh-studio.vercel.app/waitlist)

ViperMesh for Blender gives MCP-compatible agents structured scene inspection,
reusable Blender operations, bounded batches, local 3D workflow guidance, and
an explicit Python fallback. It is designed to reduce repeated Blender API
Expand All @@ -25,7 +28,7 @@ broad deterministic tool surface for common operations.
| Deterministic tools | Structured operations for assembly, materials, cameras, lighting, rendering, rigging, UVs, retopology, export, and inspection |
| Scene validation | Grounding, support, clearance, spatial-relation, file-health, and render-artifact checks |
| Compact workflows | Bounded batch calls plus separate build, inspect/repair, and finalize stages |
| Agent onboarding | Session bootstrap, MCP resources, concise operating rules, and local task guides |
| Agent onboarding | Session bootstrap, MCP resources, concise operating rules, and portable tool skills |
| Custom fallback | `execute_code` remains available when a deterministic operation is not the right tool |

## Architecture
Expand Down Expand Up @@ -59,7 +62,7 @@ loopback by default and reports **Stopped**, **Ready**, **Agent connected**, or

### 1. Install the Blender addon

Download `vipermesh-addon.py` from the
Download the versioned addon `.py` or addon `.zip` from the
[latest release](https://github.com/Ker102/vipermesh-blender/releases/latest).
In Blender:

Expand All @@ -84,22 +87,25 @@ npm run build

### 3. Configure your MCP client

Use the absolute repository path:
Use the built entry point from an absolute path:

```json
{
"mcpServers": {
"vipermesh-blender": {
"command": "npm",
"args": ["run", "mcp"],
"cwd": "C:/absolute/path/to/vipermesh-blender"
"command": "node",
"args": [
"C:/absolute/path/to/vipermesh-blender/dist/public-portable-blender-mcp.js"
]
}
}
}
```

Start this command once through the MCP client. Do not invoke `npm`, `npx`, or
`tsx` again for each Blender operation.
`tsx` again for each Blender operation. See [MCP client setup](docs/client-setup.md)
for Codex, JSON-configured clients, compatibility, and the optional Docker MCP
Toolkit route.

## First Agent Calls

Expand All @@ -122,7 +128,9 @@ The public MCP surface includes:
- `get_3d_guidance_document`

Read the [complete connector manual](docs/portable-blender-mcp.md) for request
shapes, batching rules, staged workflows, local guidance, and troubleshooting.
shapes, batching rules, staged workflows, local tool skills, and
troubleshooting. The repository also ships an installable
[`using-vipermesh-blender` agent skill](skills/using-vipermesh-blender/SKILL.md).

## Security

Expand All @@ -136,7 +144,7 @@ reporting process.
## Public Connector Scope

This repository contains the open-source Blender addon, portable MCP server,
local operating guidance, and connector tests. It does not include the
portable public tool skills, and connector tests. It does not include the
ViperMesh application, authentication, billing, private prompts, private RAG
data, cloud model routing, private assets, or benchmark evidence.

Expand All @@ -157,6 +165,13 @@ unusual node graphs, and uncovered workflows.
The process retains a serialized connection to Blender. Relaunching it for
every call adds avoidable startup, transport, and agent-tool overhead.

### Does it require Docker?

No. Local stdio-capable MCP clients launch the Node server directly. Docker MCP
Toolkit is an optional packaging and gateway route, and is not yet a supported
ViperMesh installation path because host-to-Blender loopback connectivity still
requires cross-platform validation.

### Does the public connector require ViperMesh cloud authentication?

No. The public addon and local MCP server work without ViperMesh authentication.
Expand Down
Loading
Loading