Skip to main content

Workspace Apps

This category lists the 20 Runtime system commands under system.workspace-app..

1. List workspace apps​

Full name: system.workspace-app.list

List workspace app records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system workspace-app list [--json]

Parameters:

  • permissionScope（optional）— Permission view: admin for integrations management or user for end-user visibility; defaults to admin
  • sidebarVariant（optional）— Optional admin/user navigation projection. Omit or null to return both navigation records

2. Retrieve workspace app​

Full name: system.workspace-app.get

Retrieve workspace app resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system workspace-app get --app-code value [--json]

Parameters:

  • appCode（required）— Stable workspace app code discovered with workspace-app.list
  • permissionScope（optional）— Permission view; defaults to admin
  • sidebarVariant（optional）— Optional admin/user navigation projection

3. Create workspace app​

Full name: system.workspace-app.create

Create workspace app resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system workspace-app create \
  (--definition-json json|--definition-file path) [--json]

Parameters:

  • code（required）— Tenant-unique immutable code matching ^[a-z0-9]+(?:_[a-z0-9]+)*$, at most 64 characters
  • name（required）— Initial display name used for both en and zh-CN, 1-80 characters
  • description（optional）— Nullable initial description used for both en and zh-CN, at most 500 characters
  • iconKey（required）— Uploaded icon URL/key, 1-2000 characters. Upload the image first; do not invent a file URL

4. Update workspace app​

Full name: system.workspace-app.update

Update workspace app resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system workspace-app update \
  --app-code value (--definition-json json|--definition-file path) \
  [--json]

Parameters:

  • appCode（required）— Existing app code. The code itself is immutable
  • name（optional）— Replacement display name, 1-80 characters
  • description（optional）— Replacement description; null clears it
  • iconKey（optional）— Replacement uploaded icon URL/key

5. Enable workspace app​

Full name: system.workspace-app.enable

Enable workspace app resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system workspace-app enable --app-code value [--json]

Parameters:

  • appCode（required）— Custom app code to show in the user workspace. Idempotent when already enabled

6. Disable workspace app​

Full name: system.workspace-app.disable

Disable workspace app resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system workspace-app disable --app-code value [--json]

Parameters:

  • appCode（required）— Custom app code to hide from the user workspace. Idempotent when already disabled

7. Delete workspace app​

Full name: system.workspace-app.delete

Delete workspace app resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: High risk

sl system workspace-app delete --app-code value [--json]

Parameters:

  • appCode（required）— Custom app code. System applications, including approval-center, cannot be deleted

8. List mcp servers​

Full name: system.workspace-app.mcp-server.list

List workspace app mcp server records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system workspace-app mcp-server list --app-code value [--json]

Parameters:

  • appCode（required）— Workspace app code. Returns MCP servers bound to this app or shared with it

9. Retrieve mcp server​

Full name: system.workspace-app.mcp-server.get

Retrieve workspace app mcp server resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system workspace-app mcp-server get \
  --app-code value --server-id uuid [--json]

Parameters:

  • appCode（required）— Workspace app code
  • serverId（required）— MCP server UUID returned by create or list

10. Create mcp server​

Full name: system.workspace-app.mcp-server.create

Create workspace app mcp server resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system workspace-app mcp-server create \
  --app-code value (--mcp-json json|--mcp-file path) [--json]

Parameters:

  • appCode（required）— Existing workspace app code
  • sourceType|deploymentMode（required）— remote_url requires remote_http; command and docker_image require managed_local
  • name（required）— Tenant-unique server name, 1-128 characters
  • description（optional）— Server description, at most 500 characters
  • endpointUrl|networkZone（optional）— For remote_url only: URL and public_https or tenant_internal network zone
  • credentialConfig（optional）— For remote_url only: authType none, bearer_token with bearerToken, or api_key_header with headerName and apiKey
  • command|image（optional）— For managed_local: executable command or container image
  • args（optional）— For managed_local: ordered string argument array, maximum 200 items
  • env（optional）— For managed_local: string environment map; never put credentials in command arguments

