3 Commits

Author SHA1 Message Date
Hermes Agent 049b3c0901 v0.3.0: Duplicate detection, GraphQL read-back, create_folder, path normalisation
- client.py: GraphQL-backed list_products() and get_last_version()
  (AYON >=1.15 compat, replaces broken REST endpoints)
- client.py: find_folder() normalises leading slash
  ('/assets/chair' and 'assets/chair' both work)
- client.py: create_folder() + find_or_create_folder() with
  automatic parent creation
- client.py: find_product_by_name() for duplicate detection
- server.py: ayon_create_folder tool (creates folder tree)
- server.py: publish tools now detect existing products and
  auto-version instead of creating duplicates
- server.py: response includes 'action' field
  ('created_new' vs 'versioned_existing')
- server.py: model_type and folder_type enum validation
- server.py: ayon_get_product uses GraphQL for read-back
2026-06-28 11:48:53 +00:00
Hermes Agent 76683d5e24 fix Dockerfile: copy src/ before pip install 2026-06-28 11:30:54 +00:00
Hermes Agent 3b0f64648b v0.2.0: Plug-and-play — dual transport (stdio+HTTP), AYON 1.15.4 compat, Dockerfile
- client.py: add verify=False for internal/self-signed SSL, catch 404
  on list_products() and get_last_version() (AYON >=1.15 compat)
- server.py: dual transport via AYON_TRANSPORT env (stdio default,
  http for Docker); uvicorn for HTTP mode
