Skip to main content
This is the recommended way to work with the Orderly SDK for plugin authoring, integration, and Marketplace submission, especially when you use an AI coding agent (Cursor, Claude Code, Codex, OpenCode, etc.). The idea is simple: install the official Orderly plugin skills once, pair them with the Orderly SDK Docs MCP server, and let the agent follow consistent playbooks instead of rediscovering devkit flags and SDK APIs from scratch every time.

​
Why skills + MCP matter

Skills do not replace the CLI or the SDK—they steer you (and your agent) toward orderly-devkit, registerPlugin, and @orderly.network/* packages correctly.

​
What gets installed

The devkit’s default skills catalog resolves to OrderlyNetwork/orderly-skills (see the @orderly.network/devkit package for the default repo constant). orderly-devkit skills install installs four skills by default: Each skill’s playbook lives in that repo under skills/<skill-id>/SKILL.md (plus reference.md where present). Treat this handbook as the human-facing companion; treat skills as the agent-facing playbooks.

​
One-time setup (developer machine)

  1. Devkit (command runner):
  2. Plugin skills (agent playbooks + triggers):
    For options (--skill, custom source, npx forwarding), see CLI: skills install.
  3. Orderly SDK Docs MCP (API truth for @orderly.network/* while coding or in chat):
    See MCP reference. Plugin authors should prefer orderly_docs_search then orderly_docs_get_component / orderly_docs_get_type; older notes may reference a non-existent orderly_docs_get_hook—see Agent skills alignment.
Use this order for a new plugin from zero → running in a host → Marketplace:
  1. Create — Run orderly-devkit create plugin (interactive or --no-interactive). Skill orderly-plugin-create encodes naming (PascalCase name, plugin id rules) and --interceptor choices.
  2. Write — Edit generated code; use MCP for @orderly.network/hooks, @orderly.network/ui, interceptor (Original, props, api) => ReactNode. Skill orderly-plugin-write covers patterns (wrapper vs inner component for Hooks).
  3. Add — Add dependency and plugins={[registerXxx()]} on OrderlyAppProvider. Skill orderly-plugin-add stresses locating the provider first.
  4. Submit — orderly-devkit login, submit --dry-run, then submit; polish usagePrompt. Skill orderly-plugin-submit gates destructive steps on user confirmation.
Human tutorials: T1 First plugin → T2 Integrate host → T3 Marketplace.

​
How the agent is supposed to use this

  • User intent (“I want a plugin that …”) should match a skill by description/triggers so the right playbook loads.
  • CLI is invoked as orderly-devkit (bin name for @orderly.network/devkit).
  • Docs for symbols and props come from MCP, not from memory—skills explicitly call this out for orderly-plugin-write.
  • Marketplace steps require explicit user confirmation before submit—see orderly-plugin-submit skill rules.

​
When you are not using an agent

You can still follow this handbook and the CLI alone: read the same four stages above and use CLI reference; install @orderly.network/plugin-core from npm for the full GUIDE/TECH. Installing skills is optional but keeps your future AI sessions aligned with Orderly’s intended flows.

​
See also