oVice

Gestiona espacios de trabajo, grupos, usuarios y envía notificaciones a través de la API de oVice.

Documentación

Servidor MCP de oVice

Acerca de este repositorio

Este es un repositorio no oficial para la verificación personal de la construcción de un servidor MCP en un entorno local (no se garantiza su funcionamiento).

Es un servidor MCP que se integra con la API de oVice y proporciona funciones de gestión de espacios de trabajo, grupos, usuarios y notificaciones.

Resumen de funciones

Este servidor MCP proporciona las siguientes funciones:

  • Gestión de espacios de trabajo: Obtención de la lista de espacios de trabajo de la organización, lista de usuarios, generación de URL de acceso
  • Gestión de grupos: Obtención de la lista de grupos de la organización, gestión de miembros
  • Función de notificación: Envío de notificaciones a la organización, espacios de trabajo y grupos
  • Obtención de información: Obtención del nombre del espacio, etc.

Configuración inicial

Claude Desktop

Edite el archivo de configuración para registrar el servidor MCP.

MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json
Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "ovice-mcp-server": {
      "command": "npx",
      "args": ["github:cti1650/ovice-mcp-server"],
      "env": {
        "OVICE_DOMAIN": "api.ovice.com",
        "OVICE_CLIENT_ID": "your-client-id",
        "OVICE_CLIENT_SECRET": "your-client-secret",
        "OVICE_ORGANIZATION_ID": "your-organization-id",
        "OVICE_SERVICE_NAME": "Your Service Name",
        "OVICE_SERVICE_LOGO_URL": "https://your-logo-url.com/logo.svg"
      }
    }
  }
}

Variables de entorno

Nombre de variableObligatorioValor predeterminadoDescripción
OVICE_CLIENT_ID✓-ID de cliente de la API de oVice
OVICE_CLIENT_SECRET✓-Secreto de cliente de la API de oVice
OVICE_ORGANIZATION_ID✓-ID de organización
OVICE_DOMAIN-"api.ovice.com"Dominio de la API de oVice (requiere cambio fuera del entorno de producción)
OVICE_SERVICE_NAME-"This is demo"Nombre del servicio mostrado en las notificaciones
OVICE_SERVICE_LOGO_URL-URL del logotipo de oViceURL del logotipo del servicio mostrado en las notificaciones

Herramientas disponibles

Relacionadas con espacios de trabajo

get_organization_workspaces

  • Descripción: Obtiene la lista de espacios de trabajo de la organización
  • Parámetros: Ninguno
  • Valor de retorno: Lista de espacios de trabajo (formato JSON)

get_workspace_users

  • Descripción: Obtiene la lista de usuarios de un espacio de trabajo especificado
  • Parámetros:
    • workspaceId (string): ID del espacio de trabajo
  • Valor de retorno: Lista de usuarios (formato JSON)

get_space_name_by_id

  • Descripción: Obtiene el nombre del espacio a partir del ID del espacio
  • Parámetros:
    • spaceId (string): ID del espacio
  • Valor de retorno: Nombre del espacio

get_workspace_access_path

  • Descripción: Genera una URL para acceder al espacio de trabajo
  • Parámetros:
    • workspaceId (string): ID del espacio de trabajo
  • Valor de retorno: URL de acceso (https://{appDomain}/ws/{workspaceDomain}/)
  • Nota: Obtiene la información del espacio de trabajo desde la API y genera una URL basada en el dominio

Relacionadas con grupos

get_organization_groups

  • Descripción: Obtiene la lista de grupos de la organización
  • Parámetros: Ninguno
  • Valor de retorno: Lista de grupos (formato JSON)

get_group_members

  • Descripción: Obtiene la lista de miembros de un grupo especificado
  • Parámetros:
    • groupId (string): ID del grupo
  • Valor de retorno: Lista de miembros (formato JSON)

Función de notificación

send_organization_notification

  • Descripción: Envía una notificación a toda la organización
  • Parámetros:
    • message (string): Mensaje de notificación
    • serviceName (string, opcional): Nombre del servicio
    • serviceLogoUrl (string, opcional): URL del logotipo del servicio
  • Valor de retorno: Resultado del envío (formato JSON)

send_workspace_notification

  • Descripción: Envía una notificación a un espacio de trabajo específico
  • Parámetros:
    • workspaceId (string): ID del espacio de trabajo
    • auth (array): Niveles de permiso de destino de la notificación ("admin", "member", "visitor", "guest")
    • message (string): Mensaje de notificación
    • serviceName (string, opcional): Nombre del servicio
    • serviceLogoUrl (string, opcional): URL del logotipo del servicio
  • Valor de retorno: Resultado del envío (formato JSON)

send_group_notification

  • Descripción: Envía una notificación a un grupo específico
  • Parámetros:
    • groupId (string): ID del grupo
    • message (string): Mensaje de notificación
    • serviceName (string, opcional): Nombre del servicio
    • serviceLogoUrl (string, opcional): URL del logotipo del servicio
  • Valor de retorno: Resultado del envío (formato JSON)

Especificaciones de la API

Este servidor MCP utiliza la API pública de oVice v1:

  • Endpoint: https://{OVICE_DOMAIN}/api/public/v1/
  • Autenticación: Autenticación por encabezado mediante ID de cliente y secreto de cliente

Manejo de errores

  • Si faltan variables de entorno, se muestra un mensaje de error adecuado
  • Si falla la llamada a la API, se devuelve el código de estado HTTP y los detalles del error
  • Si no se encuentra el recurso especificado (espacio de trabajo, grupo, etc.), se muestra un mensaje de error específico

Sitios de referencia