11. Update mcp server​

Full name: system.workspace-app.mcp-server.update

Update workspace app mcp server resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system workspace-app mcp-server update \
  --app-code value --server-id uuid (--mcp-json json|--mcp-file path) \
  [--json]

Parameters:

  • appCode（required）— Owning workspace app code
  • serverId（required）— MCP server UUID
  • name|description（optional）— Updated metadata
  • endpointUrl|networkZone|command|image|args|env（optional）— Update fields must match the server source type; sourceType and deploymentMode cannot be changed

12. Update mcp server credentials​

Full name: system.workspace-app.mcp-server.credentials.update

Update workspace app mcp server credentials resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system workspace-app mcp-server credentials update \
  --app-code value --server-id uuid \
  (--credential-json json|--credential-file path) [--json]

Parameters:

  • appCode（required）— Owning workspace app code
  • serverId（required）— MCP server UUID
  • credentialConfig（required）— Remote HTTP credential replacement. Secrets are write-only and never returned

13. Retrieve mcp server operation​

Full name: system.workspace-app.mcp-server.operation.get

Retrieve workspace app mcp server operation resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system workspace-app mcp-server operation get \
  --operation-id uuid [--json]

Parameters:

  • operationId（required）— Async operation UUID returned by create, update, sync, credentials.update, or delete

14. List mcp server tools​

Full name: system.workspace-app.mcp-server.tools.list

List workspace app mcp server tools records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system workspace-app mcp-server tools list \
  --app-code value --server-id uuid [--json]

Parameters:

  • appCode（required）— Workspace app code
  • serverId（required）— MCP server UUID

15. Update mcp server tools​

Full name: system.workspace-app.mcp-server.tools.update

Update workspace app mcp server tools resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system workspace-app mcp-server tools update \
  --app-code value --server-id uuid \
  (--tools-json json|--tools-file path) [--json]

Parameters:

  • appCode（required）— Owning or bound workspace app code
  • serverId（required）— MCP server UUID
  • items（required）— Complete selection list: each item has toolName, enabled, and optional riskLevel

16. Synchronize mcp server​

Full name: system.workspace-app.mcp-server.sync

Synchronize workspace app mcp server resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system workspace-app mcp-server sync \
  --app-code value --server-id uuid [--json]

Parameters:

  • appCode（required）— Owning workspace app code
  • serverId（required）— MCP server UUID

17. Share mcp server​

Full name: system.workspace-app.mcp-server.share

Share workspace app mcp server resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system workspace-app mcp-server share \
  --app-code value --server-id uuid --share-scope private|workspace \
  [--json]

Parameters:

  • appCode（required）— Owning workspace app code
  • serverId（required）— MCP server UUID
  • shareScope（required）— private or workspace. Private is rejected while dependent app bindings exist

18. Update mcp server binding​

Full name: system.workspace-app.mcp-server.binding.update

Update workspace app mcp server binding resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system workspace-app mcp-server binding update \
  --app-code value --server-id uuid --enabled|--disabled [--json]

Parameters:

  • appCode（required）— Workspace app to bind or unbind
  • serverId（required）— MCP server UUID
  • enabled（required）— Enable or disable this app binding. The owner binding cannot be disabled

19. Test mcp server​

Full name: system.workspace-app.mcp-server.test

Test workspace app mcp server resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

sl system workspace-app mcp-server test \
  --app-code value --server-id uuid [--json]

Parameters:

  • appCode（required）— Owning workspace app code
  • serverId（required）— MCP server UUID

20. Delete mcp server​

Full name: system.workspace-app.mcp-server.delete

Delete workspace app mcp server resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: High risk

sl system workspace-app mcp-server delete \
  --app-code value --server-id uuid [--json]

Parameters:

  • appCode（required）— Owning workspace app code
  • serverId（required）— MCP server UUID. Delete is asynchronous and removes the server after binding checks