supOS MCP Server

hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

Integrations

  • Provides tools to interact with supOS's API, enabling users to query topic tree structures and retrieve topic details from supOS models.

Inglés | Chino

Servidor MCP de supOS

Este servidor MCP está desarrollado en base al typescript-sdk proporcionado por el protocolo Model Context Protocol (MCP) , lo que permite que cualquier cliente que admita el protocolo MCP lo utilice.

Proporciona una serie de API abiertas de supOS, como consultar la estructura del árbol de temas, detalles del tema, etc.

API compatibles

Herramientas

  1. get-model-topic-tree
    • Consulta de datos del menú de la estructura del árbol de temas
    • Aporte:
      • key (cadena): palabra clave de búsqueda difusa para nodos secundarios
      • showRec (booleano): Número de registros a mostrar
      • type (cadena): Tipo de búsqueda: 1--Búsqueda de texto, 2--Búsqueda de etiquetas
    • Devuelve: datos del menú de la estructura del árbol de temas
  2. get-model-topic-detail
    • Obtener detalles de un tema específico
    • Aporte:
      • topic (cadena): La ruta del tema correspondiente al modelo
    • Devoluciones: detalles de un tema específico
  3. get-topic-realtime-data
    • Obtenga datos en tiempo real de un tema específico
    • Aporte:
      • topic (cadena): La ruta del tema correspondiente al modelo
    • Devuelve: datos en tiempo real de un tema específico
  4. get-all-topic-realtime-data
    • Obtenga y analice datos en tiempo real de todos los temas
    • Devoluciones: datos en tiempo real de todos los temas
  5. get-topic-history-data-by-graphql
    • Obtener datos históricos de un tema específico desde graphql
    • Aporte:
      • topic (cadena): La ruta del tema correspondiente al modelo
      • limit (número): Limitar el número de registros
      • startTime (cadena): Hora de inicio en formato ISO 8601, p. ej., 2025-04-13T00:00:00Z. Si no se especifica, se establece por defecto una semana antes de la hora actual.
      • endTime : Hora de finalización en formato ISO 8601, p. ej., 2025-04-20T23:59:59Z. Si no se especifica, se usa la hora actual por defecto.
    • Devuelve: datos históricos de un tema específico

Sigamos la documentación para comenzar a usarlo.

Empezando

Requisitos del sistema

  • Node.js

Instalación del cliente

Actualmente, existen muchos clientes compatibles con el protocolo MCP, como aplicaciones de escritorio como Claude for Desktop o complementos IDE (como el complemento Cline para VSCode ). Para obtener más información sobre los clientes compatibles, visite Cliente de Protocolo de Contexto de Modelo .

Aquí utilizaremos Claude for Desktop como ejemplo.

  • Descargar Claude para escritorio .
  • Configure el servidor MCP requerido para Claude for Desktop .
    • Abra la configuración de Claude for Desktop en un editor de texto: ~/Library/Application Support/Claude/claude_desktop_config.json .
    • También puede encontrar la ubicación de este archivo de configuración haciendo clic en Edit Config en File -> Setting -> Developer :
    • Después de abrir el archivo de configuración, agregue el siguiente contenido a claude_desktop_config.json y reinicie la aplicación:
      Nota: Es necesario reiniciar la aplicación después de cada modificación de este archivo de configuración para que los cambios surtan efecto.
      { "mcpServers": { "supos": { "command": "npx", "args": [ "-y", "mcp-server-supos" ], "env": { "SUPOS_API_KEY": "<API_KEY>", "SUPOS_API_URL": "<API_URL>", "SUPOS_MQTT_URL": "<MQTT_URL>" } } } }
    • Donde API_URL es la dirección accesible de supOS Community Edition . API_KEY se puede encontrar iniciando sesión en la Community Edition, yendo a DataModeling -> View specific topic details -> Data Operation -> Fetch , y copiando la APIKey correspondiente. MQTT_URL se puede encontrar visitando UNS -> MqttBroker -> Listeners para ver la dirección suscribible.

Nota: La configuración anterior del servidor MCP utiliza npx para extraer el paquete npm mcp-server-supos y ejecutarlo localmente para proporcionar servicios a los clientes. Sin embargo, npx puede tener problemas para leer las configuraciones de la variable de entorno env en sistemas Windows , por lo que se pueden adoptar las siguientes soluciones:

Ejecución del servicio localmente

Elija uno de los dos métodos siguientes:

  • Instale mcp-server-supos localmente y ejecútelo a través del nodo
  1. Instalar
npm install mcp-server-supos -g
  1. Busque la ruta del paquete instalado, por ejemplo: "C://Users//<USER_NAME>//AppData//Roaming//npm//node_modules//mcp-server-supos//dist//index.js"
  2. Modifique la configuración en claude_desktop_config.json y reinicie la aplicación
{ "mcpServers": { "supos": { "command": "node", "args": [ "C://Users//<USER_NAME>//AppData//Roaming//npm//node_modules//mcp-server-supos//dist//index.js" ], "env": { "SUPOS_API_KEY": "<API_KEY>", "SUPOS_API_URL": "<API_URL>", "SUPOS_MQTT_URL": "<MQTT_URL>" } } } }
  • Descargue y compile el código fuente del repositorio localmente
  1. Clonar el repositorio:
git clone https://github.com/FREEZONEX/mcp-server-supos.git
  1. Instalar dependencias
npm ci
  1. Construir
npm run build
  1. Modifique la configuración en claude_desktop_config.json y reinicie la aplicación
{ "mcpServers": { "supos": { "command": "node", "args": [ "<local project path>//dist//index.js" ], "env": { "SUPOS_API_KEY": "<API_KEY>", "SUPOS_API_URL": "<API_URL>", "SUPOS_MQTT_URL": "<MQTT_URL>" } } } }

Conclusión

Este es el tutorial completo para usar este servicio. Tras la configuración, podrá ver los servicios y herramientas correspondientes en los siguientes paneles:

Instalación mediante herrería

Para instalar supOS MCP Server para Claude Desktop automáticamente a través de Smithery :

npx -y @smithery/cli install @FREEZONEX/mcp-server-supos --client claude

Nota final

La Edición Comunitaria de supOS integra el cliente mcp abierto, desarrollado por los autores CopilotKit , y el servicio mcp-server-supos , compatible con agent de versiones ts. El código fuente está disponible en supOS-CE-McpClient .

Licencia

Este proyecto está licenciado bajo la Licencia Apache 2.0: consulte el archivo de LICENCIA para obtener más detalles.

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

Un servidor de protocolo MCP que proporciona acceso a las API abiertas de supOS, lo que permite a los clientes compatibles con MCP consultar estructuras y detalles de árboles de temas.

  1. Supported APIs
    1. Tools
  2. Getting Started
    1. System Requirements
    2. Installing Client
    3. Running Service Locally
    4. Conclusion
    5. Installing via Smithery
    6. Final Note
  3. License
    ID: 7ayh12mg77