embed-ui for RetailCRM extensions
@retailcrm/embed-ui
RetailCRM's official CLI and package set for interface extensions: project scaffolding, UI components, data contexts and ready MCP setup for agents
Low risk
We rate an entry low when it mostly gives the agent instructions and reference material.
Why this level
- Generates and edits only local extension project files; it does not talk to a live RetailCRM account directly
Install
In your terminal, with SkillFoxx CLI
npx skillfoxx add cli/retailcrm-embed-uiDetects the agents on your machine, checks the risk and pins the version.
Other ways to install
Install the tool
npm install -g @retailcrm/embed-uiRun npx @retailcrm/embed-ui init ./web to scaffold the extension project with dependencies, a widget template and MCP setup for v1-contexts and v1-endpoint, then open the project in Claude Code, which will pick up .mcp.json.
Other ways from the author
npx @retailcrm/embed-ui init ./web --package-manager yarnScaffolds the extension project with dependencies, configs and a starter template.
This is third-party code. Review the repository files before installing.
What it does
The @retailcrm/embed-ui package ships an embed-ui binary that scaffolds a RetailCRM extension frontend via npx: package.json, Vite, TypeScript and ESLint configs, starter files for an endpoint worker, a settings page and an order widget, and can add AGENTS.md, project-level skills under .agents/skills, and a .mcp.json for the v1-contexts and v1-endpoint packages. The separate v1-* packages provide UI components, reactive contexts for the RetailCRM JS API, an endpoint API for embedded pages, a sandbox for local testing, and base type declarations. The v1-contexts and v1-endpoint MCP resources give an agent AI-readable descriptions of available contexts, actions and widget embedding targets.
Who it is for. For developers building RetailCRM interface extensions who want an agent-friendly setup from the start.
Good fit when
- You are starting a RetailCRM interface extension from scratch
- You need to add v1-components, v1-contexts or v1-endpoint packages to an existing frontend
- You want MCP resources and skills so an agent understands RetailCRM contexts, actions and widget embedding targets
Not a fit when
- You need to work with RetailCRM data directly (orders, clients): this tool is for building the extensions themselves, not for CRM operations
- You need a non-Vue stack: init adds vue, pinia and vue-i18n dependencies
Example request
Scaffold a new RetailCRM extension in the web folder with an order-card widget and set up MCP for Claude CodeLimitations
The testing package is not yet added through the public init command. User-level MCP registration via codex mcp add is deliberately not automatic, to avoid conflicts between projects on different package versions; configs are generated at the project level. Junie is supported as a client config target but is not in the catalog's agent list.
How to disable. Remove .mcp.json, the .agents/skills directory and the @retailcrm/embed-ui* dependencies from the extension project.
Security check
- Generates and edits only local extension project files; it does not talk to a live RetailCRM account directly
README in short
The README lists the v1-components, v1-contexts, v1-endpoint, v1-sandbox, v1-testing and v1-types packages, describes the embed-ui CLI with init, init-skills and version-update commands, walks through init's default behavior and the flags controlling files, dependencies, AGENTS.md, project-level skills and MCP setup, and explains the .mcp.json format for Claude Code project scope plus client config generation for Codex, Cursor, Junie and VS Code.
FAQ
What does init-skills create separately from init?
Only project-level skills in .agents/skills/*, without touching dependencies, templates or AGENTS.md, for when you need to update them on their own.
How do I get configs for Cursor or Codex?
With the --mcp-client-configs codex,cursor,junie,vscode flag on init; these are not created by default since they often carry manual edits.
Related
A skills library that gives coding agents a development process: brainstorming, planning, TDD, subagents and code review
Skills for real engineers by Matt Pocock
Skills For Real Engineers
Small composable skills for engineering with agents: plan grilling, TDD, bug diagnosis, code review and architecture
GitHub toolkit for spec-driven development: the specify CLI adds agent commands and skills to a project, from principles to implementation
Reference MCP servers
Model Context Protocol servers
Official reference MCP servers: Filesystem, Fetch, Git, Memory, Sequential Thinking, Time and Everything