SUPOS

🚀 supOS MCP Server

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

🚀 Quick Start

System Requirements

• Node.js (Recommended version 14.0 or higher)

Installation Steps

1. Clone the repository:

git clone https://github.com/FREEZONEX/mcp-server-supos.git

2. Install dependencies:

npm ci

3. Build the project:

npm run build

4. Start the server:

npm start

Configuration Instructions

Before starting the service, make sure the following environment variables are correctly configured:

• SUPOS_API_KEY: supOS API access key
• SUPOS_API_URL: supOS API address
• SUPOS_MQTT_URL: supOS MQTT server address

✨ Features

It provides a series of supOS open - source APIs, enabling users to perform operations such as querying the topic tree structure and topic details.

📦 Installation

The installation process of the supOS MCP Server is as follows:

1. Clone the repository:

git clone https://github.com/FREEZONEX/mcp-server-supos.git

2. Install dependencies:

npm ci

3. Build the project:

npm run build

4. Start the server:

npm start

💻 Usage Examples

Basic Usage

// Query the topic tree structure
const result = await getmodeltopicTree();

// Query a single topic
const result = await getmodeltopic('your-topic-id');

// Search for topics
const result = await searchtopics('search-keyword');

📚 Documentation

Supported APIs

Tools

1. get-model-topic-tree

   • Query the menu data of the topic tree structure.
   • Input:
     • key (string): Fuzzy search keyword for child nodes.
     • showRec (boolean): Display the number of records.
     • type (string): Type (optional, default is "TREE").
   • Output: Topic tree structure data.

2. get-model-topic

   • Query the detailed information of a single topic.
   • Input:
     • id (string): Topic ID.
   • Output: Topic detailed information.

3. search-topics

   • Search for topics.
   • Input:
     • query (string): Search keyword.
   • Output: A list of topics that meet the criteria.

📄 License

This project is open - sourced under the Apache License 2.0 - see the LICENSE file for details.

Conclusion

The above is a complete guide to using this service. After configuration, you can see the corresponding services and tools in the following panels:

Final Note

The supOS Community Edition has integrated the open - mcp - client open - sourced by the author of CopilotKit and has the mcp - server - supos service built - in, supporting the ts version of agent. The source code can be accessed at supOS - CE - McpClient.