basilensis
c68d6fa33a
The 'a setup CLI ... is coming' line described a concept from the internal auth design doc, not a planned deliverable. Neutral wording: ids are UUIDs; tools work on the personal account without this file.
66 lines
2.4 KiB
Markdown
66 lines
2.4 KiB
Markdown
# Unreal Workbench — Agent Plugin
|
|
|
|
Agent Plugins 1.0.0 distribution package for [Spaghetti Unreal AI Workbench](https://spaghetti.gg) — AI-powered tools for Unreal Engine developers.
|
|
|
|
## What this gives you
|
|
|
|
Connects your AI coding assistant (Claude Code, Cursor, Codex, etc.) to the Unreal AI Workbench MCP server, providing:
|
|
|
|
- **Log Analyzer** (`analyze_logs`) — analyze a UE log file, get structured findings, crash triage, and recommended fixes
|
|
- **Asset Janitor** (`tidy_assets`) — audit naming conventions, find unused assets, check LODs
|
|
- **Research tools** (free) — search curated UE engine documentation, known engine patterns, and your project's ingested logs
|
|
- **Tool-Maker** (`make_tool`) — generate safe Python scripts for UE editor automation, billed only on approval
|
|
|
|
## Install
|
|
|
|
```bash
|
|
# Universal installer (detects Claude Code, Cursor, Codex, VS Code, etc.)
|
|
npx plugins add Tinirau/unreal-workbench
|
|
|
|
# Dry-run to inspect before installing
|
|
npx plugins discover Tinirau/unreal-workbench
|
|
|
|
# Or, in Claude Code:
|
|
/plugin marketplace add Tinirau/unreal-workbench
|
|
```
|
|
|
|
## Authentication
|
|
|
|
Sign in once at [spaghetti.gg](https://spaghetti.gg) — your account is created on first sign-in, with welcome credits. On first connect, your client opens a browser to sign in via OAuth. No API keys to configure — the OAuth flow is handled entirely by your client.
|
|
|
|
## Project context (optional)
|
|
|
|
Your UE5 project can have a `.spaghetti` file at its root:
|
|
|
|
```json
|
|
{
|
|
"team_id": "your-team-uuid",
|
|
"project_id": "your-project-uuid"
|
|
}
|
|
```
|
|
|
|
Team and project ids are UUIDs. All tools also work on your personal account without this file. The file is safe to commit to Git/Perforce (no secrets).
|
|
|
|
## Structure
|
|
|
|
```
|
|
unreal-workbench/
|
|
├── plugin.json # Agent Plugins 1.0.0 manifest
|
|
├── mcp.json # streamable-http → mcp.spaghetti.gg (OAuth, no embedded secrets)
|
|
├── skills/
|
|
│ └── ue5-unreal/
|
|
│ └── SKILL.md # AI-facing instructions: when/how to call each tool
|
|
├── LICENSE
|
|
└── README.md
|
|
```
|
|
|
|
## Requirements
|
|
|
|
- An AI client that supports [Agent Plugins 1.0.0](https://agent-plugins.org) (Claude Code, Cursor, OpenAI Codex, etc.)
|
|
- A Spaghetti account — [sign in](https://spaghetti.gg) (created on first sign-in)
|
|
- UE 5.8+ for the editor connector plugin; the cloud tools work with any engine version's logs and inventories
|
|
|
|
## License
|
|
|
|
MIT © Tinirau Ltd
|