Mimir MCP

Mimir MCP is an open-source Unity framework for crafting bespoke Model Context Protocol surfaces that describe your gameplay APIs, not your editor UI. It gives you the primitives to define how an agent perceives and manipulates your live world—tools, schemas, threading model, networking—so you can expose just enough control for safe automation inside a running build. Drop it into a scene, wire up toolsets that mirror your gameplay verbs, and your MCP-aware agent can pilot the experience through the same systems players touch.

About The Framework

• Embedded MCP host – the MCPHost component spins up a lightweight HttpListener directly inside your scene (Editor or Player builds) and routes requests to registered tool handlers.
• Unity-first execution – incoming calls are marshalled back to the Unity main thread before they touch your objects, so you can safely mutate scene data without writing extra plumbing.
• Composable tooling – every capability is a small MCPToolBase implementation. You can enable a prebuilt toolset, mix and match sets, or add your own tools with a couple of attributes and one async override.

Installation (Git Package)

Prerequisites

Before installing Mimir MCP, ensure you have the following packages installed in your Unity project:

1. Newtonsoft JSON for Unity - Required for JSON serialization

   • Open Window > Package Manager > + > Add package from git URL...
   • Paste: com.unity.nuget.newtonsoft-json@3.2.1
   • Click Add

2. UniTask - Required for async/await support

   • Follow the installation instructions at: https://github.com/Cysharp/UniTask#install-via-git-url
   • This package requires OpenUPM registry setup

Installation Steps

1. Open your target Unity project.
2. Go to Window ▸ Package Manager ▸ + ▸ Add package from Git URL…
3. Paste https://github.com/dhruv304c2/mimir-mcp.git?path=/Assets/MimirMCP and confirm.
4. Verify that both prerequisite packages (Newtonsoft JSON and UniTask) are installed before proceeding.
5. Enter Play Mode once to let Unity generate asmdef caches. You now have the runtime in your project and can add the host behaviour to any scene.

Getting Started In Unity

1. Create a Host GameObject – add the MCPHostBehaviour prefab/script (or a small MonoBehaviour that holds an MCPHost) to your scene.
2. Configure networking – set the host and port fields (defaults are localhost:3000).
3. Register toolsets – in Start, grab the handler and opt into the helpers you need:

   void Start()
   {
       _mcpHandler = new MCPHandler(logger: new UnityLogger())
           .UseDefaultToolSet(); // or chain specific Use*ToolSet calls
   
       _mcpHost = new MCPHost(port: 3000);
       _mcpHost.SetLogger(new UnityLogger());
       _mcpHost.RegisterDefaultHandlers();
       _mcpHost.UseMCPHandler(_mcpHandler);
       _mcpHost.StartHTTPServer();
   }
   

4. Run the scene – when you hit Play you should see Hosting server at localhost:3000 in the console. The host automatically stops when the behaviour is destroyed, but you can call StopHTTPServer manually if needed.
5. Add custom tools (optional) – derive from MCPToolBase, decorate fields/properties with [MCPToolParam], implement ExecuteTool(IReadOnlyDictionary<string, object>), then register the tool before calling StartHTTPServer.

Built-In Toolsets & Tools

Pick the helper that matches the control surface you want to expose. You can call multiple helpers or register additional bespoke tools to build a curated API surface for your team or automated agents.

Database Abstraction

MimirMCP includes a powerful database abstraction system for exposing Unity scene objects to MCP tools. This allows AI agents to query and interact with collections of MonoBehaviours in your scene.

Core Concepts

The database system consists of several key interfaces and classes:

• IMCPDatabaseItem – Interface for objects that can be stored in a database. Requires an ObjectId property and ToJson() method.
• MCPMonoBehaviourDatabaseItem – Base MonoBehaviour class that implements IMCPDatabaseItem with automatic JSON serialization.
• IMCPDatabase<T> – Generic interface for type-safe database operations (add, get, remove items).
• IMCPScannableDatabase<T> – Extended interface that supports configurable read strategies through ReadFunction.
• MCPMonoBehaviourDatabase<T> – Flexible implementation that can populate from any source:
  • Unity scene scanning via SetReadFromSceneHierarchy()
  • Custom data sources via ReadFunction delegate
