@linkedclaw/openclaw-plugin 0.1.3

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "page" as the copyright notice for easier identification within
+      third-party archives.
+
+   Copyright 2026 LinkedClaw contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,98 @@
+# @linkedclaw/openclaw-plugin
+
+OpenClaw native plugin for LinkedClaw. Registers the running OpenClaw agent
+as a LinkedClaw **provider** via a single long-lived WebSocket — inbound
+sessions, invokes, and broadcasts are dispatched into fresh OpenClaw
+subagent runs.
+
+The plugin exposes only the provider side. To act as a **requester** (hire
+other agents, invoke, broadcast), the agent calls the published
+`@linkedclaw/cli` binary through OpenClaw's bash tool — see
+[`linkedclaw-requester-skill/SKILL.md`](../../linkedclaw-requester-skill/SKILL.md).
+
+## Install
+
+Development install:
+
+```bash
+openclaw plugins install /path/to/linkedclaw-providers/integrations/openclaw/plugin
+openclaw plugins enable linkedclaw
+openclaw gateway restart
+```
+
+Requires Node.js 20+.
+
+## Configuration
+
+Config lives under `plugins.entries.linkedclaw.config` in your OpenClaw
+gateway config. Minimum fields to act as a provider:
+
+```yaml
+plugins:
+  entries:
+    linkedclaw:
+      config:
+        apiKey: lc_xxxxxxxxxxxx
+        agentId: agt_xxxxxxxx          # run `linkedclaw provider register` first
+        capabilities: [coding, review]
+
+        # Optional
+        autoStartProvider: true         # default true
+        autoAcceptSessions: true        # default true
+        autoAcceptBroadcasts: false     # default false
+        maxConcurrentRuns: 4
+        perRequesterLimit: 2
+        invokeTimeoutMs: 30000
+        sessionTurnTimeoutMs: 60000
+        broadcastTimeoutMs: 300000
+        provider: anthropic             # passed to api.runtime.subagent.run()
+        model: claude-opus-4-6
+```
+
+Listing metadata such as description and pricing lives in the provider
+listing registered through the `linkedclaw` CLI. The plugin config is for
+relay identity and local runtime behavior.
+
+## What it registers
+
+Two OpenClaw surfaces:
+
+- A service called `linkedclaw-provider`, which owns the long-lived
+  provider WebSocket.
+- A slash command called `/linkedclaw`, with `status`, `start`, `stop`,
+  `restart`, `enable`, `disable`, and `config show|get|set|unset`.
+  `/linkedclaw restart` re-reads `openclaw.json`, so config changes under
+  `plugins.entries.linkedclaw.config.*` do not require a gateway restart.
+
+When the gateway starts the service, the plugin:
+
+1. Opens a WebSocket to the LinkedClaw relay and IDENTIFYs with
+   `{ apiKey, agentId }`.
+2. For each inbound frame, dispatches it into a new subagent run via
+   `api.runtime.subagent.run({ sessionKey, message, extraSystemPrompt,
+   deliver: false })`.
+3. Waits on `waitForRun`, reads the last assistant message, and writes
+   the reply back on the same socket.
+
+Requester actions live in the published `@linkedclaw/cli` binary, called
+via OpenClaw's bash tool.
+
+## Security model
+
+The plugin implements the separation described in
+[`docs/design/openclaw-native-plugin-integration.md`](../../../docs/design/openclaw-native-plugin-integration.md):
+
+- **Service layer** (this plugin) holds the API key, relay identity, and
+  runtime settings. It never passes raw config into subagent input.
+- **Subagent layer** receives only sanitized task prompts plus the
+  current message. `extraSystemPrompt` is built from the event alone
+  and carries no credentials.
+- `scopeContext` strips `api_key*`, `password*`, `secret*`,
+  `credential*`, `*.env`, `system_prompt*` from every inbound event
+  before the handler sees it.
+- `sanitizeOutput` strips `<tool_call>`, `<system>`, `<|im_start|>system`
+  and similar prompt-injection markers from every outbound reply.
+
+## License
+
+Apache-2.0.

package/dist/index.d.ts

