Repository navigation
feat: publish a standalone setup skill for workos.com/SKILL.md - #66
Merged
Merged
Conversation
Add well-known/setup/SKILL.md, a self-contained workos-setup skill that condenses the router's "Start here" section for agents fetching a single URL. The release build validates its frontmatter and attaches it as SKILL.md, which workos.com proxies from the latest release. It sits two directories deep, outside plugins/, so neither the plugins nor `npx skills add workos/skills` install it alongside the router.
 [Medium impact] The PR appears safe to merge, with both previous concerns addressed and no new actionable issues found. SummaryAdds a standalone
No new actionable issues were found. Tests were inspected but not run. Reviews (2) · Last reviewed commit: "fix: verify outside sign-in and test the..." · Reviewed by Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
The setup skill now checks sign-in started outside the app (invitations and password-reset emails reach the Initiate login URI), points agents at the URLs the installer left unset, and requires reporting any that remain, matching the router's completion checklist. The build spec now runs scripts/build-well-known.ts with the release workflow's arguments, so it fails if the release stops publishing SKILL.md. Nothing imports the script any more, so drop its exports.
Member
Author
|
@greptileai review |
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.
Why
workos.com should have one URL a user can paste into a coding agent ("Add WorkOS to my app: workos.com/SKILL.md"). I first drafted that skill as a string in the workos.com worker (workos/workos#77892). But it condenses the router's "Start here" section, so it belongs here, next to what it summarizes, reviewed and released with it.
well-known/setup/SKILL.mdis a self-containedworkos-setupskill. It covers the plan to confirm with the user,WORKOS_MODE=agent npx workos@latest install, the router's completion checks, andprofile claimonly when a new environment was created. The checks are sign-in, sign-out, and a sign-in started outside the app through the Initiate login URI, plus reporting any URL settings the installer left unfinished. It links to absolute URLs for everything else.SKILL.mdnext toindex.json. workos/workos#77892 proxiesworkos.com/SKILL.mdfromreleases/latest/download/SKILL.md.plugins/. The plugins don't ship it, it isn't in the well-known index, andnpx skills add workos/skills(which only scans top-level folders once it finds skills) still installs justworkosandworkos-widgets.accountless-install.spec.tsnow covers it too: install leads the description and body, the first code block is the agent-mode install, Verify keeps the outside-sign-in and unfinished-settings checks, and it claims withprofile claimlike the router. AGENTS.md says to update it alongside "Start here".Proof
npx skills add <this checkout> --liststill finds exactly 2 skills:workosandworkos-widgets.build-well-known.spec.tsnow runs the script with the release workflow's arguments. It writesindex.json, both archives andSKILL.md, byte-identical towell-known/setup/SKILL.md. Deleting thecopySetupSkill(...)call from the entrypoint fails the spec.wrangler dev, parsed as theworkos-setupskill withnpx skills add http://localhost:8787/SKILL.md --list. The text only changed afterwards to use this repo'sinstallandprofile claimspellings.workos0.24.0 (--helpforinstall,profile claim,doctor,auth login).