Installation

Install the plugin on the OpenClaw machine, create a DealSurface API key, add it to OpenClaw config, and restart.

Quick setup

1. Install the plugin on the machine where OpenClaw runs
Install the npm package on the same machine that runs OpenClaw so the local plugin loader can resolve it.

npm install @dealsurface/openclaw-plugin

2. Sign in to DealSurface and create an API key
Create a DealSurface API key before configuring the plugin. The API authentication docs cover where to create keys, how scopes work, and what to do if you need to rotate a key.
See API key setup instructions
3. Add the API key via OpenClaw config
On a default install, the fastest path is usingopenclaw config setto enable the plugin and write the API key into the OpenClaw config.

Via OpenClaw config

openclaw config set plugins.entries.openclaw-plugin.enabled true
openclaw config set plugins.entries.openclaw-plugin.config.apiKey "ds_live_your_key_here"

This uses the normalizedopenclaw-pluginentry key, which the plugin supports directly.

If you prefer editing the config file yourself, this is the alternative setup:

{
  "plugins": {
    "entries": {
      "@dealsurface/openclaw-plugin": {
        "enabled": true,
        "config": {
          "apiKey": "ds_live_your_key_here",
          "apiUrl": "https://dealsurface.com",
          "mcpServerId": "dealsurface-mcp"
        }
      }
    }
  }
}

OpenClaw may normalize scoped package IDs to unscoped IDs inplugins.entries. If that happens in your install, useopenclaw-pluginas the key instead of@dealsurface/openclaw-plugin.

4. Restart OpenClaw
Restart OpenClaw after saving the config so it reloads plugins and starts the DealSurface MCP bridge with your new key.
5. Verify the plugin loaded
Ask OpenClaw to "list my DealSurface products". If it responds successfully, the plugin is installed, configured, and connected.

API key scopes

Use a key withreadscope for all tools. Addoutreachif you wantgenerate_dealmapandcraft_outreach.

Bridge behavior

The plugin automatically starts the DealSurface MCP bridge and registers tools when OpenClaw loads the plugin.

Requirements

Node.js 18+ for plugin runtime and MCP bridge.
OpenClaw 2026.1+ with plugin loading enabled.
DealSurface account access so you can create an API key in the dashboard.

Package links

Overview Configuration