ServerDetail

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/sealgate-ai/json-schema/sealgate-ai-server-detail-schema.json",
  "title": "ServerDetail",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/sealgate-ai-management-openapi.json#/components/schemas/ServerDetail",
  "allOf": [
    {
      "$ref": "#/$defs/ServerSummary"
    },
    {
      "type": "object",
      "properties": {
        "elements": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ServerElement"
          },
          "description": "Server elements (tools, resources, prompts)"
        },
        "template_fields": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/TemplateFieldSchema"
          },
          "description": "Template fields requiring configuration"
        },
        "args": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Command-line arguments"
        },
        "env": {
          "type": "object",
          "additionalProperties": {
            "type": [
              "string",
              "null"
            ]
          },
          "description": "Environment variables"
        },
        "url": {
          "type": [
            "string",
            "null"
          ],
          "description": "Remote server URL (direct mode)"
        },
        "headers": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Custom HTTP headers"
        },
        "version": {
          "type": [
            "string",
            "null"
          ],
          "description": "Server version"
        },
        "from_marketplace_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "Marketplace ID this server was installed from"
        }
      }
    }
  ],
  "$defs": {
    "ServerElement": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Element ID"
        },
        "name": {
          "type": "string",
          "description": "Element name (permission_key)"
        },
        "compacted_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Client-facing tool name after prefixing and length compaction"
        },
        "type": {
          "type": "string",
          "description": "Element type: tool, resource, or prompt"
        },
        "permission_key": {
          "type": "string",
          "description": "Permission key for this element"
        },
        "server_name": {
          "type": "string",
          "description": "Parent server name"
        }
      },
      "required": [
        "id",
        "name",
        "type",
        "permission_key",
        "server_name"
      ]
    },
    "ServerRuntimeHealth": {
      "type": "object",
      "description": "Live runtime health of a mounted MCP server.",
      "properties": {
        "state": {
          "type": "string",
          "enum": [
            "ok",
            "starting",
            "degraded"
          ],
          "description": "Runtime state"
        },
        "error_kind": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "auth_required",
            "forbidden",
            "rate_limited",
            "upstream_error",
            "http_error",
            "timeout",
            "unreachable",
            "mount_failed",
            "no_tools",
            "unknown",
            null
          ],
          "description": "Discriminating reason when state is degraded; null otherwise"
        },
        "reason": {
          "type": [
            "string",
            "null"
          ],
          "description": "Short user-facing label derived from error_kind"
        },
        "detail": {
          "type": [
            "string",
            "null"
          ],
          "description": "Longer error message tail"
        },
        "last_check_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "consecutive_failures": {
          "type": "integer",
          "default": 0
        },
        "next_check_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "required": [
        "state"
      ]
    },
    "ServerSummary": {
      "type": "object",
      "description": "Summary view of a connected MCP server.",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Server ID"
        },
        "name": {
          "type": "string",
          "description": "Server MCP prefix name (alphanumeric)"
        },
        "display_name": {
          "type": "string",
          "description": "Human-readable display name"
        },
        "command": {
          "type": "string",
          "description": "Server command"
        },
        "enabled": {
          "type": "boolean",
          "description": "Whether the server is enabled at the admin/global level"
        },
        "tool_count": {
          "type": "integer",
          "description": "Number of registered tools/elements"
        },
        "needs_config": {
          "type": "boolean",
          "description": "Whether the server has unconfigured required template fields"
        },
        "domain": {
          "type": "string",
          "description": "Domain this server belongs to"
        },
        "is_builtin": {
          "type": "boolean",
          "default": false,
          "description": "Whether this is the auto-provisioned builtin server"
        },
        "user_enabled": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "User-level enablement override; null means no override"
        },
        "parent_enabled": {
          "type": "boolean",
          "description": "Effective enabled state from the role/global hierarchy, ignoring any user override"
        },
        "user_locked": {
          "type": "boolean",
          "default": false,
          "description": "Whether the caller's enablement override is admin-locked"
        },
        "config_warnings": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Human-readable warnings about missing configuration"
        },
        "icon_url": {
          "type": [
            "string",
            "null"
          ],
          "description": "Remote icon URL"
        },
        "runtime_health": {
          "oneOf": [
            {
              "$ref": "#/$defs/ServerRuntimeHealth"
            },
            {
              "type": "null"
            }
          ],
          "description": "Live mount and ping health, or null when no per-user MCP instance exists yet"
        },
        "authenticated_user_emails": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Emails of users who have invoked tools on this server"
        },
        "transport_type": {
          "type": "string",
          "default": "http",
          "description": "Transport: 'http' (remote URL) or 'stdio_tunnel' (proxied via daemon)"
        },
        "device_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "Human-readable device label for a bound stdio_tunnel device"
        },
        "device_owner_email": {
          "type": [
            "string",
            "null"
          ],
          "description": "Email of the device owner for a stdio_tunnel server"
        }
      },
      "required": [
        "id",
        "name",
        "display_name",
        "command",
        "enabled",
        "tool_count",
        "needs_config",
        "domain",
        "parent_enabled"
      ]
    },
    "TemplateFieldSchema": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "field_type": {
          "type": "string",
          "description": "Field type: arg or env"
        },
        "template_key": {
          "type": "string"
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "required": {
          "type": "boolean",
          "default": false
        },
        "set_by_user": {
          "type": "boolean",
          "default": true
        },
        "has_admin_value": {
          "type": "boolean",
          "default": false
        },
        "has_user_value": {
          "type": "boolean",
          "default": false
        }
      },
      "required": [
        "id",
        "field_type",
        "template_key"
      ]
    }
  }
}