- pyproject.toml: bump to 0.2.0, add uvicorn dep, remove ayon-python-api
- README: full docs with Claude Desktop/Cursor/Hermes/Docker configs
- Dockerfile: multi-layer build, pip install from pyproject.toml
- .dockerignore: exclude venv, cache, dist
2026-06-28 11:30:02 +00:00
6 changed files with 441 additions and 143 deletions
+7
View File
@@ -0,0 +1,7 @@
venv/
__pycache__/
*.pyc
.eggs/
dist/
*.egg-info/
.git/
+12
View File
@@ -0,0 +1,12 @@
FROM python:3.12-slim
WORKDIR /app
COPY pyproject.toml .
COPY src/ src/
RUN pip install --no-cache-dir .
ENV AYON_TRANSPORT=http
EXPOSE 8000
CMD ["ayon-mcp"]
+110 -23
View File
@@ -1,9 +1,13 @@
# AYON MCP Server
**AI agents can publish CGI assets to AYON via Model Context Protocol.**
**AI agents publish CGI assets to AYON via Model Context Protocol.**
MCP server that wraps AYON's REST API — agents use simple tool calls like
`ayon_publish_texture_set` or `ayon_publish_model` instead of raw HTTP.
`ayon-mcp` wraps AYON's REST API into six MCP tools — any MCP-compatible agent
can browse projects, list folders, and publish texture sets or 3D models with
simple tool calls. No raw HTTP, no manual JSON.
Works with **Claude Desktop**, **Cursor**, **Hermes Agent**, and any other
MCP client (stdio or HTTP transport).
## Tools
@@ -24,7 +28,41 @@ MCP server that wraps AYON's REST API — agents use simple tool calls like
pip install git+https://git.niklashmotion.art/Hermes/ayon-mcp.git
```
### 2. Configure Hermes Agent
### 2. Configure
Two environment variables required:
| Variable | Description |
|----------|-------------|
| `AYON_URL` | AYON server URL (e.g. `https://ayon.niklashmotion.art`) |
| `AYON_KEY` | AYON API key from Settings → API Keys |
Optional:
| Variable | Default | Description |
|----------|---------|-------------|
| `AYON_TRANSPORT` | `stdio` | `stdio` for Claude/Cursor, `http` for Docker |
| `PORT` | `8000` | HTTP port (only when `AYON_TRANSPORT=http`) |
### 3a. Use with Claude Desktop / Cursor (stdio)
Add to `claude_desktop_config.json` or Cursor's MCP config:
```json
{
"mcpServers": {
"ayon": {
"command": "ayon-mcp",
"env": {
"AYON_URL": "https://ayon.niklashmotion.art",
"AYON_KEY": "sk-..."
}
}
}
}
```
### 3b. Use with Hermes Agent (stdio)
Add to `~/.hermes/config.yaml`:
@@ -33,26 +71,45 @@ mcp_servers:
ayon:
command: "ayon-mcp"
env:
AYON_SERVER_URL: "https://ayon.niklashmotion.art"
AYON_API_KEY: "sk-..."
AYON_URL: "https://ayon.niklashmotion.art"
AYON_KEY: "sk-..."
```
Restart Hermes Agent — tools appear as `mcp_ayon_ayon_list_projects` etc.
### 3c. Docker (HTTP transport)
### 3. Use with any MCP client
```bash
docker run -d \
--name ayon-mcp \
-e AYON_URL=https://ayon.niklashmotion.art \
-e AYON_KEY=sk-... \
-e AYON_TRANSPORT=http \
-p 8000:8000 \
ghcr.io/niklas/ayon-mcp:latest
```
```json
{
"mcpServers": {
"ayon": {
"command": "ayon-mcp",
"env": {
"AYON_SERVER_URL": "https://ayon.niklashmotion.art",
"AYON_API_KEY": "sk-..."
}
}
}
}
Then in Hermes `config.yaml`:
```yaml
mcp_servers:
ayon:
url: "http://localhost:8000/mcp"
timeout: 30
```
### 3d. Docker Compose
```yaml
services:
ayon-mcp:
build: .
container_name: mcp-ayon
environment:
- AYON_URL=https://ayon.example.com
- AYON_KEY=sk-...
- AYON_TRANSPORT=http
ports:
- "127.0.0.1:8001:8000"
restart: unless-stopped
```
## Example: Agent publishes a texture set
@@ -77,9 +134,9 @@ Agent calls ayon_publish_texture_set with:
## Architecture
```
AI Agent (Hermes / Claude / Cursor)
AI Agent (Claude Desktop / Cursor / Hermes)
│ MCP (stdio)
│ MCP (stdio or HTTP)
ayon-mcp server
│ X-Api-Key header
@@ -87,12 +144,42 @@ ayon-mcp server
AYON REST API (/api/projects, /api/products, ...)
```
The MCP server is the **only gatekeeper** to AYON. All product types
(`imageMain`, `modelMain`) and naming conventions are enforced server-side.
The AI agent orchestrates the workflow but never touches raw API calls.
### Dual transport: stdio + HTTP
- **stdio** (default): `AYON_TRANSPORT=stdio` or unset. The MCP server communicates
over stdin/stdout — required for Claude Desktop and Cursor.
- **HTTP**: `AYON_TRANSPORT=http`. Listens on `PORT` (default 8000). Use for
Docker deployments or when the MCP server runs on a different host than the agent.
The same binary serves both modes — no separate builds needed.
## Compatibility
| Feature | AYON ≥1.15 | Older AYON |
|---------|-----------|------------|
| List projects | ✅ | ✅ |
| List folders | ✅ | ✅ |
| Create product | ✅ | ✅ |
| Create version | ✅ | ✅ |
| Create representation | ✅ | ✅ |
| List products (read-back) | ⚠️ falls back gracefully | ✅ |
| Get last version | ⚠️ falls back gracefully | ✅ |
AYON ≥1.15 removed the REST endpoints for listing products and versions.
The MCP server catches 404 and returns empty results — publish still works,
but read-back requires the GraphQL endpoint (not yet implemented in the MCP
tools).
## Limitations
- **REST-only**: Products are registered as metadata. Actual file upload into
project anatomy requires the pyblish pipeline (DCC host).
- **No folder creation**: Folders must exist before publishing. Use AYON Web UI
or Tray Publisher to create them first.
or Tray Publisher to create them first, or create them via REST API.
- **Representations are metadata**: The `files` array contains names/sizes,
not uploaded content. Full file publishing needs a host with pyblish.
+3 -3
View File
@@ -1,12 +1,12 @@
[project]
name = "ayon-mcp"
version = "0.1.0"
description = "MCP server for AYON: AI agents can publish CGI assets via Model Context Protocol"
version = "0.2.0"
description = "MCP server for AYON: AI agents publish CGI assets via Model Context Protocol. Works with Claude Desktop, Cursor, Hermes, and any MCP-compatible client."
requires-python = ">=3.10"
dependencies = [
"mcp>=1.0.0",
"httpx>=0.27.0",
"ayon-python-api>=1.0.0",
"uvicorn>=0.30.0",
]
[project.scripts]
+144 -32
View File
@@ -1,5 +1,6 @@
"""AYON REST API client with API key auth."""
"""AYON REST + GraphQL API client with API key auth."""
import json
import os
from typing import Optional
@@ -7,7 +8,7 @@ import httpx
class AyonClient:
"""Minimal wrapper around AYON's REST API.
"""Wrapper around AYON's REST and GraphQL APIs.
Requires AYON_URL and AYON_KEY environment variables.
AYON_KEY is used instead of AYON_API_KEY to avoid Hermes
@@ -22,6 +23,7 @@ class AyonClient:
self.url = (url or os.environ["AYON_URL"]).rstrip("/")
self.api_key = api_key or os.environ["AYON_KEY"]
self._client = httpx.Client(
verify=False,
base_url=self.url,
headers={
"X-Api-Key": self.api_key,
@@ -30,6 +32,17 @@ class AyonClient:
timeout=30,
)
# ── GraphQL helper ────────────────────────────────────
def _graphql(self, query: str) -> dict:
"""Execute a GraphQL query. Returns data dict or raises."""
r = self._client.post("/graphql", json={"query": query})
r.raise_for_status()
body = r.json()
if body.get("errors"):
raise RuntimeError(body["errors"][0]["message"])
return body.get("data", {})
# ── Projects ──────────────────────────────────────────
def list_projects(self) -> list[dict]:
@@ -44,15 +57,119 @@ class AyonClient:
r.raise_for_status()
return r.json()["folders"]
# ── Products ──────────────────────────────────────────
def find_folder(self, project: str, path: str) -> Optional[dict]:
"""Find a folder by its path.
def list_products(self, project: str, folder_id: str) -> list[dict]:
r = self._client.get(
f"/api/projects/{project}/products",
params={"folderId": folder_id},
Normalises leading slash — both '/assets/chair' and 'assets/chair' work.
"""
clean = path.lstrip("/")
folders = self.list_folders(project)
for f in folders:
fp = f.get("path", "").lstrip("/")
if fp == clean:
return f
return None
def create_folder(
self,
project: str,
name: str,
parent_id: str,
folder_type: str = "Asset",
) -> dict:
"""Create a new folder under a parent."""
r = self._client.post(
f"/api/projects/{project}/folders",
json={
"name": name,
"parentId": parent_id,
"folderType": folder_type,
},
)
r.raise_for_status()
return r.json()["products"]
return r.json()
def find_or_create_folder(
self, project: str, path: str, folder_type: str = "Asset"
) -> dict:
"""Find existing folder or create it (including parents)."""
f = self.find_folder(project, path)
if f:
return f
parts = path.strip("/").split("/")
current_parent = None
# Find root parent
folders = self.list_folders(project)
for part in parts:
found = None
for f in folders:
fp = f.get("path", "").lstrip("/")
pid = f.get("parentId") or ""
if current_parent is None and not pid and fp == part:
found = f
break
if current_parent and f.get("parentId") == current_parent["id"] and fp.endswith(part):
found = f
break
if found:
current_parent = found
else:
parent_id = current_parent["id"] if current_parent else self._find_root_folder_id(project)
current_parent = self.create_folder(
project, part, parent_id, folder_type
)
# Refresh folder list for next iteration
folders = self.list_folders(project)
if not current_parent:
raise RuntimeError(f"Could not find or create folder '{path}'")
return current_parent
def _find_root_folder_id(self, project: str) -> str:
from urllib.parse import urlparse
path_parts = urlparse(self.url).path.strip("/").split("/")
# Default to 'assets' parent — find it
folders = self.list_folders(project)
for f in folders:
if f.get("name") == "assets" and not f.get("parentId"):
return f["id"]
# Fallback: first folder without parent
for f in folders:
if not f.get("parentId"):
return f["id"]
raise RuntimeError(f"No root folder found in project '{project}'")
# ── Products (via GraphQL, AYON >=1.15) ───────────────
def list_products(self, project: str, folder_id: str) -> list[dict]:
"""List products in a folder via GraphQL (REST endpoint removed in >=1.15)."""
query = (
'{project(name:"' + project + '")'
'{folder(id:"' + folder_id + '")'
"{products{edges{node{id name productType createdAt updatedAt}}}}}}"
)
try:
data = self._graphql(query)
folder = data.get("project", {}).get("folder")
if not folder:
return []
edges = folder.get("products", {}).get("edges", [])
return [e["node"] for e in edges]
except Exception:
return []
def find_product_by_name(
self, project: str, folder_id: str, product_name: str
) -> Optional[dict]:
"""Find a product by name in a folder. Returns None if not found."""
products = self.list_products(project, folder_id)
for p in products:
if p["name"] == product_name:
return p
return None
def create_product(
self,
@@ -92,13 +209,26 @@ class AyonClient:
return r.json()
def get_last_version(self, project: str, product_id: str) -> Optional[dict]:
r = self._client.get(
f"/api/projects/{project}/versions",
params={"productId": product_id, "latest": "true"},
"""Get latest version via GraphQL (REST endpoint removed in >=1.15)."""
query = (
'{project(name:"' + project + '")'
'{product(id:"' + product_id + '")'
"{versions{edges{node{id version author createdAt}}}}}}"
)
r.raise_for_status()
versions = r.json().get("versions", [])
return versions[0] if versions else None
try:
data = self._graphql(query)
product = data.get("project", {}).get("product")
if not product:
return None
edges = product.get("versions", {}).get("edges", [])
if not edges:
return None
# Sort by version desc
versions = [e["node"] for e in edges]
versions.sort(key=lambda v: v["version"], reverse=True)
return versions[0]
except Exception:
return None
# ── Representations ───────────────────────────────────
@@ -120,21 +250,3 @@ class AyonClient:
)
r.raise_for_status()
return r.json()
# ── Helpers ───────────────────────────────────────────
def find_folder(self, project: str, path: str) -> Optional[dict]:
"""Find a folder by its path (e.g. '/assets/chair')."""
folders = self.list_folders(project)
for f in folders:
if f.get("path") == path:
return f
return None
def get_or_create_folder(self, project: str, path: str, folder_type: str = "Folder") -> dict:
"""Get existing folder or create it."""
f = self.find_folder(project, path)
if f:
return f
# For create we'd need the parent — but let's keep it simple for now
raise NotImplementedError("Folder creation via REST not yet implemented — create manually or via pyblish")
+157 -77
View File
@@ -1,17 +1,12 @@
"""AYON MCP Server — main entry point.
Usage:
AYON_URL=https://ayon.example.com \\
AYON_URL=http://172.18.0.2:5000 \\
AYON_KEY=sk-... \\
ayon-mcp
Hermes config.yaml:
mcp_servers:
ayon:
command: "ayon-mcp"
env:
AYON_URL: "https://ayon.niklashmotion.art"
AYON_KEY: "sk-..."
Supports stdio (Claude Desktop, Cursor) and HTTP (Docker, Hermes) transport.
Set AYON_TRANSPORT=http for HTTP mode.
"""
import json
@@ -78,9 +73,12 @@ async def ayon_list_folders(project: str) -> str:
async def ayon_list_products(project: str, folder_path: str) -> str:
"""List published products in a folder.
Uses GraphQL for AYON >=1.15 compatibility.
Accepts paths with or without leading slash.
Args:
project: Project name
folder_path: Folder path (e.g. '/assets/chair')
folder_path: Folder path (e.g. '/assets/chair' or 'assets/chair')
"""
try:
folder = client.find_folder(project, folder_path)
@@ -98,7 +96,9 @@ async def ayon_list_products(project: str, folder_path: str) -> str:
@app.tool()
async def ayon_get_product(project: str, folder_path: str, product_name: str) -> str:
"""Get details about a specific product.
"""Get details about a specific product, including latest version.
Uses GraphQL for AYON >=1.15 compatibility.
Args:
project: Project name
@@ -109,44 +109,68 @@ async def ayon_get_product(project: str, folder_path: str, product_name: str) ->
folder = client.find_folder(project, folder_path)
if not folder:
return _err(f"Folder '{folder_path}' not found")
products = client.list_products(project, folder["id"])
for p in products:
if p["name"] == product_name:
last = client.get_last_version(project, p["id"])
product = client.find_product_by_name(project, folder["id"], product_name)
if not product:
return _err(f"Product '{product_name}' not found in '{folder_path}'")
last = client.get_last_version(project, product["id"])
return json.dumps({
"name": p["name"],
"type": p.get("productType"),
"id": p["id"],
"name": product["name"],
"type": product.get("productType"),
"id": product["id"],
"latest_version": last["version"] if last else None,
}, indent=2)
return _err(f"Product '{product_name}' not found in '{folder_path}'")
except Exception as e:
return _err(str(e))
# ── Folder Management ────────────────────────────────────
@app.tool()
async def ayon_create_folder(
project: str,
path: str,
folder_type: str = "Asset",
) -> str:
"""Create a new folder in an AYON project. Creates parent folders as needed.
Args:
project: Project name (e.g. 'lumenfjord')
path: Folder path, slash-separated (e.g. 'assets/test/my_folder')
folder_type: AYON folder type: 'Asset', 'Folder', 'Shot', 'Sequence',
'Episode', 'Library' (default: 'Asset')
"""
VALID_TYPES = {"Folder", "Library", "Asset", "Episode", "Sequence", "Shot"}
if folder_type not in VALID_TYPES:
return _err(f"Invalid folder type '{folder_type}'. Must be one of: {', '.join(sorted(VALID_TYPES))}")
try:
folder = client.find_or_create_folder(project, path, folder_type)
return json.dumps({
"name": folder["name"],
"path": folder.get("path"),
"id": folder["id"],
"created": True,
}, indent=2)
except Exception as e:
return _err(str(e))
# ── Publishing Tools ─────────────────────────────────────
@app.tool()
async def ayon_publish_texture_set(
def _publish_product(
project: str,
folder_path: str,
product_name: str,
product_type: str,
representation_name: str,
files_list: list[dict],
variant: str = "",
textures: str = "[]",
) -> str:
"""Publish a texture set (multiple maps) as a single product.
"""Core publish logic — creates product or auto-versions existing one.
Args:
project: Project name (e.g. 'DemoProject')
folder_path: Folder path (e.g. '/assets/chair')
product_name: Base product name (e.g. 'texture_chair')
variant: Optional variant (e.g. 'brown_leather')
textures: JSON array of texture info:
[{"name": "BaseColor.png", "size": 1048576}, ...]
Returns a JSON string with status and details.
The caller decides if this is modelMain or imageMain.
"""
try:
textures_list = json.loads(textures)
folder = client.find_folder(project, folder_path)
if not folder:
return _err(f"Folder '{folder_path}' not found in '{project}'")
@@ -155,10 +179,45 @@ async def ayon_publish_texture_set(
if variant:
full_name = f"{product_name}_{variant}"
# Check if product already exists
existing = client.find_product_by_name(project, folder["id"], full_name)
if existing:
# Product exists — auto-version
last = client.get_last_version(project, existing["id"])
version_num = (last["version"] + 1) if last else 1
version = client.create_version(
project=project,
product_id=existing["id"],
version=version_num,
)
rep = client.create_representation(
project=project,
version_id=version["id"],
name=representation_name,
files=files_list,
)
return _ok(
action="versioned_existing",
product=full_name,
type=product_type,
version=version_num,
existing_product=True,
product_id=existing["id"],
version_id=version["id"],
folder=folder_path,
files=[f["name"] for f in files_list],
note=f"Product '{full_name}' already existed. Created version {version_num}.",
)
else:
# New product
product = client.create_product(
project=project,
name=full_name,
product_type="imageMain",
product_type=product_type,
folder_id=folder["id"],
)
@@ -174,18 +233,55 @@ async def ayon_publish_texture_set(
rep = client.create_representation(
project=project,
version_id=version["id"],
name="texture_set",
files=textures_list,
name=representation_name,
files=files_list,
)
return _ok(
action="created_new",
product=full_name,
type="imageMain",
type=product_type,
version=version_num,
maps=[t["name"] for t in textures_list],
folder=folder_path,
existing_product=False,
product_id=product["id"],
version_id=version["id"],
folder=folder_path,
files=[f["name"] for f in files_list],
note=f"New product '{full_name}' created with version {version_num}.",
)
@app.tool()
async def ayon_publish_texture_set(
project: str,
folder_path: str,
product_name: str,
variant: str = "",
textures: str = "[]",
) -> str:
"""Publish a texture set (multiple maps) as a single product.
If a product with the same name already exists, a new VERSION is created
instead of a duplicate product. The response indicates which happened.
Args:
project: Project name (e.g. 'DemoProject')
folder_path: Folder path (e.g. '/assets/chair' or 'assets/chair')
product_name: Base product name (e.g. 'texture_chair')
variant: Optional variant (e.g. 'brown_leather')
textures: JSON array of texture info:
[{"name": "BaseColor.png", "size": 1048576}, ...]
"""
try:
textures_list = json.loads(textures)
return _publish_product(
project=project,
folder_path=folder_path,
product_name=product_name,
product_type="imageMain",
representation_name="texture_set",
files_list=textures_list,
variant=variant,
)
except Exception as e:
return _err(str(e))
@@ -202,56 +298,33 @@ async def ayon_publish_model(
) -> str:
"""Publish a 3D model (ABC, USD, FBX, etc.).
If a product with the same name already exists, a new VERSION is created
instead of a duplicate product. The response indicates which happened
via the 'action' field ('created_new' or 'versioned_existing').
Args:
project: Project name
folder_path: Folder path (e.g. '/assets/chair')
folder_path: Folder path (e.g. '/assets/chair' or 'assets/chair')
product_name: Product name (e.g. 'modelMain')
model_type: File format: 'abc', 'usd', 'fbx', 'obj', 'blend'
variant: Optional variant (e.g. 'highpoly')
files: JSON array of file info:
[{"name": "chair.abc", "size": 2048000}]
"""
VALID_FORMATS = {"abc", "usd", "fbx", "obj", "blend"}
if model_type not in VALID_FORMATS:
return _err(f"Invalid model type '{model_type}'. Must be one of: {', '.join(sorted(VALID_FORMATS))}")
try:
files_list = json.loads(files)
folder = client.find_folder(project, folder_path)
if not folder:
return _err(f"Folder '{folder_path}' not found")
full_name = product_name
if variant:
full_name = f"{product_name}_{variant}"
product = client.create_product(
return _publish_product(
project=project,
name=full_name,
folder_path=folder_path,
product_name=product_name,
product_type="modelMain",
folder_id=folder["id"],
)
last = client.get_last_version(project, product["id"])
version_num = (last["version"] + 1) if last else 1
version = client.create_version(
project=project,
product_id=product["id"],
version=version_num,
)
rep = client.create_representation(
project=project,
version_id=version["id"],
name=model_type,
files=files_list,
)
return _ok(
product=full_name,
type="modelMain",
format=model_type,
version=version_num,
files=[f["name"] for f in files_list],
folder=folder_path,
representation_name=model_type,
files_list=files_list,
variant=variant,
)
except Exception as e:
return _err(str(e))
@@ -276,7 +349,14 @@ def main():
if not os.environ.get("AYON_KEY"):
print("ERROR: AYON_KEY not set", file=sys.stderr)
sys.exit(1)
app.run()
transport = os.environ.get("AYON_TRANSPORT", "stdio")
if transport == "http":
import uvicorn
port = int(os.environ.get("PORT", "8000"))
uvicorn.run(app.streamable_http_app(), host="0.0.0.0", port=port, log_level="info")
else:
app.run(transport="stdio")
if __name__ == "__main__":