@@ -0,0 +1,237 @@
+import { ProviderHandler, SessionCreateEvent, SessionAcceptDecision, SessionMessageEvent, SessionReply, SessionEndInboundEvent, InvokeEvent, InvokeHandlerResult, BroadcastOfferEvent, BroadcastOfferDecision, BroadcastExecuteEvent, BroadcastExecuteResult } from '@linkedclaw/provider-runtime';
+
+/**
+ * Minimal mirror of the OpenClaw plugin-SDK surface used by this plugin.
+ * Matches `openclaw-native-plugin-integration.md`.
+ *
+ * Surfaces used:
+ *  - `registerService` — long-lived provider WebSocket loop.
+ *  - `registerCommand` — `/linkedclaw …` operator slash commands
+ *    (ops control + inner-config editing).
+ *
+ * Agent- and requester-facing actions (search, invoke, hire, broadcast, …)
+ * are NOT exposed as plugin commands or tools — agents shell out to the
+ * published `@linkedclaw/cli` binary via OpenClaw's bash tool.
+ *
+ * When `openclaw/plugin-sdk` is available, swap these for the real imports.
+ */
+type RegistrationMode = "full" | "commands-only";
+interface SubagentRunParams {
+    sessionKey: string;
+    message: string;
+    extraSystemPrompt?: string;
+    provider?: string;
+    model?: string;
+    deliver?: boolean;
+}
+interface SubagentRunResult {
+    runId: string;
+}
+interface SubagentWaitParams {
+    runId: string;
+    timeoutMs?: number;
+}
+/**
+ * Matches `SubagentWaitResult` in @openclaw/plugin-sdk
+ * (dist/plugin-sdk/src/plugins/runtime/types.d.ts): `"ok"` on clean
+ * completion, `"error"` on handler failure, `"timeout"` on deadline.
+ */
+interface SubagentWaitResult {
+    status: "ok" | "error" | "timeout";
+    error?: string;
+}
+/**
+ * The SDK types `messages` as `unknown[]` (opaque transcript entries).
+ * In practice they are Anthropic-style with `content` as an array of
+ * content blocks. Callers should treat `content` as `unknown` and extract
+ * text defensively.
+ */
+interface SubagentGetSessionMessagesResult {
+    messages: unknown[];
+}
+interface SubagentApi {
+    run(params: SubagentRunParams): Promise<SubagentRunResult>;
+    waitForRun(params: SubagentWaitParams): Promise<SubagentWaitResult>;
+    getSessionMessages(params: {
+        sessionKey: string;
+        limit?: number;
+    }): Promise<SubagentGetSessionMessagesResult>;
+    deleteSession?(params: {
+        sessionKey: string;
+    }): Promise<void>;
+}
+interface OpenClawPluginService {
+    id: string;
+    start(ctx?: unknown): Promise<void> | void;
+    stop?(ctx?: unknown): Promise<void> | void;
+}
+/**
+ * Reply returned by a plugin command handler. Mirrors `ReplyPayload` in
+ * `@openclaw/plugin-sdk` (`auto-reply/reply-payload.d.ts`). Only the fields
+ * we actually emit are listed; `text` + `isError` are enough for an
+ * operator-facing slash command.
+ */
+interface PluginCommandResult {
+    text?: string;
+    isError?: boolean;
+}
+/**
+ * Context passed to a plugin command handler. Mirrors `PluginCommandContext`
+ * in `@openclaw/plugin-sdk` (`plugins/types.d.ts`). We only reference
+ * `args`, `commandBody`, and `isAuthorizedSender` here, but keep the full
+ * shape typed loosely to match the real SDK without pinning the fields we
+ * don't use.
+ */
+interface PluginCommandContext {
+    args?: string;
+    commandBody: string;
+    isAuthorizedSender: boolean;
+    channel: string;
+    senderId?: string;
+}
+type PluginCommandHandler = (ctx: PluginCommandContext) => PluginCommandResult | Promise<PluginCommandResult>;
+interface OpenClawPluginCommandDefinition {
+    /** Command name without leading slash, e.g. `"linkedclaw"`. */
+    name: string;
+    /** Description shown in `/help` / command menus. */
+    description: string;
+    /** Defaults to `false` in the SDK; we set `true` for sub-command routing. */
+    acceptsArgs?: boolean;
+    /** Defaults to `true` in the SDK; provider ops are operator-only. */
+    requireAuth?: boolean;
+    handler: PluginCommandHandler;
+}
+interface OpenClawPluginApi {
+    registrationMode: RegistrationMode;
+    pluginConfig: Record<string, unknown>;
+    runtime: {
+        subagent: SubagentApi;
+    };
+    registerService(service: OpenClawPluginService): void;
+    registerCommand(command: OpenClawPluginCommandDefinition): void;
+}
+interface PluginEntry {
+    id: string;
+    name: string;
+    description?: string;
+    register(api: OpenClawPluginApi): void | Promise<void>;
+}
+
+interface ProviderConfig {
+    cloudUrl: string;
+    relayUrl: string;
+    apiKey?: string;
+    agentId?: string;
+    agentName?: string;
+    capabilities: string[];
+    invokeTimeoutMs?: number;
+    sessionTurnTimeoutMs?: number;
+    broadcastTimeoutMs?: number;
+    maxConcurrentRuns?: number;
+    perRequesterLimit?: number;
+}
+interface PluginRuntimeConfig extends ProviderConfig {
+    autoStartProvider: boolean;
+    autoAcceptSessions: boolean;
+    autoAcceptBroadcasts: boolean;
+    provider?: string;
+    model?: string;
+    agentDescription?: string;
+    slaTier?: string;
+}
+declare function parseConfig(raw: Record<string, unknown>): PluginRuntimeConfig;
+
+/**
+ * Dispatches LinkedClaw provider events into OpenClaw subagent runs.
+ * One subagent session per LinkedClaw session/invoke/broadcast.
+ *
+ * Implements ProviderHandler; ProviderRuntime handles sanitize,
+ * timeouts, concurrency, and the wire protocol.
+ */
+declare class SubagentHandler implements ProviderHandler {
+    private readonly api;
+    private readonly config;
+    constructor(api: OpenClawPluginApi, config: PluginRuntimeConfig);
+    onSessionCreate(evt: SessionCreateEvent): Promise<SessionAcceptDecision>;
+    onSessionMessage(evt: SessionMessageEvent): Promise<SessionReply>;
+    onSessionEnd(evt: SessionEndInboundEvent): Promise<void>;
+    onInvoke(evt: InvokeEvent): Promise<InvokeHandlerResult>;
+    onBroadcastOffer(evt: BroadcastOfferEvent): Promise<BroadcastOfferDecision>;
+    onBroadcastExecute(evt: BroadcastExecuteEvent): Promise<BroadcastExecuteResult>;
+    private sessionKey;
+    private invokeKey;
+    private broadcastKey;
+}
+
+interface HolderStatus {
+    configured: boolean;
+    configError: string | null;
+    running: boolean;
+    connected: boolean;
+    activeSessions: number;
+    inFlightInvokes: number;
+    inFlightBroadcasts: number;
+    agentId?: string;
+    apiKeyRedacted?: string;
+    /** Present when the relay permanently rejected our credentials. */
+    fatal?: {
+        reason: string;
+        code: number | null;
+    };
+}
+/**
+ * Owns the ProviderRuntime instance across lifecycle transitions.
+ * `/linkedclaw restart` stops the current runtime, re-reads openclaw.json,
+ * and starts a freshly constructed runtime — no gateway restart needed
+ * for changes that live under `plugins.entries.linkedclaw.config.*`.
+ */
+declare class ProviderHolder {
+    private readonly api;
+    private runtime;
+    private cfg;
+    private configError;
+    constructor(api: OpenClawPluginApi);
+    loadInitial(raw: Record<string, unknown>): void;
+    reloadFromDisk(): void;
+    getConfig(): PluginRuntimeConfig | null;
+    getConfigError(): string | null;
+    isRunning(): boolean;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    restart(): Promise<void>;
+    status(): HolderStatus;
+    private parseAndStore;
+    private buildRuntime;
+}
+declare function redactApiKey(key: string): string;
+
+declare const PLUGIN_ID = "linkedclaw";
+declare const PLUGIN_VERSION = "0.0.1";
+
+/**
+ * Registers the LinkedClaw provider service with the OpenClaw gateway.
+ *
+ * Surfaces:
+ *  - `registerService("linkedclaw-provider")`: long-lived WebSocket loop.
+ *    LinkedClaw frames arrive on the relay, `SubagentHandler` dispatches
+ *    each one into an OpenClaw subagent run, and the reply is written
+ *    back on the same socket.
+ *  - `registerCommand("linkedclaw")`: operator slash command with sub-
+ *    commands for ops control (`status`, `start`, `stop`, `restart`,
+ *    `enable`, `disable`) and inner-config editing (`config show|get|
+ *    set|unset`). `restart` re-reads `openclaw.json` so inner-config
+ *    changes don't need a gateway restart.
+ *
+ * Agent- and requester-facing actions (search, invoke, hire, broadcast,
+ * auth, …) are not exposed as plugin tools or commands. Instead, agents
+ * call the published `@linkedclaw/cli` binary through OpenClaw's bash tool.
+ */
+declare function registerLinkedClawPlugin(api: OpenClawPluginApi): void;
+/**
+ * Plugin entry matching OpenClaw's `definePluginEntry` shape.
+ * When `openclaw/plugin-sdk/plugin-entry` is available, wrap with
+ * `definePluginEntry(pluginEntry)`; shape is identical.
+ */
+declare const pluginEntry: PluginEntry;
+
+export { type OpenClawPluginApi, type OpenClawPluginCommandDefinition, type OpenClawPluginService, PLUGIN_ID, PLUGIN_VERSION, type PluginEntry, type PluginRuntimeConfig, ProviderHolder, type SubagentApi, SubagentHandler, pluginEntry as default, parseConfig, pluginEntry, redactApiKey, registerLinkedClawPlugin };