Skip to content

armgit / dbx

Public Imported from GitHub
0

25 MB lightweight cross-platform database client for 100+ databases, including MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, SQL Server, and Dameng. Built-in AI, MCP Server, CLI, desktop and Docker. | 轻量级跨平台数据库管理工具,支持 MySQL、PostgreSQL、SQLite、Redis、MongoDB、达梦等 100+ 数据库,提供桌面端、Docker、CLI、内置 AI 助手和 MCP。

19.8 KB
Raw Blame
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://dbx.local/schemas/plugin-manifest-v1.json",
  "title": "DBX Plugin Manifest v1",
  "type": "object",
  "additionalProperties": false,
  "required": ["manifest_version", "id", "name", "version", "publisher", "engines"],
  "properties": {
    "$schema": { "type": "string" },
    "manifest_version": { "const": 1 },
    "id": { "$ref": "#/$defs/identifier" },
    "name": { "type": "string", "minLength": 1 },
    "icon": { "$ref": "#/$defs/assetPath" },
    "version": { "type": "string", "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+(?:[-+][0-9A-Za-z.-]+)?$" },
    "publisher": { "type": "string", "minLength": 1 },
    "description": { "type": "string" },
    "source": { "type": "string", "pattern": "^https?://[^\\s]+$" },
    "homepage": { "type": "string", "pattern": "^https?://[^\\s]+$" },
    "engines": {
      "type": "object",
      "additionalProperties": false,
      "required": ["host_api"],
      "properties": {
        "dbx": { "type": "string" },
        "host_api": { "type": "string", "minLength": 1 }
      }
    },
    "permissions": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "anyOf": [
          { "enum": ["host.events", "host.binary", "host.workbench", "host.filesystem", "host.plans:read", "host.schema:read", "host.storage", "host.ai", "host.clipboard:read", "host.data:read", "host.connections:read", "host.connections::read"] },
          { "type": "string", "pattern": "^host\\.network:https://[A-Za-z0-9._-]+(:[0-9]+)?$" }
        ]
      }
    },
    "entrypoints": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "backend": { "$ref": "#/$defs/backendEntrypoint" },
        "ui": { "$ref": "#/$defs/uiEntrypoint" }
      }
    },
    "capabilities": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": ["id", "label"],
        "properties": {
          "id": { "$ref": "#/$defs/capability" },
          "label": { "type": "string", "minLength": 1 },
          "kind": { "type": "string" }
        }
      }
    },
    "contributions": {
      "type": "array",
      "items": {
        "oneOf": [
          { "$ref": "#/$defs/connectionProviderContribution" },
          { "$ref": "#/$defs/workbenchContribution" },
          { "$ref": "#/$defs/filesystemProviderContribution" },
          { "$ref": "#/$defs/contextMenuContribution" },
          { "$ref": "#/$defs/resultViewContribution" },
          { "$ref": "#/$defs/commandContribution" },
          { "$ref": "#/$defs/menusContribution" },
          { "$ref": "#/$defs/mcpContribution" }
        ]
      }
    },
    "localizations": {
      "type": "object",
      "propertyNames": { "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$" },
      "additionalProperties": { "$ref": "#/$defs/manifestLocalization" }
    }
  },
  "$defs": {
    "identifier": {
      "type": "string",
      "maxLength": 128,
      "pattern": "^[a-z0-9][a-z0-9._-]*$"
    },
    "capability": {
      "type": "string",
      "maxLength": 256,
      "pattern": "^[a-z0-9][a-z0-9._:-]*$"
    },
    "assetPath": {
      "type": "string",
      "minLength": 1,
      "pattern": "^(?!/)(?!.*\\\\)(?!.*(?:^|/)\\.\\.?(?:/|$))(?!.*//).+$"
    },
    "backendEntrypoint": {
      "type": "object",
      "additionalProperties": false,
      "required": ["executable"],
      "properties": {
        "protocol_versions": {
          "type": "array",
          "minItems": 1,
          "uniqueItems": true,
          "items": { "type": "integer", "minimum": 1 }
        },
        "transport": { "enum": ["stdio-jsonl", "stdio-framed"] },
        "executable": { "$ref": "#/$defs/assetPath" }
      }
    },
    "uiEntrypoint": {
      "type": "object",
      "additionalProperties": false,
      "required": ["entry"],
      "properties": {
        "root": { "type": "string", "minLength": 1 },
        "entry": { "type": "string", "minLength": 1 }
      }
    },
    "selectOption": {
      "type": "object",
      "additionalProperties": false,
      "required": ["label", "value"],
      "properties": {
        "label": { "type": "string", "minLength": 1 },
        "value": { "type": "string" }
      }
    },
    "fieldPicker": {
      "description": "Local-file action on a text/password/textarea field. Desktop hosts store the chosen absolute path in the declaring field; browser hosts cannot read a client path and upload the file content into 'content_field' instead.",
      "type": "object",
      "additionalProperties": false,
      "required": ["kind"],
      "properties": {
        "kind": {
          "description": "'directory' is desktop-only: a browser cannot hand a folder to the plugin.",
          "enum": ["file", "directory"]
        },
        "accept": {
          "description": "Filters offered by the picker: file extensions ('.pem') or MIME types ('text/plain').",
          "type": "array",
          "maxItems": 16,
          "uniqueItems": true,
          "items": {
            "type": "string",
            "pattern": "^(\\.[A-Za-z0-9]{1,16}|[A-Za-z0-9+*._-]{1,64}/[A-Za-z0-9+*._-]{1,64})$"
          }
        },
        "content_field": {
          "description": "Declared sibling field that receives the file content on hosts without a client filesystem.",
          "$ref": "#/$defs/identifier"
        }
      }
    },
    "formFieldLocalization": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "label": { "type": "string", "minLength": 1 },
        "description": { "type": "string" },
        "placeholder": { "type": "string" },
        "options": { "type": "object", "propertyNames": { "minLength": 1 }, "additionalProperties": { "type": "string", "minLength": 1 } }
      }
    },
    "actionLocalization": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "label": { "type": "string", "minLength": 1 },
        "description": { "type": "string" }
      }
    },
    "contributionLocalization": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "label": { "type": "string", "minLength": 1 },
        "description": { "type": "string" },
        "fields": { "type": "object", "propertyNames": { "$ref": "#/$defs/identifier" }, "additionalProperties": { "$ref": "#/$defs/formFieldLocalization" } },
        "actions": { "type": "object", "propertyNames": { "$ref": "#/$defs/identifier" }, "additionalProperties": { "$ref": "#/$defs/actionLocalization" } }
      }
    },
    "manifestLocalization": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": { "type": "string", "minLength": 1 },
        "description": { "type": "string" },
        "contributions": { "type": "object", "propertyNames": { "$ref": "#/$defs/identifier" }, "additionalProperties": { "$ref": "#/$defs/contributionLocalization" } }
      }
    },
    "fieldCondition": {
      "oneOf": [{ "$ref": "#/$defs/fieldConditionClause" }, { "$ref": "#/$defs/fieldConditionAllOf" }, { "$ref": "#/$defs/fieldConditionAnyOf" }, { "$ref": "#/$defs/fieldConditionNot" }]
    },
    "fieldConditionClause": {
      "type": "object",
      "additionalProperties": false,
      "required": ["field", "one_of"],
      "properties": {
        "field": { "$ref": "#/$defs/identifier" },
        "one_of": {
          "type": "array",
          "minItems": 1,
          "items": {
            "description": "Compared against the referenced field's value by canonical string form, so `false` and `\"false\"` both match a boolean false.",
            "type": ["string", "boolean", "number"]
          }
        }
      }
    },
    "fieldConditionAllOf": {
      "type": "object",
      "additionalProperties": false,
      "required": ["all_of"],
      "properties": {
        "all_of": {
          "description": "Matches only when every nested condition matches.",
          "type": "array",
          "minItems": 1,
          "items": { "$ref": "#/$defs/fieldCondition" }
        }
      }
    },
    "fieldConditionAnyOf": {
      "type": "object",
      "additionalProperties": false,
      "required": ["any_of"],
      "properties": {
        "any_of": {
          "description": "Matches when at least one nested condition matches.",
          "type": "array",
          "minItems": 1,
          "items": { "$ref": "#/$defs/fieldCondition" }
        }
      }
    },
    "fieldConditionNot": {
      "type": "object",
      "additionalProperties": false,
      "required": ["not"],
      "properties": {
        "not": {
          "description": "Inverts the nested condition.",
          "$ref": "#/$defs/fieldCondition"
        }
      }
    },
    "formField": {
      "type": "object",
      "additionalProperties": false,
      "required": ["key", "label", "type"],
      "properties": {
        "key": { "$ref": "#/$defs/identifier" },
        "label": { "type": "string", "minLength": 1 },
        "type": { "enum": ["text", "password", "number", "boolean", "select", "radio", "textarea"] },
        "description": { "type": ["string", "null"] },
        "placeholder": { "type": ["string", "null"] },
        "required": { "type": "boolean" },
        "default": { "type": ["string", "number", "boolean", "null"] },
        "options": { "type": "array", "items": { "$ref": "#/$defs/selectOption" } },
        "binding": { "enum": ["config", "secret", "name", "host", "port", "username", "password", "database"] },
        "picker": { "$ref": "#/$defs/fieldPicker" },
        "visible_when": { "$ref": "#/$defs/fieldCondition" },
        "required_when": { "$ref": "#/$defs/fieldCondition" }
      },
      "allOf": [
        {
          "if": { "properties": { "type": { "enum": ["select", "radio"] } }, "required": ["type"] },
          "then": { "required": ["options"], "properties": { "options": { "minItems": 1 } } },
          "else": { "not": { "required": ["options"] } }
        },
        {
          "if": { "properties": { "binding": { "const": "port" } }, "required": ["binding"] },
          "then": { "properties": { "type": { "const": "number" } } }
        },
        {
          "if": {
            "properties": { "binding": { "enum": ["secret", "name", "host", "username", "password", "database"] } },
            "required": ["binding"]
          },
          "then": { "properties": { "type": { "enum": ["text", "password", "select", "radio", "textarea"] } } }
        }
      ]
    },
    "connectionProviderContribution": {
      "type": "object",
      "additionalProperties": false,
      "required": ["type", "id", "database_type", "fields"],
      "properties": {
        "type": { "const": "connection-provider" },
        "id": { "$ref": "#/$defs/identifier" },
        "label": { "type": "string", "minLength": 1 },
        "icon": { "$ref": "#/$defs/assetPath" },
        "database_type": { "$ref": "#/$defs/identifier" },
        "description": { "type": "string" },
        "fields": { "type": "array", "items": { "$ref": "#/$defs/formField" } },
        "workbench": { "$ref": "#/$defs/identifier" },
        "filesystem_provider": { "$ref": "#/$defs/identifier" },
        "capabilities": {
          "type": "array",
          "uniqueItems": true,
          "items": { "enum": ["test", "connect", "disconnect"] }
        },
        "proxy_route": { "type": "boolean", "default": false },
        "actions": { "type": "array", "items": { "$ref": "#/$defs/connectionAction" } }
      }
    },
    "connectionAction": {
      "type": "object",
      "additionalProperties": false,
      "required": ["id", "label"],
      "properties": {
        "id": { "$ref": "#/$defs/identifier" },
        "label": { "type": "string", "minLength": 1 },
        "description": { "type": "string" },
        "variant": { "enum": ["default", "outline", "secondary", "destructive", "ghost"] },
        "when": { "enum": ["always", "create", "edit"] },
        "close_on_success": { "type": "boolean" },
        "requires_valid_form": { "type": "boolean" },
        "timeout_ms": { "type": "integer", "minimum": 1, "maximum": 120000 }
      }
    },
    "workbenchContribution": {
      "type": "object",
      "additionalProperties": false,
      "required": ["type", "id", "label"],
      "properties": {
        "type": { "const": "workbench" },
        "id": { "$ref": "#/$defs/identifier" },
        "label": { "type": "string", "minLength": 1 },
        "description": { "type": "string" },
        "icon": { "$ref": "#/$defs/assetPath" },
        "ai": { "$ref": "#/$defs/workbenchAi" }
      }
    },
    "workbenchAi": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "recommendations": {
          "type": "array",
          "maxItems": 5,
          "items": { "$ref": "#/$defs/aiRecommendation" }
        }
      }
    },
    "aiRecommendation": {
      "type": "object",
      "additionalProperties": false,
      "required": ["id", "label", "prompt"],
      "properties": {
        "id": { "$ref": "#/$defs/identifier" },
        "label": { "type": "string", "minLength": 1, "maxLength": 200 },
        "prompt": { "type": "string", "minLength": 1, "maxLength": 32000 },
        "order": { "type": "integer", "minimum": -2147483648, "maximum": 2147483647 }
      }
    },
    "contextMenuContribution": {
      "type": "object",
      "additionalProperties": false,
      "required": ["type", "id", "label", "menu"],
      "properties": {
        "type": { "const": "context-menu" },
        "id": { "$ref": "#/$defs/identifier" },
        "label": { "type": "string", "minLength": 1 },
        "description": { "type": "string" },
        "icon": { "$ref": "#/$defs/assetPath" },
        "menu": { "enum": ["connection", "table"] },
        "dynamic": { "type": "boolean", "description": "Resolve native menu items through contextMenu/resolve/<id> when the menu opens." },
        "action": { "$ref": "#/$defs/contextMenuAction" }
      }
    },
    "contextMenuAction": {
      "type": "object",
      "additionalProperties": false,
      "required": ["type", "workbench"],
      "properties": {
        "type": { "const": "open-workbench" },
        "workbench": { "$ref": "#/$defs/identifier" }
      }
    },
    "resultViewContribution": {
      "type": "object",
      "additionalProperties": false,
      "required": ["type", "id", "label"],
      "properties": {
        "type": { "const": "result-view" },
        "id": { "$ref": "#/$defs/identifier" },
        "label": { "type": "string", "minLength": 1 },
        "description": { "type": "string" },
        "icon": { "$ref": "#/$defs/assetPath" }
      }
    },
    "filesystemProviderContribution": {
      "type": "object",
      "additionalProperties": false,
      "required": ["type", "id", "label", "schemes"],
      "properties": {
        "type": { "const": "filesystem-provider" },
        "id": { "$ref": "#/$defs/identifier" },
        "label": { "type": "string", "minLength": 1 },
        "description": { "type": "string" },
        "icon": { "$ref": "#/$defs/assetPath" },
        "schemes": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "$ref": "#/$defs/capability" } },
        "root_uri": { "type": "string", "minLength": 2, "maxLength": 4096, "pattern": "^[a-z0-9._-]+:.+$" },
        "capabilities": {
          "type": "array",
          "uniqueItems": true,
          "items": { "enum": ["read", "write", "delete", "rename", "mkdir"] }
        }
      }
    },
    "commandContribution": {
      "type": "object",
      "additionalProperties": false,
      "required": ["type", "id", "label", "action"],
      "properties": {
        "type": { "const": "command" },
        "id": { "$ref": "#/$defs/identifier" },
        "label": { "type": "string", "minLength": 1 },
        "description": { "type": "string" },
        "icon": { "$ref": "#/$defs/assetPath" },
        "action": { "$ref": "#/$defs/commandAction" },
        "enablement": { "$ref": "#/$defs/commandEnablement" }
      }
    },
    "commandAction": {
      "oneOf": [{ "$ref": "#/$defs/openWorkbenchAction" }]
    },
    "openWorkbenchAction": {
      "type": "object",
      "required": ["type", "workbench"],
      "properties": {
        "type": { "const": "open-workbench" },
        "workbench": { "$ref": "#/$defs/identifier" },
        "presentation": { "enum": ["tab", "panel"] },
        "context": { "type": "object" }
      }
    },
    "menusContribution": {
      "type": "object",
      "additionalProperties": false,
      "required": ["type", "id"],
      "properties": {
        "type": { "const": "menus" },
        "id": { "$ref": "#/$defs/identifier" },
        "items": { "type": "array", "items": { "$ref": "#/$defs/menuItem" } }
      }
    },
    "mcpContribution": {
      "type": "object",
      "additionalProperties": false,
      "required": ["type", "id"],
      "properties": {
        "type": { "const": "mcp" },
        "id": { "$ref": "#/$defs/identifier" },
        "description": { "type": "string" },
        "ai_tools": { "type": "boolean", "default": true, "description": "Set false to keep the tools off the built-in AI agent." },
        "external_tools": { "type": "boolean", "default": false, "description": "Set true to expose the tools on the external dbx MCP server." },
        "toolsets": {
          "type": "array",
          "description": "Optional grouping of the plugin's tools for the MCP settings UI. Without toolsets the plugin shows as one group.",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": ["id", "title"],
            "properties": {
              "id": { "type": "string", "maxLength": 64, "pattern": "^[a-z0-9][a-z0-9._-]*$" },
              "title": { "type": "string", "minLength": 1 },
              "description": { "type": "string", "minLength": 1 }
            }
          }
        },
        "scope": {
          "type": "object",
          "additionalProperties": false,
          "required": ["kind", "title", "argument"],
          "description": "Optional sub-scope below a connection (e.g. a Kubernetes namespace) that users can allow or restrict per connection.",
          "properties": {
            "kind": { "type": "string", "maxLength": 64, "pattern": "^[a-z0-9][a-z0-9._-]*$", "not": { "const": "database" } },
            "title": { "type": "string", "minLength": 1 },
            "argument": { "type": "string", "minLength": 1, "maxLength": 64, "description": "Tool argument carrying the scope value; the host enforces the policy on it." },
            "list_method": { "type": "string", "minLength": 1, "description": "Sidecar method returning { values: [string] } for a connectionId." }
          }
        },
        "tools": {
          "type": "object",
          "description": "Per-tool declarations keyed by the tool name mcp/tools returns. Required with external_tools: only tools declared here with an access level can be exposed on the external dbx MCP server.",
          "maxProperties": 64,
          "additionalProperties": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "toolset": { "type": "string", "description": "Toolset id from toolsets." },
              "access": { "enum": ["read", "write", "full"], "description": "Highest access the tool can reach." }
            }
          }
        }
      }
    },
    "menuItem": {
      "type": "object",
      "additionalProperties": false,
      "required": ["location", "command", "group", "order"],
      "properties": {
        "location": { "enum": ["commandPalette", "appToolbar", "appSidebar"] },
        "command": { "type": "string", "minLength": 1 },
        "group": { "type": "string" },
        "order": { "type": "integer" },
        "default_visible": { "type": "boolean" },
        "when": { "$ref": "#/$defs/commandEnablement" }
      }
    },
    "commandEnablement": {
      "type": "object",
      "properties": {
        "all": { "type": "array", "items": { "type": "object" } }
      }
    }
  }
}