@uemcp/server 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 odinn1984
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,111 @@
+# `mcp-server`
+
+A TypeScript MCP server built on the official `@modelcontextprotocol/sdk`.
+
+## Overview
+
+This project is the MCP-facing side of the monorepo. It uses stdio for MCP transport and is meant to expose MCP tools that call into the Unreal Editor bridge over localhost HTTP.
+
+The local registry API currently exposes:
+
+- `GET /ping`
+- `PUT /projects/:projectId`
+- `DELETE /projects/:projectId`
+
+The MCP tool surface currently exposes:
+
+- `get_project_id`
+- `add_module`
+- `ping_project`
+- `build_target`
+- `generate_project_files`
+- `clean_build`
+- `run_clang_tidy`
+
+## Project Identity
+
+Engine identity is derived from the Unreal project's `Config/DefaultGame.ini` file, specifically:
+
+```ini
+[/Script/EngineSettings.GeneralProjectSettings]
+ProjectID=E8AD341D43B90136652AFFA4D93F17B4
+```
+
+`PUT /projects/:projectId` no longer trusts a caller-provided ID by shape alone. The server resolves `Config/DefaultGame.ini` from the submitted `projectPath`, extracts `ProjectID`, normalizes it to the canonical 32-character lowercase form, and rejects the registration if the route `projectId` does not match.
+
+If `DefaultGame.ini` cannot be read, if the section is missing, or if the `ProjectID` key is missing or invalid, the server logs the resolved file path plus the failure reason and rejects the dependent operation. There is no fallback ID generation.
+
+## MCP Tools
+
+### `get_project_id`
+
+- Accepts a project path from the MCP caller
+- Derives `Config/DefaultGame.ini`
+- Reads `[/Script/EngineSettings.GeneralProjectSettings]`
+- Returns the canonical `projectId`
+- Does not consult the in-memory registry
+
+This is intended to let an MCP client resolve the canonical Unreal project identity from a known path before calling tools that require that ID.
+
+### `add_module`
+
+- Accepts a `descriptorPath` (a `.uproject` or `.uplugin`) and a `moduleName`
+- Scaffolds `Source/<moduleName>/` next to the descriptor: `<moduleName>.Build.cs`, `Public/<moduleName>.h`, and `Private/<moduleName>.cpp` with `IMPLEMENT_MODULE`
+- Registers the module in the descriptor's `Modules` array (`Type` defaults to `Runtime`, `LoadingPhase` to `Default`)
+- Refuses to overwrite an existing module name or `Source/<moduleName>` directory
+- Pure filesystem scaffold; it does not consult the registry or a running editor. Run project-file generation and a build afterward to compile the module.
+
+### `ping_project`
+
+- Accepts a canonical `projectId`
+- Looks up the registered Unreal engine bridge in memory
+- Pings the bridge over localhost HTTP
+- Retries with named constants:
+  - `maxRetries = 3`
+  - `initialDelayMs = 500`
+  - `retryMultiplier = 2.0`
+- Uses retry delays of approximately `500ms`, `1s`, and `2s`
+- Removes the stale registration from memory and persists the cleanup if the bridge remains dead after retries
+
+### `build_target` / `generate_project_files` / `clean_build`
+
+- Resolve the engine from the `.uproject` `EngineAssociation` (or an explicit `engineVersion`) under `UE_INSTALLS_DIR`
+- Spawn `UnrealBuildTool` as a child process: on macOS/Linux the engine-bundled `dotnet` runs the UBT `.dll` (falling back to `dotnet` on `PATH` if the bundle is absent); on Windows the `.exe` runs directly
+- `build_target` returns pass/fail plus parsed error/warning diagnostics; `clean_build` adds `-Clean`; `generate_project_files` runs `-Mode=GenerateProjectFiles`
+- `build_target`/`clean_build` refuse to run when the project's editor is registered and reachable (link conflicts on Windows, ignored output on macOS/Linux) — pass `force: true` to override
+- Do not require a running editor
+
+### `run_clang_tidy`
+
+- Reads the synced `compile_commands.json` from the provided `compileCommandsDir`
+- Spawns `clang-tidy` (server-configured via `CLANG_TIDY_PATH`, else `PATH`) over the translation units and returns structured findings (file, line, column, check, severity, message)
+- Report only — does not apply fixes
+
+## Configuration
+
+- Engine toolchain (`build_target`, `generate_project_files`, `clean_build`):
+  - `UE_INSTALLS_DIR` — base directory holding installed engines (`UE_<version>`)
+- `run_clang_tidy`:
+  - `CLANG_TIDY_PATH` — optional clang-tidy binary override
+- Local HTTP registry API:
+  - `MCP_SERVER_HTTP_HOST`
+  - `MCP_SERVER_HTTP_PORT`
+- Logging:
+  - `MCP_SERVER_LOG_LEVEL`
+  - `MCP_SERVER_LOG_FORMAT`
+
+## Install
+
+```bash
+npm install
+```
+
+## Run
+
+```bash
+npm run dev
+npm run lint:fix
+npm run typecheck
+npm run build
+npm start
+```

package/dist/index.d.mts

@@ -0,0 +1 @@
+export {}