Setup guides for MCP servers behind the Speakeasy AI Control Plane.
Each guide lives in guides/<slug>/
(research.md, meta.yaml,
external.md, speakeasy.md).
Guides ·
Factory ·
Go SDK
- Open an issue — freeform title/body (docs URLs, “prefer OAuth”, etc. optional).
- Add the label
guide:draft. - Wait for comments + a draft or ready-for-review PR (
guide/issue-<N>-<slug>).
How it works (labels, scope checks, Decisions, resume): FACTORY.md.
Requires Node ≥ 22.13 and a Cursor API key.
export CURSOR_API_KEY=cursor_... # Dashboard → Integrations / API Keys
# Optional — resolve Speakeasy catalog presence (same as mise run pull-catalog):
# export PULSE_REGISTRY_KEY=...
# export PULSE_REGISTRY_TENANT=gram-recommended
# From repo root (installs deps as needed):
mise run draft-guide -- box --overwrite
mise run draft-guide -- box --overwrite --notes "prefer ADC docs"
mise run draft-guide -- x --overwrite --pause-on-scope
# Or:
cd pipeline && npm install
npm run draft-guide -- box --overwriteExit codes: 0 converged · 2 unconverged/blocked/failed · 3 awaiting scope
(--pause-on-scope). Pass --help for flags. Run records land in retro/runs/.
Lint without drafting: mise run lint-guide -- box.
FACTORY.md— factory operator guidedoctrine/— pipeline doctrine (start withshared.md)doctrine/personas/— audience voicedoctrine/glossary.md— vocabulary/tune-pipeline— retro signal → doctrine proposals (Claude Code skill)