MCP Server Supos

🚀 supOS MCP Server

The MCP Server is developed using the typescript-sdk provided by the Model Context Protocol (MCP). It allows any MCP protocol - compliant client to use its services.

It offers a series of supOS open APIs, such as querying the topic tree structure and topic details.

🚀 Quick Start

The supOS MCP Server is a powerful tool that provides a range of APIs for various operations. This README will guide you through its supported APIs, installation, configuration, and other important aspects.

✨ Features

Supported APIs

Tools

1. get-model-topic-structure
   Retrieve the model topic structure.
2. get-model-details
   Get the detailed information of the model.
3. generate-content
   Generate content based on the given topic.
4. query-knowledge-base
   Query the knowledge base.
5. save-to-database
   Save data to the database.
6. publish-output
   Publish the output results.

📦 Installation

System Requirements

• Node.js (Version 14 or higher is recommended)
• npm (Version 6 or higher is recommended)

Client Installation

npm install mcp-client-supos

Configuration Steps

1. Clone the repository:

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

2. Install the dependencies:

   npm ci
   

3. Build the project:

   npm run build
   

4. Configure the claude - desk - config.json file and add the following content:

   {
     "mcpServers": {
       "supos": {
         "command": "node",
         "args": ["dist/index.js"],
         "env": {
           "SUPOS_API_KEY": "your_api_key",
           "SUPOS_API_URL": "https://api.supos - demo.app",
           "SUPOS_MQTT_URL": "ws://supos - mqtt - broker:1883"
         }
       }
     }
   }
   

Important Notes

⚠️ Important Note

• Ensure that all environment variable values are correctly configured.
• In a production environment, it is recommended to use the HTTPS protocol.

📚 Documentation

After completing the above configuration, you can see the corresponding services and tools in the following panels:

Final Note

The [supOS Community Edition](https://supos - demo.supos.app/) has integrated the [open - mcp - client](https://github.com/CopilotKit/open - mcp - client) open - sourced by the author of CopilotKit and has the mcp - server - supos service built - in, supporting the ts version agent. The source code can be accessed at [supOS - CE - McpClient](https://github.com/FREEZONEX/supOS - CE - McpClient).

📄 License

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