Setup MCP / Skills

Connect AI tools to ScreenWay.

The ScreenWay AI Toolkit exposes a hosted Streamable HTTP MCP server. AI clients use the same workspace API key as the REST API, then operate screens, media, apps, programs, Designer projects, and analytics through tools.

Hosted MCP

Connect MCP clients to https://mcp.screenway.com. The MCP service forwards calls to https://studio.screenway.com/api/v1 with the customer's Bearer token.

Remote server

Hosted endpoint: https://mcp.screenway.com.

API key

Use a ScreenWay workspace API key beginning with swk_.

Safe hosted mode

Hosted tools do not read customer-local filesystem paths.

Codex

Add the remote MCP server to Codex and expose the API key in the environment used to start Codex.

These two snippets belong together: bearer_token_env_var names the environment variable Codex should read, and the shell export puts the same ScreenWay swk_ API key into that variable before Codex starts.

~/.codex/config.toml

[mcp_servers.screenway]
url = "https://mcp.screenway.com"
bearer_token_env_var = "SCREENWAY_API_KEY"

shell before starting Codex

export SCREENWAY_API_KEY=swk_your_api_key_here

Claude Desktop, Claude Code, Cursor

Clients that accept remote MCP JSON config can point directly at the hosted server and pass the Authorization header.

mcp config

{
  "mcpServers": {
    "screenway": {
      "url": "https://mcp.screenway.com",
      "headers": {
        "Authorization": "Bearer swk_your_api_key_here"
      }
    }
  }
}

Optional Codex skill

The toolkit includes screenway-designer, a workflow skill for creating, editing, rendering, and visually checking Designer projects through MCP. Install it from the ScreenWay AI Toolkit repository.

install from GitHub

git clone https://github.com/Bergx2/bx2_screenway-ai-toolkit.git
cd bx2_screenway-ai-toolkit
mkdir -p ~/.codex/skills
cp -R skills/screenway-designer ~/.codex/skills/

usage

Use $screenway-designer to update a Designer project and render a PNG for review.

Tool families

Screens

List screens, inspect details, update screen metadata, send commands.

Media

List folders/media, upload by URL or data URL, create folders.

Apps + programs

List apps, create app instances, list programs, assign programs.

Designer

Create projects, update editable design_data, render screenshots, update thumbnails.

Notifications

Send screen notifications with category, priority, optional action, and target scope.

Analytics

Pull workspace and per-screen analytics over a date range.

Hosted vs local

Hosted MCP accepts inline JSON and data URLs
Hosted MCP uploads public assets by URL or base64/data URL
Local stdio mode can expose filesystem helpers for development
Designer edits should update design_data and exported_html together
Render Designer projects before handing work back
Restart the AI client after changing MCP config