Console MCP Server

🚀 Mia-Platform Console MCP Server

The Mia-Platform Console MCP Server is a Model Context Protocol (MCP) server that offers seamless integration with the Mia-Platform Console API. It enables developers and tools to implement advanced automation and interactive features.

🚀 Quick Start

Before using the Mia-Platform Console MCP Server, ensure you meet the following prerequisites:

Prerequisites

1. To run the server in a container, you need to install Docker.
2. After installing Docker, make sure Docker is running.
3. Finally, you need to Create a Mia-Platform service account. Currently, the only supported authentication method is Client Secret Basic.

📦 Installation

VS Code

When installing manually, add the following JSON block to your user settings (JSON) file. You can do this by pressing Ctrl + Shift + P and entering Preferences: Open User Settings (JSON). You can also add it to the .vscode/mcp.json file in your workspace.

After that, switch the proxy mode (located next to the Copilot chat text input), and the server will start.

⚠️ Important Note

The mcp key is not required in the .vscode/mcp.json file.

Additionally, you can change the host of the console instance to your custom installation.

{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "mia_client_id",
        "description": "Mia-Platform Client ID",
        "password": false
      },
      {
        "type": "promptString",
        "id": "mia_client_secret",
        "description": "Mia-Platform Client Secret",
        "password": true
      }
    ],
    "servers": {
      "mia-platform-console": {
        "command": "docker",
        "args": [
          "run",
          "-i",
          "--rm",
          "-e",
          "MIA_PLATFORM_CLIENT_ID",
          "-e",
          "MIA_PLATFORM_CLIENT_SECRET",
          "ghcr.io/mia-platform/console-mcp-server",
          "https://docs.mia-platform.eu/docs/development_suite/identity-and-access-management/manage-service-accounts"
        ]
      }
    }
  }
}

Claude Desktop

In Claude Desktop, you can directly add the following content to the mcp.json file:

{
  "mia-platform-console": {
    "command": "docker",
    "args": [
      "run",
      "-i",
      "--rm",
      "-e",
      "MIA_PLATFORM_CLIENT_ID=${INPUT}",
      "-e",
      "MIA_PLATFORM_CLIENT_SECRET=${INPUT_SEC}",
      "ghcr.io/mia-platform/console-mcp-server"
    ],
    "env": {
      "MIA_PLATFORM_CLIENT_ID": {
        "description": "Your Mia-Platform Client ID",
        "required": true
      },
      "MIA_PLATFORM_CLIENT_SECRET": {
        "description": "Your Mia-Platform Client Secret",
        "required": true
      }
    }
  }
}

💻 Usage Examples

Local Development

To run the server, you can use the following command:

npm install

When debugging new implementations, you can run the test environment locally:

npm run local

To run unit tests, execute:

npm test

Alternatively, run tests for a single file:

node --test --import tsx <FILE_PATH>

📄 License