docs(cli): trim SKILL.md and emphasize CLI-first lookup#1286
Open
stefanjudis wants to merge 1 commit intomainfrom
Open
docs(cli): trim SKILL.md and emphasize CLI-first lookup#1286stefanjudis wants to merge 1 commit intomainfrom
stefanjudis wants to merge 1 commit intomainfrom
Conversation
Remove per-reference sub-command listings from SKILL.md so agents lean on `npx checkly skills <action>` for progressive disclosure instead of loading everything upfront.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reduces the always-loaded Checkly agent skill context and shifts detailed guidance to on-demand CLI lookups, making npx checkly skills the primary source of truth across releases.
Changes:
- Updates the skill description and replaces the intro with a “Required” CLI-first directive.
- Removes per-reference sub-command listings from the published
SKILL.mdto enforce progressive disclosure. - Simplifies
generateSkillCommands()by removing the inner references loop so generated output matches the trimmed docs.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| skills/checkly/SKILL.md | Trims always-loaded skill content and updates intro/description to direct agents to npx checkly skills first. |
| packages/cli/src/ai-context/skill.md | Updates the SKILL template to match the new CLI-first guidance and regenerated output. |
| packages/cli/scripts/prepare-ai-context.ts | Removes reference expansion from SKILL command generation while leaving reference generation for npx checkly skills <action> intact. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
|
@stefanjudis If you resolve the conflicts and rebase the branch, tests should pass again. Following that we can merge. |
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
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.
Affected Components
Notes for the Reviewer
Trims the always-loaded
SKILL.mdso agents lean onnpx checkly skills <action>for progressive disclosure instead of loading every sub-reference upfront.#### npx checkly skills <action> <ref>) fromSKILL.md.npx checkly skillsfirst, since the CLI is the source of truth and actions change between releases.descriptionto mention account plan, entitlements, and feature limits.referencesloop fromgenerateSkillCommands()inprepare-ai-context.tsand regeneratesskills/checkly/SKILL.mdto match.Tradeoff worth flagging: agents reading only
SKILL.mdno longer see hints likeconfigure api-checksdirectly — they have to runnpx checkly skills configureto discover sub-references. Intentional, since we want to serve as much as possible from the CLI.