• MCPHost.RegisterDatabase<T> – Registers a database and automatically creates an MCP tool for reading it.

Basic Usage

1. Create a database item class:

   using MimirMCP.Core.Database;
   using UnityEngine;
   
   public class Character : MCPMonoBehaviourDatabaseItem
   {
       [SerializeField]
       public string characterName;
   
       [SerializeField]
       [TextArea]
       public string description;
   }
   

2. Register the database with MCPHost:

   // Method 1: Using the convenience factory method (for MonoBehaviours)
   var characterDb = MCPMonoBehaviourDatabase<Character>.CreateFromScene();
   _mcpHost.RegisterDatabase("characters", characterDb);
   
   // Method 2: Manual configuration with custom options
   var characterDb = new MCPMonoBehaviourDatabase<Character>();
   characterDb.SetReadFromSceneHierarchy(
       sortMode: FindObjectsSortMode.InstanceID,
       includeInactive: true
   );
   characterDb.Read();
   _mcpHost.RegisterDatabase("characters", characterDb);
   
   // Method 3: Custom read function (for non-MonoBehaviour types or custom sources)
   var itemDb = new MCPMonoBehaviourDatabase<InventoryItem>();
   itemDb.ReadFunction = () => {
       // Custom logic to populate database from any source
       itemDb.AddItem(new InventoryItem { name = "Sword" });
       itemDb.AddItem(new InventoryItem { name = "Shield" });
   };
   itemDb.Read();
   _mcpHost.RegisterDatabase("inventory", itemDb);
   

   This automatically creates a tool named read_characters_database that AI agents can use.

3. Retrieve items programmatically:

   // Get the database
   var db = _mcpHost.GetDatabase<Character>();
   
   // Get a specific item by ID
   var character = db.GetItemById(objectId);
   
   // Get all items
   var allCharacters = db.All();
   

MCP Tool Usage

When you register a database, a corresponding MCP tool is automatically created. For the example above:

• Tool name: read_characters_database
• Parameters:
  • object_id (optional) – Retrieve a specific item by its ID
• Returns: JSON representation of the item(s)

Example tool call to get all characters:

{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "tools/call",
  "params": {
    "tool_name": "read_characters_database",
    "arguments": {}
  }
}

Example tool call to get a specific character:

{
  "jsonrpc": "2.0",
  "id": "2",
  "method": "tools/call",
  "params": {
    "tool_name": "read_characters_database",
    "arguments": {
      "object_id": "12345-6789-abcd-efgh"
    }
  }
}

Advanced Features

Custom Read Functions: The database system supports flexible read strategies through the ReadFunction property:

// Read from a JSON file
database.ReadFunction = () => {
    var json = File.ReadAllText("data/characters.json");
    var items = JsonConvert.DeserializeObject<List<Character>>(json);
    foreach (var item in items) {
        database.AddItem(item);
    }
};

// Read from a web service
database.ReadFunction = async () => {
    var response = await httpClient.GetStringAsync("https://api.example.com/characters");
    // Parse and add items...
};

// Combine multiple sources
database.ReadFunction = () => {
    // First read from scene
    database.SetReadFromSceneHierarchy();
    database.Read();

    // Then add items from other sources
    database.AddItem(specialCharacter);
};

Multiple Databases:

// Register multiple database types
_mcpHost.RegisterDatabase("characters", MCPMonoBehaviourDatabase<Character>.CreateFromScene());
_mcpHost.RegisterDatabase("locations", MCPMonoBehaviourDatabase<Location>.CreateFromScene());
_mcpHost.RegisterDatabase("items", new MCPMonoBehaviourDatabase<InventoryItem> {
    ReadFunction = LoadInventoryFromSaveGame
});

Thread Safety: All database operations are thread-safe using reader-writer locks, allowing safe concurrent access from MCP tool calls.

Best Practices

1. Configure read strategy appropriately – Use SetReadFromSceneHierarchy() for scene objects, or set a custom ReadFunction for other data sources.
2. Use meaningful names – The database name becomes part of the MCP tool name (e.g., "characters" → "read_characters_database").
3. Keep items lightweight – The ToJson() method is called frequently, so avoid expensive serialization.
4. One type per database – Each Type can only have one registered database in MCPHost.

