@nevermined-io/openclaw-plugin 1.0.11 → 1.0.13

package/docs/getting-started.md

@@ -0,0 +1,71 @@
+---
+title: "Getting Started"
+description: "Install and configure the Nevermined OpenClaw plugin in minutes"
+icon: "rocket"
+---
+
+# Getting Started
+
+The Nevermined OpenClaw plugin exposes AI agent payment operations as gateway tools callable from any OpenClaw channel — Telegram, Discord, WhatsApp, and more.
+
+## Prerequisites
+
+- An [OpenClaw](https://openclaw.ai) gateway instance
+- Node.js >= 18.0.0
+- A [Nevermined account](https://nevermined.app) (free to create)
+
+## Installation
+
+Install the plugin from your OpenClaw gateway:
+
+```bash
+openclaw plugin install @nevermined-io/openclaw-plugin
+```
+
+## Authentication
+
+### Option A: Browser login (recommended)
+
+Use the `/nvm-login` command from any connected chat channel:
+
+```
+/nvm-login
+```
+
+This opens a browser window where you authenticate with Nevermined. The API key is captured automatically and stored in your gateway config.
+
+To target the live environment:
+
+```
+/nvm-login live
+```
+
+### Option B: Manual configuration
+
+Add your API key directly to `openclaw.json`:
+
+```json
+{
+  "plugins": {
+    "nevermined": {
+      "nvmApiKey": "sandbox:eyJhbG...",
+      "environment": "sandbox"
+    }
+  }
+}
+```
+
+You can obtain an API key from the [Nevermined App](https://nevermined.app) under Settings > API Keys. See the [Get Your API Key](/docs/getting-started/get-your-api-key) guide for details.
+
+## Quick Test
+
+After authenticating, verify the plugin is working:
+
+1. **Check your balance** — from any chat channel, the agent can call `nevermined.checkBalance` to verify connectivity.
+
+2. **List plans** — call `nevermined.listPlans` to see available payment plans.
+
+## Next Steps
+
+- [Setup](/docs/api-reference/openclaw-plugin/setup) — full configuration reference
+- [Commands](/docs/api-reference/openclaw-plugin/commands) — all available tools and slash commands

package/docs/links.md

@@ -0,0 +1,38 @@
+---
+title: "Resources"
+description: "Links to Nevermined documentation, SDKs, and community resources"
+icon: "book"
+---
+
+# Resources
+
+## Nevermined Documentation
+
+| Resource | Description |
+|----------|-------------|
+| [Nevermined Docs](https://docs.nevermined.app) | Full platform documentation |
+| [Get Your API Key](https://docs.nevermined.app/docs/getting-started/get-your-api-key) | How to create a Nevermined account and obtain an API key |
+| [Payment Plans](https://docs.nevermined.app/docs/api-reference/typescript/payment-plans-and-agents) | Creating and managing payment plans |
+| [Querying Agents](https://docs.nevermined.app/docs/api-reference/typescript/querying-an-agent) | How to query agents using x402 access tokens |
+| [x402 Protocol](https://docs.nevermined.app/docs/api-reference/typescript/x402-protocol) | The HTTP payment protocol specification |
+
+## SDKs
+
+| SDK | Language | Package |
+|-----|----------|---------|
+| [Payments SDK](https://github.com/nevermined-io/payments) | TypeScript | `@nevermined-io/payments` |
+| [Payments SDK (Python)](https://github.com/nevermined-io/payments-py) | Python | `payments-py` |
+| [Nevermined CLI](https://www.npmjs.com/package/@nevermined-io/cli) | TypeScript | `@nevermined-io/cli` |
+
+## OpenClaw
+
+| Resource | Description |
+|----------|-------------|
+| [OpenClaw Docs](https://docs.openclaw.ai) | OpenClaw gateway documentation |
+| [Plugin Development](https://docs.openclaw.ai/tools/plugin) | How to build OpenClaw plugins |
+
+## Support
+
+- [GitHub Issues](https://github.com/nevermined-io/payments/issues) — report bugs or request features
+- [Nevermined Discord](https://discord.gg/nevermined) — community support
+- [Nevermined App](https://nevermined.app) — manage your account, plans, and agents

package/docs/setup.md

@@ -0,0 +1,64 @@
+---
+title: "Setup"
+description: "Full configuration reference for the Nevermined OpenClaw plugin"
+icon: "gear"
+---
+
+# Setup
+
+## Configuration
+
+The plugin reads its configuration from the `plugins.nevermined` section of your `openclaw.json`:
+
+```json
+{
+  "plugins": {
+    "nevermined": {
+      "nvmApiKey": "sandbox:eyJhbG...",
+      "environment": "sandbox",
+      "planId": "did:nv:abc123...",
+      "agentId": "did:nv:def456...",
+      "creditsPerRequest": 1
+    }
+  }
+}
+```
+
+### Configuration Fields
+
+| Field | Required | Default | Description |
+|-------|----------|---------|-------------|
+| `nvmApiKey` | No | — | Your Nevermined API key. Can be set via `/nvm-login` instead. |
+| `environment` | No | `sandbox` | Target environment: `sandbox` for testing, `live` for production. |
+| `planId` | No | — | Default payment plan ID. When set, subscriber tools use this plan automatically. |
+| `agentId` | No | — | Default agent ID. Required for plans with multiple agents. |
+| `creditsPerRequest` | No | `1` | Number of credits consumed per request. |
+
+### Environment Details
+
+| Environment | Description | Use Case |
+|-------------|-------------|----------|
+| `sandbox` | Test environment on Arbitrum Sepolia | Development, testing, integration |
+| `live` | Production environment on Arbitrum One | Live deployments with real payments |
+
+## Authentication Flow
+
+The plugin supports a browser-based login flow identical to the [Nevermined CLI](/docs/api-reference/cli/getting-started):
+
+1. User sends `/nvm-login` in any chat channel (or calls `nevermined.login`)
+2. The plugin starts a local HTTP server on a random port
+3. A browser window opens to the Nevermined login page
+4. After authentication, Nevermined redirects back with the API key
+5. The key is stored in the gateway config via `api.setConfig()`
+
+The login times out after 5 minutes if no authentication is received.
+
+### Logging Out
+
+Send `/nvm-logout` or call `nevermined.logout` to remove the stored API key. All payment tools will require re-authentication after logout.
+
+## Default Values
+
+When `planId` and `agentId` are set in the config, all subscriber tools (`checkBalance`, `getAccessToken`, `orderPlan`, `queryAgent`) use them as defaults. You can always override them per-call by passing the parameter explicitly.
+
+This is useful for gateways that serve a single plan — configure it once and all tools work without extra parameters.

package/openclaw.plugin.json

@@ -1,75 +1,34 @@
 {
+  "id": "nevermined",
   "name": "@nevermined-io/openclaw-plugin",
-  "version": "0.1.0",
   "description": "Nevermined plugin for OpenClaw — AI agent payments and access control",
   "configSchema": {
-    "nvmApiKey": {
-      "type": "string",
-      "required": false,
-      "description": "Your Nevermined API key (optional — use /nvm-login to authenticate via browser)"
-    },
-    "environment": {
-      "type": "string",
-      "enum": ["sandbox", "live"],
-      "default": "sandbox",
-      "description": "Nevermined environment to connect to"
-    },
-    "planId": {
-      "type": "string",
-      "required": false,
-      "description": "Default payment plan ID (required for subscriber tools)"
-    },
-    "agentId": {
-      "type": "string",
-      "required": false,
-      "description": "Default agent ID (required for multi-agent plans)"
-    },
-    "creditsPerRequest": {
-      "type": "number",
-      "default": 1,
-      "description": "Number of credits consumed per request"
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {
+      "nvmApiKey": {
+        "type": "string",
+        "description": "Your Nevermined API key (optional — use /nvm-login to authenticate via browser)"
+      },
+      "environment": {
+        "type": "string",
+        "enum": ["sandbox", "live"],
+        "default": "sandbox",
+        "description": "Nevermined environment to connect to"
+      },
+      "planId": {
+        "type": "string",
+        "description": "Default payment plan ID (required for subscriber tools)"
+      },
+      "agentId": {
+        "type": "string",
+        "description": "Default agent ID (required for multi-agent plans)"
+      },
+      "creditsPerRequest": {
+        "type": "number",
+        "default": 1,
+        "description": "Number of credits consumed per request"
+      }
     }
-  },
-  "uiHints": {
-    "nvmApiKey": {
-      "sensitive": true,
-      "label": "Nevermined API Key",
-      "placeholder": "sandbox:eyJhbG... (or use /nvm-login)"
-    },
-    "environment": {
-      "label": "Environment"
-    },
-    "planId": {
-      "label": "Plan ID",
-      "placeholder": "did:nv:..."
-    },
-    "agentId": {
-      "label": "Agent ID",
-      "placeholder": "did:nv:..."
-    }
-  },
-  "commands": [
-    {
-      "name": "nvm-login",
-      "description": "Authenticate with Nevermined via browser login"
-    },
-    {
-      "name": "nvm-logout",
-      "description": "Log out from Nevermined"
-    }
-  ],
-  "skills": ["skills/nevermined/SKILL.md"],
-  "gateway": {
-    "methods": [
-      "nevermined.login",
-      "nevermined.logout",
-      "nevermined.checkBalance",
-      "nevermined.getAccessToken",
-      "nevermined.orderPlan",
-      "nevermined.queryAgent",
-      "nevermined.registerAgent",
-      "nevermined.createPlan",
-      "nevermined.listPlans"
-    ]
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nevermined-io/openclaw-plugin",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "description": "OpenClaw plugin for Nevermined — exposes subscriber and builder tools as gateway methods",
   "type": "module",
   "main": "./dist/index.js",
@@ -15,6 +15,7 @@
     "dist/",
     "openclaw.plugin.json",
     "skills/",
+    "docs/",
     "README.md"
   ],
   "scripts": {
@@ -45,6 +46,11 @@
     "url": "https://github.com/nevermined-io/payments.git",
     "directory": "openclaw"
   },
+  "openclaw": {
+    "extensions": [
+      "./dist/index.js"
+    ]
+  },
   "keywords": [
     "nevermined",
     "openclaw",