Skip to content

Adding an openclaw plugin for RAG#573

Merged
shubhadeepd merged 2 commits into
developfrom
dev/nsingal/adding-openclaw-plugin
May 21, 2026
Merged

Adding an openclaw plugin for RAG#573
shubhadeepd merged 2 commits into
developfrom
dev/nsingal/adding-openclaw-plugin

Conversation

@niyatisingal
Copy link
Copy Markdown
Collaborator

@niyatisingal niyatisingal commented May 19, 2026

Description

Checklist

  • I am familiar with the Contributing Guidelines.
  • All commits are signed-off (git commit -s) and GPG signed (git commit -S).
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.
  • If adjusting docker-compose.yaml environment variables have you ensured those are mimicked in the Helm values.yaml file.

Summary by CodeRabbit

  • New Features

    • Introduced RAG Claw plugin for OpenClaw, enabling NVIDIA RAG Blueprint integration
    • Added comprehensive installation guide with prerequisites, build instructions, and verification steps
  • Documentation

    • Added setup and usage documentation for workspace configuration
    • Included agent behavior guidelines, bootstrap process, and service endpoint references
    • Added identity and foundational guidelines for agent personality

Review Change Stack

@niyatisingal niyatisingal self-assigned this May 19, 2026
@niyatisingal niyatisingal force-pushed the dev/nsingal/adding-openclaw-plugin branch from 66e8fcd to 74c9328 Compare May 19, 2026 10:31
@niyatisingal niyatisingal changed the title Adding an openclaw plugin Adding an openclaw plugin for RAG May 19, 2026
@niyatisingal
Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 19, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 19, 2026

Warning

.coderabbit.yaml has a parsing error

The CodeRabbit configuration file in this repository has a parsing error and default settings were used instead. Please fix the error(s) in the configuration file. You can initialize chat with CodeRabbit to get help with the configuration file.

💥 Parsing errors (1)
Validation error: Invalid regex pattern for base branch. Received: "release-**" at "reviews.auto_review.base_branches[2]"
⚙️ Configuration instructions
  • Please see the configuration documentation for more information.
  • You can also validate your configuration using the online YAML validator.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Walkthrough

This PR introduces the OpenClaw RAG Claw plugin for the NVIDIA RAG Blueprint. It adds a complete plugin package with manifest, TypeScript initialization logic that sets up workspace templates and systemd Docker integration, comprehensive setup documentation, and agent workspace instruction templates for deployment and interaction workflows.

Changes

OpenClaw RAG Claw Plugin

Layer / File(s) Summary
Plugin manifest and build configuration
.openclaw/openclaw.plugin.json, .openclaw/package.json, .openclaw/tsconfig.json, .openclaw/.gitignore, skill-source/README.md
Plugin metadata, Node/OpenClaw version constraints, build orchestration with skill copying and TypeScript compilation, prepack/postpack staging for npm distribution, and ignore rules for build artifacts.
Plugin registration and initialization
.openclaw/index.ts
Entry point orchestrates workspace template copying with optional variant overlays, conditional agent-browser skill installation logging, and systemd drop-in creation to grant Docker group access to the gateway via sg docker wrapping.
Setup and usage documentation
.openclaw/README.md
Prerequisites, CLI onboarding, plugin build/install from repo or npm, skill verification, multiple interaction modes, long-running deploy guidance, health checks, optional browser skill, skills reference, and default service port mapping.
Agent workspace instruction templates
.openclaw/workspace/AGENTS.md, .openclaw/workspace/BOOTSTRAP.md, .openclaw/workspace/IDENTITY.md, .openclaw/workspace/SOUL.md, .openclaw/workspace/TOOLS.md
Agent identity and core principles; recurring session workflow, memory/safety/RAG tool routing, and deployment conventions; first-session bootstrap probe (repo, GPU, API key, Docker services) and setup context population.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested reviewers

  • nv-pranjald
  • shubhadeepd
  • kheiss-uwzoo

Poem

