supOS MCP Server logo

supOS MCP Server

by FREEZONEX

This MCP server is developed based on the typescript-sdk provided by the Model Context Protocol (MCP) protocol, allowing any client that supports the MCP protocol to use it. It provides a series of supOS open-apis, such as querying topic tree structure, topic details, etc.

View on GitHub

Last updated: N/A

What is supOS MCP Server?

The supOS MCP Server is an implementation of the Model Context Protocol (MCP) that provides access to supOS open-apis. It allows MCP-compatible clients to query topic tree structures, topic details, and real-time data from supOS.

How to use supOS MCP Server?

To use the server, you need an MCP-compatible client like Claude for Desktop or a VSCode plugin like Cline. Configure the client to connect to the server by providing the necessary API key, API URL, and MQTT URL. The README provides detailed instructions for configuring Claude for Desktop.

Key features of supOS MCP Server

  • Query topic tree structure

  • Get details of a specific topic

  • Get real-time data of a specific topic

  • Get real-time data of all topics

  • MCP Protocol Support

  • supOS Open-API integration

Use cases of supOS MCP Server

  • Integrating supOS data into MCP-compatible applications

  • Building custom dashboards and visualizations based on supOS data

  • Accessing supOS data from AI assistants and chatbots

  • Programmatically interacting with supOS data using MCP clients

FAQ from supOS MCP Server

What is MCP?

MCP stands for Model Context Protocol, a protocol for accessing and sharing data between different applications.

What clients are supported?

Many clients support the MCP protocol, such as desktop applications like Claude for Desktop, or IDE plugins (like the Cline plugin for VSCode).

Where can I find the API_KEY?

The API_KEY can be found by logging into the supOS Community Edition, going to DataModeling -> View specific topic details -> Data Operation -> Fetch, and copying the corresponding ApiKey.

Where can I find the MQTT_URL?

The MQTT_URL can be found by visiting UNS -> MqttBroker -> Listeners to view the subscribable address.

What if npx has issues reading environment variables on Windows?

You can either install mcp-server-supos locally and run it through node, or download and compile the repository source code locally.