Kanvas OpenClaw Plugin

OpenClaw plugin that connects AI agents to Kanvas — your company's nervous system. Kanvas is the operational engine that connects all your data, tools, and workflows. For AI agents, it's what lets them actually run your business — not just talk about it.

This plugin gives agents direct access to CRM, inventory, orders, and messaging so they can search leads, create contacts, check stock, track orders, store structured data, and send emails — all through 41 tools with auto-login and built-in system prompt context.

Quick Start

1. Install the plugin

# From local directory (development)
openclaw plugins install /path/to/kanvas-openclaw-plugin --link

# From npm (once published)
openclaw plugins install kanvas-openclaw-plugin

2. Configure credentials

In your OpenClaw config file:

{
  plugins: {
    entries: {
      "kanvas": {
        enabled: true,
        config: {
          xKanvasApp: "your-app-id",
          email: "agent@yourcompany.com",
          password: "agent-password",
          // Optional:
          // xKanvasKey: "your-app-key"  // needed for kanvas_send_anonymous_email
          // xKanvasLocation: "branch-uuid"
        }
      }
    }
  }
}

The API URL is preconfigured. The plugin authenticates automatically on the first tool call using the Kanvas login mutation.

3. Set up the agent's system prompt

The plugin injects tool documentation into the agent's context automatically. But the agent's base system prompt (configured in OpenClaw) should tell it to use Kanvas. Here's a sample:

You are a sales and operations agent for [Company Name]. You manage leads,
inventory, and orders using Kanvas.

Your responsibilities:
- Register and manage leads in the CRM pipeline
- Look up products, stock levels, and pricing
- Check and track orders
- Add notes and messages to leads
- Send emails to customers and prospects

When users ask you to do any of these things, use the kanvas_* tools to act
on it directly. Don't just describe what you would do — actually do it.

Before creating a lead, always check kanvas_list_pipelines to get valid
pipeline stage IDs, and kanvas_list_lead_sources for source IDs.

When you don't have enough information to complete an action (e.g. missing
a required field), ask the user for the missing details before proceeding.

Customize this for your business — add your company name, specific workflows, and any domain-specific instructions.

Tools Reference

CRM (22 tools)

Social / Messages (9 tools)

Messages act as NoSQL-like document storage — the message field accepts any JSON structure.

Inventory (7 tools)

Orders (2 tools)

Diagnostics (1 tool)

Authentication

The plugin supports three auth modes:

With email/password, the plugin calls the Kanvas login mutation on the first tool invocation and caches the bearer token — no hardcoded tokens needed.

Configuration Reference

*Required when using email/password auth (recommended). Not needed if using bearerToken or app-key mode.

All fields also fall back to KANVAS_* environment variables.

Development

npm run build     # Compile TypeScript to dist/
npm run check     # Type-check without emitting
npm run dev       # Watch mode

Smoke Test

Test against the real API:

KANVAS_X_APP=your-app-id \
KANVAS_EMAIL=your@email.com \
KANVAS_PASSWORD=yourpassword \
  npx ts-node --esm scripts/smoke-test.ts

License

Private — see package.json.