Unity-AI-Tools-Template

Unity-AI-Tools-Template is a starter MCP (Model Context Protocol) toolkit designed to help you create custom MCP tools for Unity. The repository provides a guided workflow to generate a Unity package with Editor and Runtime MCP tool types, along with detailed instructions for packaging, versioning, and distribution. The template focuses on enabling you to build tools that can interact with Unity's Editor and, where applicable, run within a game build. Tools you add follow the MCP pattern described in the accompanying docs, including how to expose inputs, descriptions, and asynchronous processing that can be coordinated with LLM-backed workflows.

Once you’ve customized the template, you can generate the necessary meta files, configure the package.json metadata, and integrate your own MCP tool logic (e.g., editor-side utilities, runtime features, or sample scripts) into the Unity-Package/Assets/root structure. The template demonstrates how to structure Editor vs Runtime MCP tools, including how to mark tool types, descriptions, and input parameters, so your LLM prompts can interact with them in predictable ways. The end result is a Unity package that can be distributed through your preferred registry (e.g., OpenUPM, GitHub) and installed into Unity projects.

To use the tools effectively, replace the sample code with your own tool implementations, update the package.json for description, author, and Unity version, and follow the steps to generate .meta files so Unity recognizes assets correctly. The workflow also covers version bumps, CI/CD integration, and how to organize the Unity package root to ensure clean distribution and installation across Unity projects.

Prerequisites:

• Unity Editor (compatible version per your project)
• Git and a supported shell (PowerShell on Windows, Bash on macOS/Linux)
• Basic familiarity with Unity packaging and the MCP workflow described in the template’s docs

Installation steps:

1. Clone the repository or download the template package.
2. Initialize and rename the package to your own brand:
   • Run the initialization script (example for PowerShell) from the repository root: ./commands/init.ps1 -PackageId "com.company.package" -PackageName "My Package" This renames directories/files and replaces placeholders like YOUR_PACKAGE_ID and YOUR_PACKAGE_NAME.
3. Update package metadata:
   • Open Unity-Package/Assets/root/package.json and update fields such as description, author, keywords, and unity (minimum Unity version).
4. Generate meta files:
   • Add the Installer and Unity-Package folders to a Unity project via Unity Hub to generate .meta files, or open the projects directly in Unity Editor.
5. Create and add MCP tools:
   • Implement your Editor MCP tool under Unity-Package/Assets/root/Editor
   • Or implement your Runtime MCP tool under Unity-Package/Assets/root/Runtime
   • Use the example MCP plugin attributes as a guide for wiring up tools and descriptions.
6. Bump versions and set up CI/CD (optional):
   • Use the provided scripts to bump versions and configure workflows as needed: .\commands\bump-version.ps1 -NewVersion "1.0.1" (PowerShell)
7. Distribute your package:
   • Package can be deployed via OpenUPM, GitHub, or npmjs according to your preferred distribution channel (aligned with the final polishing steps in the template).

Notes:

• Ensure you commit the updated Unity-Package/Assets/root folder contents, as only files inside root are included in the final package.
• Follow the template’s guidance for Editor vs Runtime MCP tools to match Unity deployment expectations.

Tips and common considerations:

• Plan your MCP tool type (Editor vs Runtime) early, as it impacts where you place code (Editor folder vs Runtime folder) and what Unity APIs you can access.
• When generating .meta files, make sure to open both the Installer and Unity-Package projects in Unity Editor to ensure all assets acquire proper metas.
• Maintain clear descriptions and input parameter descriptions for your MCP tools to help LLMs understand how to interact with them.
• If you plan CI/CD, configure Unity license management secrets (UNITY_EMAIL, UNITY_PASSWORD, UNITY_LICENSE) as described in the template’s CI setup notes.
• Keep your package.json in Unity-Package/Assets/root up to date with unity version compatibility and keywords to improve discoverability when distributed.
• Verify distribution by installing the package into a clean Unity project to ensure all assets and meta files resolve correctly.