supOS MCP Server
by FREEZONEX
This MCP server is developed based on the Model Context Protocol (MCP) `typescript-sdk`. It allows any MCP-compatible client to use it and provides a series of supOS open-APIs, such as querying the topic tree structure and topic details.
Last updated: N/A
What is supOS MCP Server?
The supOS MCP Server is a server implementation based on the Model Context Protocol (MCP) that exposes supOS open APIs. It enables clients supporting the MCP protocol to interact with supOS data and functionalities.
How to use supOS MCP Server?
To use the server, you need to configure an MCP-compatible client (e.g., Claude for Desktop) to connect to the server. This involves setting the server's command, arguments, and environment variables (API_KEY, API_URL, MQTT_URL) in the client's configuration file. You can either run the server using npx mcp-server-supos, install it globally and run it with node, or clone the repository, build it, and then run the built JavaScript file.
Key features of supOS MCP Server
Provides a Model Context Protocol (MCP) server interface
Offers supOS open-API access
Supports querying topic tree structure
Supports retrieving topic details
Supports fetching real-time topic data
Supports fetching all topic real-time data and analysis
Use cases of supOS MCP Server
Integrating supOS data into MCP-compatible clients
Building applications that require access to supOS topic information
Visualizing real-time data from supOS in various client applications
Automating tasks based on supOS data changes
FAQ from supOS MCP Server
What is MCP?
What is MCP?
MCP stands for Model Context Protocol. It is a protocol that allows clients to access and interact with data models.
What is supOS?
What is supOS?
supOS is a platform that provides various industrial applications and data services.
How do I get the API_KEY, API_URL, and MQTT_URL?
How do I get the API_KEY, API_URL, and MQTT_URL?
The API_URL is the address of the supOS community edition. The API_KEY can be found in the DataModeling section of the supOS community edition by viewing a specific topic's details and then navigating to Data Operation -> Fetch. The MQTT_URL can be found in UNS -> MqttBroker -> Listeners.
What clients are supported?
What clients are supported?
Many MCP-compatible clients are supported, such as Claude for Desktop and VSCode plugins like Cline. A list of supported clients can be found at Model Context Protocol Client.
Why does npx fail on Windows?
Why does npx fail on Windows?
npx may have issues reading environment variables on Windows. As a workaround, you can install the package globally or clone the repository and run the server locally.