Skip to main content

MCP server (uigraph-mcp)

The MCP server is optional. It is not part of the compose stack; it ships as the uigraph/uigraph-mcp image and is run separately. When you deploy it, give it these variables. The four URLs are required and have no defaults; the server exits if any is missing.

VariableRequiredDescription
UIGRAPH_API_URLYesIn-network base URL of uigraph-api (e.g. http://uigraph-api:8080).
UIGRAPH_GATEWAY_URLYesIn-network base URL of uigraph-gateway (e.g. http://uigraph-gateway:8080), used to convert diagrams to Mermaid.
UIGRAPH_FRONTEND_URLYesBase URL of the UIGraph frontend, used for the login broker.
UIGRAPH_MCP_PUBLIC_URLYesPublic base URL of this MCP server, used to build the auth callback.
PORTNoHTTP listen port. Defaults to 8080.
MCP_SERVER_NAMENoMCP server name. Defaults to uigraph-mcp.
MCP_SERVER_VERSIONNoMCP server version. Defaults to 0.1.0.

Once the server is running, clients connect to it through the @uigraph/mcp proxy.