@feimacode/open-design-agent-kit-mcp 0.1.7 → 0.1.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +19 -26
  2. package/out/index.js +127769 -2006
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -18,21 +18,21 @@ Four of the ~280 vendored skills and templates, rendered exactly as-is:
18
18
  <table>
19
19
  <tr>
20
20
  <td width="50%" valign="top">
21
- <img src="../../docs/screenshots/examples/dating-web.png" alt="Consumer dating-app dashboard, editorial typography" width="100%"/><br/>
21
+ <img src="https://raw.githubusercontent.com/feimacode/open-design-agent-kit/main/docs/screenshots/examples/dating-web.png" alt="Consumer dating-app dashboard, editorial typography" width="100%"/><br/>
22
22
  <sub><b>"Design a dating-site dashboard — mutuals, match rate, a 30-day trend."</b></sub>
23
23
  </td>
24
24
  <td width="50%" valign="top">
25
- <img src="../../docs/screenshots/examples/gamified-app.png" alt="Gamified habit-tracking mobile app, three phone frames" width="100%"/><br/>
25
+ <img src="https://raw.githubusercontent.com/feimacode/open-design-agent-kit/main/docs/screenshots/examples/gamified-app.png" alt="Gamified habit-tracking mobile app, three phone frames" width="100%"/><br/>
26
26
  <sub><b>"A habit-tracking app with daily quests and XP."</b></sub>
27
27
  </td>
28
28
  </tr>
29
29
  <tr>
30
30
  <td width="50%" valign="top">
31
- <img src="../../docs/screenshots/examples/deck-swiss-international.png" alt="Board strategy deck, Swiss International style" width="100%"/><br/>
31
+ <img src="https://raw.githubusercontent.com/feimacode/open-design-agent-kit/main/docs/screenshots/examples/deck-swiss-international.png" alt="Board strategy deck, Swiss International style" width="100%"/><br/>
32
32
  <sub><b>"A board-ready strategy deck, Swiss International style."</b></sub>
33
33
  </td>
34
34
  <td width="50%" valign="top">
35
- <img src="../../docs/screenshots/examples/card-xiaohongshu.png" alt="Xiaohongshu-style swipeable knowledge card" width="100%"/><br/>
35
+ <img src="https://raw.githubusercontent.com/feimacode/open-design-agent-kit/main/docs/screenshots/examples/card-xiaohongshu.png" alt="Xiaohongshu-style swipeable knowledge card" width="100%"/><br/>
36
36
  <sub><b>"5 tips, as a Xiaohongshu-style swipeable card carousel."</b></sub>
37
37
  </td>
38
38
  </tr>
@@ -54,7 +54,7 @@ That's a plain stdio MCP server. Register it with your agent:
54
54
  claude mcp add open-design -- npx -y @feimacode/open-design-agent-kit-mcp
55
55
  ```
56
56
 
57
- Or install the [Claude Code plugin](https://github.com/feimacode/open-design-agent-kit#ways-to-use-it) instead — it registers this server automatically and adds 23 curated `/open-design:*` skills on top.
57
+ Or install the [Claude Code plugin](https://github.com/feimacode/open-design-agent-kit/blob/main/docs/getting-started/claude-code.md) instead: it registers this server automatically and adds the Open Design skills on top.
58
58
 
59
59
  **Codex CLI**
60
60
 
@@ -70,7 +70,7 @@ command = "npx"
70
70
  args = ["-y", "@feimacode/open-design-agent-kit-mcp"]
71
71
  ```
72
72
 
