Add readme notes on using the build-plugin skill#76
Open
andrewmumblebee wants to merge 1 commit into
Open
Conversation
📝 WalkthroughWalkthroughThe README adds a new section describing the Claude Code build-plugin skill, its workflow phases, required tools and tenant access, the ChangesClaude Code build-plugin documentation
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
🧩 Plugin PR Summaryℹ️ No plugins were modified in this PR. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 `@README.md`:
- Around line 46-65: Update the “Building with Claude Code (build-plugin skill)”
section in README to add the REST-only limitation: the build-plugin skill should
be described as applicable only to web API/REST-based plugins, and readers
should be told to stop or choose another path if the target service does not
expose a usable REST API. Keep the existing flow description, but adjust the
introductory text near the build-plugin mention so it does not imply the skill
works for non-REST integrations.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+46
to
+65
| ### Building with Claude Code (build-plugin skill) | ||
|
|
||
| If you have access to [Claude Code](https://claude.ai/code), the `build-plugin` skill can guide you through building a plugin from scratch — from exploring the API all the way to a deployed, tested plugin with dashboards. | ||
|
|
||
| **What it does** | ||
|
|
||
| The skill walks you through the full process in structured phases: | ||
|
|
||
| 1. Explores the target API and plans the plugin structure with you | ||
| 2. Scaffolds all the required files | ||
| 3. Deploys a working version of your plugin early, then pauses for you to authenticate it (OAuth, API key, or whatever the service uses) | ||
| 4. Tests imports and indexes objects so real data is flowing before the plugin is finished | ||
| 5. Builds and tests each data stream against live data as it goes | ||
| 6. Authors out-of-the-box dashboards | ||
|
|
||
| **Prerequisites** | ||
|
|
||
| - [Claude Code](https://claude.ai/code) installed | ||
| - The `squaredup` CLI installed and logged in (`npm i -g @squaredup/cli`, then `squaredup login`) | ||
| - A SquaredUp tenant where you can add and authenticate the plugin |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Add the REST-only scope caveat.
The upstream skill is explicitly limited to web API-based plugins and says to stop if the target tool has no usable REST API. Without that note, this README overstates when the skill applies.
Suggested patch
### Building with Claude Code (build-plugin skill)
If you have access to [Claude Code](https://claude.ai/code), the `build-plugin` skill can guide you through building a plugin from scratch — from exploring the API all the way to a deployed, tested plugin with dashboards.
+> [!NOTE]
+> This skill is for web API-based plugins only. If the target tool has no usable REST API, PowerShell may be a better fit.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| ### Building with Claude Code (build-plugin skill) | |
| If you have access to [Claude Code](https://claude.ai/code), the `build-plugin` skill can guide you through building a plugin from scratch — from exploring the API all the way to a deployed, tested plugin with dashboards. | |
| **What it does** | |
| The skill walks you through the full process in structured phases: | |
| 1. Explores the target API and plans the plugin structure with you | |
| 2. Scaffolds all the required files | |
| 3. Deploys a working version of your plugin early, then pauses for you to authenticate it (OAuth, API key, or whatever the service uses) | |
| 4. Tests imports and indexes objects so real data is flowing before the plugin is finished | |
| 5. Builds and tests each data stream against live data as it goes | |
| 6. Authors out-of-the-box dashboards | |
| **Prerequisites** | |
| - [Claude Code](https://claude.ai/code) installed | |
| - The `squaredup` CLI installed and logged in (`npm i -g @squaredup/cli`, then `squaredup login`) | |
| - A SquaredUp tenant where you can add and authenticate the plugin | |
| ### Building with Claude Code (build-plugin skill) | |
| If you have access to [Claude Code](https://claude.ai/code), the `build-plugin` skill can guide you through building a plugin from scratch — from exploring the API all the way to a deployed, tested plugin with dashboards. | |
| > [!NOTE] | |
| > This skill is for web API-based plugins only. If the target tool has no usable REST API, PowerShell may be a better fit. | |
| **What it does** | |
| The skill walks you through the full process in structured phases: | |
| 1. Explores the target API and plans the plugin structure with you | |
| 2. Scaffolds all the required files | |
| 3. Deploys a working version of your plugin early, then pauses for you to authenticate it (OAuth, API key, or whatever the service uses) | |
| 4. Tests imports and indexes objects so real data is flowing before the plugin is finished | |
| 5. Builds and tests each data stream against live data as it goes | |
| 6. Authors out-of-the-box dashboards | |
| **Prerequisites** | |
| - [Claude Code](https://claude.ai/code) installed | |
| - The `squaredup` CLI installed and logged in (`npm i -g `@squaredup/cli``, then `squaredup login`) | |
| - A SquaredUp tenant where you can add and authenticate the plugin |
🤖 Prompt for 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.
In `@README.md` around lines 46 - 65, Update the “Building with Claude Code
(build-plugin skill)” section in README to add the REST-only limitation: the
build-plugin skill should be described as applicable only to web API/REST-based
plugins, and readers should be told to stop or choose another path if the target
service does not expose a usable REST API. Keep the existing flow description,
but adjust the introductory text near the build-plugin mention so it does not
imply the skill works for non-REST integrations.
clarkd
approved these changes
Jun 25, 2026
clarkd
left a comment
clarkd
left a comment
Member
There was a problem hiding this comment.
I'll add this to the LCP Confluence Docs too - thank you!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📋 Summary
As title suggests
🔍 Scope of change
📚 Checklist
Summary by CodeRabbit