Union Unity MCP Server

# Contributing to Union First off, thank you for considering contributing to the Union - The Unity MCP Server! We welcome any type of contribution, from reporting bugs and suggesting enhancements to improving documentation and submitting new features. ## Guiding Principles - Today's LLMs excel at code generation. The best way to interface with external tools is to interact through code over data when possible. - Fewer flexible tools over many specific tools. Every registered tool eats context. - Stay in C# as much as possible. This will make contributions more accessible to Unity developers. - Describe how to use the tool but not when to use the tool — unless there is a hard sequencing dependency. This leaves control in the user's hands. - Test exhaustively. LLMs provide more than enough unreliability to go around. ## Getting Started To develop locally, fork the Union repository and clone it in your local machine. The Unity MCP Server repo is a monorepo with several packages inside the `packages` directory: `node-runner`: A nodejs script which automatically installs the Unity package in the project and then runs it - sanitizing the stdout. `unity`: A Unity C# package containing actual MCP server logic w/ the tools To develop and test the `node-runner` package: 1. Run `npm i`. 2. Run `npm run dev --ws`. To develop and test the `unity` package: 1. Create or choose a Unity project to develop with outside the repository. 2. Configure the mcp server via `mcp.json` and add an additional `-dev` argument. This will run your MCP server with a reference to the package in your local checkout that is editable. When you commit your work, husky will run a pre-commit hook and lint your code. ### Commit Messages We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) style to keep the commit history clean and readable. For example: `feat(tools): add support for custom camera in screenshot tool` ## Submitting Your Changes 1. Push your changes to your forked repository: `git push origin my-feature-branch`. 2. Open a pull request on the main repository. 3. In your pull request description, please explain the changes you made and why. 4. We will review your pull request as soon as possible. We may suggest some changes or improvements. ## Reporting Bugs If you find a bug, please open an issue on GitHub. Please include the following information in your bug report: - A clear and descriptive title. - A detailed description of the bug. - Steps to reproduce the bug. - Your operating system, Unity version, and any other relevant environment information. - Any error messages or logs. ## Suggesting Enhancements If you have an idea for a new feature or an improvement to an existing one, please open an issue on GitHub. Please include the following information in your enhancement suggestion: - A clear and descriptive title. - A detailed description of the proposed enhancement. - Any mockups, examples, or links that might be helpful. ## Code of Conduct This project and everyone participating in it is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior. (Note: A `CODE_OF_CONDUCT.md` file will need to be created). Thank you again for your contribution! ## Adding New Tools Union operates on the principle of a minimum set of highly flexible tools. `execute_code` can handle just about any mutation to a Unity project. If the context you want to add is small and frequently needed, consider adding it to the `get_state` tool response instead of creating a new tool. If you want to enable a specific workflow, consider contributing a rules file in `rules`.