Skip to content

Search is only available in production builds. Try building and previewing the site to test it out locally.

Overview

platform-mcp exposes the public customer API as tools an editor or agent can call. It registers compute, storage, image, network, catalog, operations, and IAM list/check tools, plus a hand-written healthz. Catalog-admin and migration/drain tools are omitted from the default server (ADR-0003).

ToolWhat it does
healthzCheck that the API is up
platform_v1_ComputeService_ListInstancesList compute instances
platform_v1_CatalogService_ListInstanceTypesList instance types
platform_v1_StorageService_ListVolumesList storage volumes
platform_v1_OperationService_ListOperationsList long-running operations
platform_v1_IamService_CheckPermissionCheck a permission

Every generated tool is on the reference.

Terminal window
export PLATFORM_GRPC=127.0.0.1:9090
export PLATFORM_REST=http://cloud-api.localhost

On a local apiserver without compose, use PLATFORM_REST=http://127.0.0.1:8080.

Optional config file: ~/.platform/config.json (endpoint, rest_endpoint, app, token). PLATFORM_GRPC, PLATFORM_REST, PLATFORM_APP and PLATFORM_TOKEN override what the file holds.

If you set nothing: gRPC 127.0.0.1:9090, REST http://127.0.0.1:8080, app app_default.

Cursor (~/.cursor/mcp.json or .cursor/mcp.json in a project):

{
"mcpServers": {
"platform": {
"command": "platform-mcp",
"env": {
"PLATFORM_GRPC": "127.0.0.1:9090",
"PLATFORM_REST": "http://cloud-api.localhost"
}
}
}
}

Claude Desktop (claude_desktop_config.json):

{
"mcpServers": {
"platform": {
"command": "platform-mcp",
"env": {
"PLATFORM_GRPC": "127.0.0.1:9090",
"PLATFORM_REST": "http://cloud-api.localhost"
}
}
}
}

VS Code (mcp.json):

{
"servers": {
"platform": {
"type": "stdio",
"command": "platform-mcp",
"env": {
"PLATFORM_GRPC": "127.0.0.1:9090",
"PLATFORM_REST": "http://cloud-api.localhost"
}
}
}
}

Put platform-mcp on your PATH, or use the full path to the binary as command.

Install or download a binary. See every tool on the reference.