73
- See [docs/codex.md](https://github.com/feimacode/open-design-agent-kit/blob/main/docs/codex.md) for the matching `SKILL.md` you can copy into `.agents/skills/open-design/`.
73
+ Or run `npx @feimacode/open-design-agent-kit init --tools codex` to add the matching skills too. See [Codex setup](https://github.com/feimacode/open-design-agent-kit/blob/main/docs/getting-started/codex.md).
74
74
 
75
75
  **Any other MCP host** — the generic config shape:
76
76
 
@@ -85,30 +85,23 @@ See [docs/codex.md](https://github.com/feimacode/open-design-agent-kit/blob/main
85
85
  }
86
86
  ```
87
87
 
88
- ## Tools
88
+ ## Tools and prompts
89
89
 
90
- | Tool | Does |
91
- |---|---|
92
- | `list_open_design_skills` | Browse skills, design templates, and remixable examples — filter by free-text query or an exact mode (`prototype`, `deck`, `design-system`, `image`, `video`, `template`, `utility`, `audio`). |
93
- | `list_open_design_design_systems` | Browse the ~152 brand design systems — filter by query or category. |
94
- | `prepare_open_design_brief` | Compose generation instructions from a skill, an optional design system, and your brief. Writes nothing — you author the file(s) yourself, then register them. |
95
- | `register_open_design_artifact` | Validate an artifact you've written and record its manifest sidecar (`<entry>.artifact.json`). |
96
- | `get_open_design_artifact` | Read back a registered artifact's manifest, entry content, and any open comments. |
97
- | `set_active_design_system` | Set (or clear) the workspace's active design system, used automatically by `prepare_open_design_brief`. |
98
- | `create_open_design_design_system` | Compose instructions to author a new `DESIGN.md`, optionally seeded from a reference URL's colors/fonts. |
99
- | `port_open_design_artifact_to_app` | Compose instructions to port a finished artifact into your real app as idiomatic production code. |
100
- | `remix_open_design_example` | Copy a curated example artifact into the workspace as a starting point, and get instructions to modify — not regenerate — it. |
90
+ 11 tools, the same as the VS Code extension's (minus community sharing):
101
91
 
102
- JSON Schemas mirror the VS Code extension's `languageModelTools` 1:1 — see [`src/index.ts`](https://github.com/feimacode/open-design-agent-kit/blob/main/packages/mcp-server/src/index.ts) for the exact shapes.
92
+ - **Catalog:** `list_open_design_skills`, `list_open_design_design_systems`
93
+ - **Generating:** `prepare_open_design_brief`, `register_open_design_artifact`, `get_open_design_artifact`, `remix_open_design_example`
94
+ - **Design systems:** `set_active_design_system`, `create_open_design_design_system`
95
+ - **Beyond the prototype:** `port_open_design_artifact_to_app`, `pull_open_design_figma_frame`
96
+ - **Export:** `export_open_design_artifact` (PNG/JPEG, deck PowerPoint/PDF, page PDF; needs an installed Chrome, Edge or Chromium)
103
97
 
104
- ## Configuration
98
+ MCP prompts: `open-design-social-post`, and one `od-<mode>-<id>` prompt per remixable example.
99
+
100
+ Arguments, results and errors: [tools reference](https://github.com/feimacode/open-design-agent-kit/blob/main/docs/reference/tools.md). Prompts: [prompts and commands](https://github.com/feimacode/open-design-agent-kit/blob/main/docs/reference/prompts-and-commands.md#claude-code).
105
101
 
106
- | Environment variable | Default | |
107
- |---|---|---|
108
- | `OPEN_DESIGN_WORKSPACE_ROOT` | the launching process's `cwd` | Where artifacts get written and `.open-design/config.json` (active design system) is read/written. |
109
- | `OPEN_DESIGN_OUTPUT_DIR` | `.open-design` | Workspace-relative directory new artifacts are suggested under. |
102
+ ## Configuration
110
103
 
111
- Both Claude Code and Codex already launch a local stdio MCP server with `cwd` set to the active project, so the default is usually right — the override exists for testing or an unusual host.
104
+ Zero config by default. The server works in the directory your agent starts it in. Optional environment variables (`OPEN_DESIGN_WORKSPACE_ROOT`, `OPEN_DESIGN_OUTPUT_DIR`, `OPEN_DESIGN_FIGMA_TOKEN`, `OPEN_DESIGN_BROWSER_PATH`) are described in [settings and environment variables](https://github.com/feimacode/open-design-agent-kit/blob/main/docs/reference/settings-and-env.md#environment-variables).
112
105
 
113
106
  ## What's not here
114
107
 
@@ -116,7 +109,7 @@ Live preview, inline comments, and WYSIWYG editing are webview-based and stay VS
116
109
 
117
110
  ## More
118
111
 
119
- Full project layout, how content is vendored/synced, and development instructions live in the [main repo](https://github.com/feimacode/open-design-agent-kit).
112
+ [Documentation](https://github.com/feimacode/open-design-agent-kit/blob/main/docs/README.md) · [Troubleshooting](https://github.com/feimacode/open-design-agent-kit/blob/main/docs/troubleshooting.md) · [Social media posts](https://github.com/feimacode/open-design-agent-kit/blob/main/docs/guides/social-posts.md) · [Export decks and PDFs](https://github.com/feimacode/open-design-agent-kit/blob/main/docs/guides/export-decks.md)
120
113
 
121
114
  ## License
122
115