Calling The Hosted MCP API

Once the host is running you interact with it over HTTP. All paths are rooted at the host/port you configured.

• GET / – simple health probe. Example response:

  { "message": "Service is healthy" }
  

• GET /mcp – discovery ping that confirms the MCP endpoint exists:

  { "message": "Mimir-MCP endpoint ready at /mcp (POST for MCP RPC)." }
  

• POST /mcp – JSON-RPC style MCP endpoint. The body follows the MCP spec and supports the standard methods shown below:
  • initialize – negotiate protocol version.
  • ping – keep-alive.
  • tools/list – enumerate every registered tool and the schema built from your MCPToolParam attributes.
  • tools/call – invoke a tool by name with arguments.

Example tools/list request/response:

curl -X POST http://localhost:3000/mcp \
  -H "Content-Type: application/json" \
  -d '{
        "jsonrpc": "2.0",
        "id": "list-1",
        "method": "tools/list",
        "params": {}
      }'

Response (truncated):

{
  "jsonrpc": "2.0",
  "id": "list-1",
  "result": {
    "tools": [
      {
        "name": "log",
        "description": "A tool to log messages to the Unity console via MCP.",
        "inputSchema": {
          "properties": {
            "message": { "type": "string" },
            "level": { "type": "string" }
          },
          "required": ["message"]
        }
      }
    ]
  }
}

Example tools/call to run the log tool:

curl -X POST http://localhost:3000/mcp \
  -H "Content-Type: application/json" \
  -d '{
        "jsonrpc": "2.0",
        "id": "call-1",
        "method": "tools/call",
        "params": {
          "tool_name": "log",
          "arguments": {
            "message": "Hello from MCP!",
            "level": "warning"
          }
        }
      }'

Typical success payload:

{
  "jsonrpc": "2.0",
  "id": "call-1",
  "result": {
    "content": [
      { "type": "text", "text": "Logged message as Warning level." }
    ]
  }
}

Swap tool_name and arguments to target any other built-in or custom tool.

Error Handling

Mimir MCP automatically catches any exception thrown from your ExecuteTool implementation and returns it as an MCP-compliant error response. You never need to worry about error codes or response formatting — just throw standard C# exceptions.

How It Works

When ExecuteTool throws, the framework catches the exception and returns a JSON-RPC protocol error that MCP clients (including Google ADK) recognize and surface to the agent:

{
  "jsonrpc": "2.0",
  "id": "call-1",
  "error": {
    "code": -32602,
    "message": "Transform 'NonExistent/Path' was not found."
  }
}

The agent framework sees the error at the transport layer and reports the failure to the LLM, which can then adapt (retry with different arguments, call a different tool, etc.).

Which Exception to Throw

Use the standard C# exception that semantically matches the failure. The framework maps each exception type to a JSON-RPC error code:

Example

[MCPTool(toolName: "my_tool", description: "Does something cool.")]
public class MyTool : MCPToolBase
{
    [MCPToolParam("target", "Path to the target object.", MCPToolParam.ParamType.String, true)]
    public string Target;

    protected override UniTask<ContentBase[]> ExecuteTool(
        IReadOnlyDictionary<string, object> rawParameters)
    {
        if (string.IsNullOrWhiteSpace(Target))
            throw new ArgumentException("target is required.");

        var scene = SceneManager.GetActiveScene();
        if (!scene.IsValid())
            throw new InvalidOperationException("No active scene.");

        var go = GameObject.Find(Target);
        if (go == null)
            throw new KeyNotFoundException($"GameObject '{Target}' not found.");

        // Do work...
        return UniTask.FromResult(new ContentBase[] { new ContentText("Done.") });
    }
}

Error Response Layers

All errors are protocol-level JSON-RPC errors. This ensures MCP clients (including Google ADK) reliably surface failures to the agent, regardless of whether they support the isError content flag.

Inspiration

Mimir takes its name from the disembodied sage who accompanies Kratos in God of War: a sharp, non-intrusive guide whose counsel empowers the hero without seizing the controller. This framework aims for the same balance. It gives your agent the knowledge and entry points it needs to advise—or even act—inside your game, while you stay in charge of the narrative surface you expose.

License

Mimir MCP is available under the MIT License. See LICENSE for details.