Skip to content

fix[skill]: consolidate into single self-contained SKILL.md#24

Closed
TimPietrusky wants to merge 1 commit intostablyai:masterfrom
TimPietrusky:fix/skill-consolidate-and-install
Closed

fix[skill]: consolidate into single self-contained SKILL.md#24
TimPietrusky wants to merge 1 commit intostablyai:masterfrom
TimPietrusky:fix/skill-consolidate-and-install

Conversation

@TimPietrusky
Copy link
Contributor

Summary

The skill was split across 4 files (SKILL.md + 3 reference docs) and was missing CLI installation instructions entirely, making it broken for first-time agent use. This PR consolidates everything into a single self-contained SKILL.md.

What changed:

  • Added install instructionscurl script + npm i -g so agents can guide users through installation
  • Split auth by platform — macOS (automatic via Desktop/Chrome) and Linux/Windows (manual) with clear headings instead of "fallback" wording
  • Added step-by-step parse-curl guide — tells users exactly what to look for in DevTools: filter for api, find requests to <workspace>.slack.com/api/ (e.g. api/client.counts), copy as cURL
  • One big command reference block — every command as a commented one-liner, easy to scan (follows the pattern from the runpodctl skill)
  • Merged reference docs — targets (URL format, G.../D... IDs, SLACK_WORKSPACE_URL env var), output (JSON shapes, download paths, default truncation values), and missing flags (--thread-ts, --cursor, repeatable --channel)
  • Removed reference filescommands.md, targets.md, output.md are no longer needed

Why a single file is better:

  • Agents load one file and have everything they need — no cross-referencing
  • Easier to maintain — one place to update
  • Tested on Linux with Claude Code — agent successfully guided through install, parse-curl auth, and all commands

Test plan

  • Tested skill loading in Claude Code
  • Tested Linux auth flow (parse-curl) guided by agent
  • Verified all commands from original reference docs are covered
  • Verified install instructions match README

Consolidate the skill into a single file by merging all reference docs
(commands.md, targets.md, output.md) into SKILL.md and removing them.

Changes:
- Add CLI installation instructions (curl script + npm)
- Split auth into macOS (automatic) and Linux/Windows (manual) sections
- Add step-by-step parse-curl guide (DevTools > filter "api" > copy cURL)
- Consolidate all commands into one big commented code block
- Merge targets reference (URL format, G.../D... IDs, SLACK_WORKSPACE_URL)
- Merge output reference (JSON shapes, download paths, default truncations)
- Add missing flags (--thread-ts, --cursor, repeatable --channel)
- Remove reference files (everything is now in SKILL.md)
@nwparker
Copy link
Contributor

nwparker commented Feb 20, 2026

Thanks for the consolidation work here. I ran a 3-agent review plus a source-grounded pass against the Agent Skills spec and Anthropic best-practices, then implemented the outcome in a standalone PR from master.

Implemented follow-up PR (new standalone PR):

Reasoning (consolidated):

  • Keep: install/setup guidance in SKILL.md (important for first-run reliability)
  • Keep: platform-specific auth guidance (macOS auto vs Linux/Windows manual paths)
  • Keep: short common-command block in SKILL.md
  • Do not fully collapse into one file: keep references/commands.md, references/targets.md, and references/output.md
  • Why: SKILL.md is fully loaded on activation; progressive disclosure keeps context cost lower and reduces drift risk for growing command surfaces
  • Enforcement: added scripts/check-docs-sync.sh and wired bun run docs:check into CI/release

Background research (uploaded):

Note: This is a triggered AI response.

@nwparker nwparker deleted the branch stablyai:master February 22, 2026 02:57
@nwparker nwparker closed this Feb 22, 2026
@nwparker
Copy link
Contributor

Sorry about this! I had to rename the default branch from main to master for npx skills compatibility, and unfortunately GitHub auto-closed this PR and won't allow reopening it.

The branch and commits are all still intact — if you'd like to continue, you can open a new PR targeting master. Apologies for the inconvenience!

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