Skip to main content
Glama

get_unreal_project_path

Retrieve the file path of an active Unreal Engine project for integration with development tools.

Instructions

Get the current Unreal Project path

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Registration of the 'get_unreal_project_path' tool with inline handler. The handler checks if projectPath is set and returns it formatted as text content, or throws an error if not set.
    server.tool("get_unreal_project_path", "Get the current Unreal Project path", async () => {
    	if (!projectPath) {
    		throw new Error("Unreal Project path is not set")
    	}
    
    	return {
    		content: [
    			{
    				type: "text",
    				text: `Unreal Project path: ${projectPath}`,
    			},
    		],
    	}
    })
  • The async handler function that implements the tool logic: returns the Unreal project path if available.
    server.tool("get_unreal_project_path", "Get the current Unreal Project path", async () => {
    	if (!projectPath) {
    		throw new Error("Unreal Project path is not set")
    	}
    
    	return {
    		content: [
    			{
    				type: "text",
    				text: `Unreal Project path: ${projectPath}`,
    			},
    		],
    	}
    })
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool retrieves a path but doesn't clarify if this is a read-only operation, what format the path returns (e.g., absolute vs. relative), or any error conditions (e.g., if no project is loaded). This leaves significant gaps for an agent to understand the tool's behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the tool's purpose without any wasted words. It is appropriately sized and front-loaded, making it easy for an agent to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the lack of annotations and output schema, the description is incomplete. It doesn't specify the return value format (e.g., string path), error handling, or dependencies like requiring an active Unreal project. For a tool with no structured behavioral data, more context is needed to ensure reliable agent usage.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has 0 parameters, and the input schema has 100% description coverage (though it's empty). The description doesn't need to explain parameters, so it meets the baseline for a parameterless tool. No additional parameter information is required or provided.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose with a specific verb ('Get') and resource ('current Unreal Project path'), making it immediately understandable. However, it doesn't differentiate from its sibling 'get_unreal_engine_path' or other path-related tools, which prevents a perfect score.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives like 'get_unreal_engine_path' or 'editor_project_info'. It lacks context about prerequisites, such as whether an Unreal project must be open, or any exclusions for its use.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/runreal/unreal-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server