Workjet
Back to Workjet

Connection Wizard

The Connection Wizard is a guided three-step flow for setting up any MCP connector in Workjet. It handles configuration, validation, and saving so you can get connectors running quickly and reliably.

Opening the Wizard

  1. Click Connectors in the sidebar
  2. Click Add Connection
  3. Select a connector from the catalog (or browse the Hangar)
  4. The wizard opens with the connector pre-selected

Step 1: Configure

The Configure step displays the MCP server command and input fields for any required environment variables. Each connector has different requirements:

  • Command: Pre-filled with the correct npx command for the connector (e.g., npx @modelcontextprotocol/server-github)
  • Environment variables: Input fields for API keys, tokens, or connection strings specific to the connector
  • Optional settings: Any connector-specific configuration options

Connectors that don't require credentials (Filesystem, Memory, Fetch, Puppeteer) skip the environment variable inputs. You can proceed directly to testing.

Environment Variable Examples

Connector Required Variables
GitHub GITHUB_PERSONAL_ACCESS_TOKEN
Slack SLACK_BOT_TOKEN, SLACK_TEAM_ID
PostgreSQL POSTGRES_CONNECTION_STRING
Notion NOTION_INTEGRATION_TOKEN
Sentry SENTRY_AUTH_TOKEN, SENTRY_ORG

Step 2: Test

Click Test Connection to validate your configuration. The wizard performs several checks:

  1. Binary check: Verifies the MCP server package is available (downloads via npx if needed)
  2. Startup check: Starts the MCP server process and waits for it to initialize
  3. Health check: Sends a health-check request to verify the server responds
  4. Credential check: For connectors that require auth, validates the credentials against the external service

If any check fails, the wizard displays an error message with guidance on how to fix the issue. Common issues include:

  • Invalid API key: The key has expired, been revoked, or was entered incorrectly
  • Network error: The external service is unreachable (check your internet connection or firewall)
  • Permission error: The API key lacks the required scopes or permissions
  • Missing dependency: Node.js is not installed (required for npx-based connectors)

Prerequisite: MCP connectors require Node.js (v18+) installed on your machine. The npx command downloads and runs the connector package.

Step 3: Save

Once the test passes, click Save to store the connection. The connector:

  • Appears in the sidebar under Connectors
  • Displays a green status indicator showing it's active
  • Becomes available for selection in assistants, engines, and chat

Credentials are stored securely in the OS keychain. The MCP server command and non-sensitive configuration are stored locally.

Editing a Connection

To modify an existing connection, click the connector in the sidebar and select Edit. The wizard reopens with the current configuration pre-filled. You can update credentials, change settings, and re-test.

Removing a Connection

To remove a connector, click it in the sidebar and select Remove. This stops the MCP server process and removes the stored configuration and credentials.

Next Steps