🐰 A plugin hops into the warren,
With templates, scripts, and setup bright,
RAG Claw claws its way to starlight,
While systemd doors swing open right,
The agent learns its way to flight! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and directly describes the main change: adding an OpenClaw plugin for RAG. It is concise and specific enough for teammates to understand the primary purpose of the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch dev/nsingal/adding-openclaw-plugin

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.openclaw/index.ts:
- Around line 102-104: The log message in api.logger.info currently hardcodes
"~/.openclaw/workspace"; change it to use the configured workspace path by
interpolating the runtime/config value instead of the literal string (replace
the hardcoded path in the api.logger.info call with the configured workspace
variable—e.g., config.workspace, workspacePath, or api.workspace—so the install
hint prints the actual workspace location).
- Around line 141-143: The embedded single-quoted shell command uses execStart
directly, which breaks if execStart contains single quotes; before interpolating
execStart into `ExecStart=/bin/sg docker -c '${execStart}'` escape single quotes
by replacing every ' with '\'' (i.e. "'\"'\"'") so the resulting string is safe
inside single quotes; update the code that constructs that array (the lines
using "ExecStart=" and `ExecStart=/bin/sg docker -c '${execStart}'`) to first
compute an escapedExecStart = execStart.replace(/'/g, "'\"'\"'") and interpolate
escapedExecStart instead.

In @.openclaw/README.md:
- Around line 114-118: The fenced code block that lists rag-blueprint, rag-eval,
and rag-perf is missing a language identifier which triggers MD040; update the
opening fence from ``` to ```text (or ```bash if it's intended as executable
output) so the block reads as a text fenced code block and resolves the markdown
lint warning for the block containing "rag-blueprint  Deploy, configure,
troubleshoot, and manage the NVIDIA RAG Blueprint", "rag-eval       Filesystem
RAG benchmarks...", and "rag-perf       Performance benchmarking...".

In @.openclaw/workspace/AGENTS.md:
- Around line 101-104: Remove the blank lines inside the blockquote chain so the
two consecutive blockquote lines become a continuous blockquote (no empty lines
between lines starting with ">"), i.e., merge the lines beginning with ">
**During long Docker pulls..." and "> **You have Docker access..." into
back-to-back blockquote lines to satisfy MD028.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: d35e1950-5674-4e15-a9e6-d75348aa8da1

📥 Commits

Reviewing files that changed from the base of the PR and between e699ad0 and 74c9328.

⛔ Files ignored due to path filters (1)
  • .openclaw/package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (12)
  • .openclaw/.gitignore
  • .openclaw/README.md
  • .openclaw/index.ts
  • .openclaw/openclaw.plugin.json
  • .openclaw/package.json
  • .openclaw/tsconfig.json
  • .openclaw/workspace/AGENTS.md
  • .openclaw/workspace/BOOTSTRAP.md
  • .openclaw/workspace/IDENTITY.md
  • .openclaw/workspace/SOUL.md
  • .openclaw/workspace/TOOLS.md
  • skill-source/README.md

Comment thread .openclaw/index.ts
Comment thread .openclaw/index.ts
Comment thread .openclaw/README.md Outdated
Comment thread .openclaw/workspace/AGENTS.md Outdated
@niyatisingal niyatisingal force-pushed the dev/nsingal/adding-openclaw-plugin branch 3 times, most recently from de0ed45 to 54b0ca0 Compare May 21, 2026 08:10
Signed-off-by: Niyati Singal <nsingal@nvidia.com>
@niyatisingal niyatisingal force-pushed the dev/nsingal/adding-openclaw-plugin branch from a147ccd to 1b8bda6 Compare May 21, 2026 08:16
@shubhadeepd shubhadeepd enabled auto-merge (squash) May 21, 2026 09:47
@shubhadeepd shubhadeepd disabled auto-merge May 21, 2026 09:56
@shubhadeepd shubhadeepd merged commit d041a39 into develop May 21, 2026
6 checks passed
@shubhadeepd shubhadeepd deleted the dev/nsingal/adding-openclaw-plugin branch May 21, 2026 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants