Mia-Platform Console MCP Server

Mia-Platform Console MCP Server

简介

Mia-Platform Console MCP Server 是一个 模型上下文协议（MCP） 服务，可与 Mia-Platform Console API 无缝集成，为开发者和工具提供高级自动化与交互能力。

前提条件

若要在客户端（例如 Visual Studio Code、Claude Desktop、Cursor、Gemini CLI 等）中使用 Mia-Platform Console MCP Server，首先需要在要与之通信的 Mia-Platform Console 实例上拥有有效账户。你还需要在名为 CONSOLE_HOST 的环境变量中设置实例的主机地址。

你可以选择以下方式访问：

• 使用 Service Account 执行机器间身份验证，并获得 MCP 功能的完整访问权限，从而在创建该 Service Account 的 Company 上执行操作（更多信息请参阅关于如何创建 Mia-Platform Service Account 的官方文档）。如果选择此方式，需要设置环境变量 MIA_PLATFORM_CLIENT_ID 和 MIA_PLATFORM_CLIENT_SECRET。
• 使用自己的凭据：Mia-Platform Console MCP Server 遵循 Model Context Protocol 的身份验证规范，使用 OAuth2.1 和 Dynamic Client Registration。遵循该规范的客户端能够发现你要访问的 Mia-Platform 实例的身份验证端点，并引导你完成登录。

如何运行

你可以使用 Docker 运行稳定版 Mia-Platform Console MCP Server。详细指南请参阅 Mia-Platform 文档中的相关页面。

如果没有安装 Docker，或者只想在本地运行，可以使用 NPM 和 Node.js。克隆项目后，运行以下命令：

npm ci
npm run build

这些命令会安装所有依赖项，然后将 TypeScript 代码转译到 build 文件夹中。

NOTE

如果项目根目录中存在 .env 文件，服务会自动从中加载环境变量。 你可以将 default.env 复制为 .env，并根据需要更新其中的值。

完成这些步骤后，你可以使用 node 命令设置 MCP 服务，如下所示：

{
  "mcp": {
    "servers": {
      "mia-platform-console": {
        "command": "node",
        "args": [
          "${workspaceFolder}/mcp-server",
          "start",
          "--stdio",
          "--host=https://console.cloud.mia-platform.eu"
        ]
      }
    }
  }
}

TIP

也可以在构建完成后使用以下命令启动服务：

node mcp-server start

然后，只需在客户端中添加 MCP 服务并填入 URL。以下是 VS Code 的示例：

{
  "mcp": {
    "servers": {
      "mia-platform-console": {
        "type": "http",
        "url": "http://localhost:3000/console-mcp-server/mcp"
      }
    }
  }
}

请将 3000 替换为环境变量 PORT 中定义的端口。更多详情请参阅环境变量部分。

环境变量

名为 .env 的文件中的环境变量会在服务启动时自动加载。

变量名称	描述	必填	默认值
LOG_LEVEL	应用的日志级别	否	info
PORT	HTTP 服务的端口号	否	3000
CONSOLE_HOST	Mia-Platform Console 实例的主机地址	是	-
MIA_PLATFORM_CLIENT_ID	用于 Service Account 身份验证的客户端 ID	否	-
MIA_PLATFORM_CLIENT_SECRET	用于 Service Account 身份验证的客户端密钥	否	-
CLIENT_EXPIRY_DURATION	使用 DCR 身份验证流程生成的客户端有效时长（秒）。超过此时间后，客户端将过期且无法继续使用。	否	300

本地开发

要协助开发此服务，你需要在计算机上安装 Node.js。
建议使用 nvm 或 mise 等版本管理器。

使用 .nvmrc 文件中声明的正确 Node.js 版本配置好环境后，你可以运行以下命令：

npm ci

完成后，项目的所有依赖项都会安装完毕。接下来，你需要复制默认的 default.env 文件并进行相应编辑，以准备环境文件。

cp default.env .env

最后，运行以下命令验证一切是否正常：

npm run local:test

如果你的目标不是安装 Console Cloud，可以使用 --host 标志并指定自己的主机。

npm run local:test  -- --host https://CONSOLE_HOST

此命令会下载并启动 MCP inspector，地址为 http://localhost:6274。你可以在其中测试实现是否正常工作，通过测试工具和提示词的发现功能，无需可用的大模型环境。

要测试新的实现，可以运行：

npm test

或者，要测试单个文件，可以运行：

node --test --import tsx <FILE_PATH>