@cmpose/mcp 0.1.1 → 0.1.2

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 (2) hide show
  1. package/README.md +70 -1
  2. package/package.json +9 -3
package/README.md CHANGED
@@ -1,3 +1,72 @@
1
1
  # @cmpose/mcp
2
2
 
3
- A local stdio MCP server with two tools, `cmp_describe` and `cmp_generate`, that generates Compose Multiplatform projects on your own machine through `@cmpose/core`. Add it to Claude Code with `claude mcp add cmpose -- npx -y @cmpose/mcp`. See the README at the root of the cmpose repository for details.
3
+ Ask your AI agent for a **Compose Multiplatform** app and get a real, buildable Android + iOS
4
+ project on disk, generated locally from a tested template. This is a local stdio MCP server
5
+ with two tools, `cmp_describe` and `cmp_generate`. It is the same generator that runs
6
+ [cmpose.dev](https://cmpose.dev), with no account, no API key and no upload.
7
+
8
+ > "Create a blank Compose Multiplatform app called Habits, package com.acme.habits, in
9
+ > ~/Projects, with Room, light/dark theming and AdMob ads."
10
+
11
+ ## Install
12
+
13
+ Requires Node.js 20+ and git.
14
+
15
+ **Claude Code**
16
+
17
+ claude mcp add cmpose -- npx -y @cmpose/mcp
18
+
19
+ **Claude Desktop, Cursor, Windsurf and other MCP clients** (`mcpServers` config):
20
+
21
+ ```json
22
+ {
23
+ "mcpServers": {
24
+ "cmpose": { "command": "npx", "args": ["-y", "@cmpose/mcp"] }
25
+ }
26
+ }
27
+ ```
28
+
29
+ **VS Code** (`.vscode/mcp.json`):
30
+
31
+ ```json
32
+ {
33
+ "servers": {
34
+ "cmpose": { "type": "stdio", "command": "npx", "args": ["-y", "@cmpose/mcp"] }
35
+ }
36
+ }
37
+ ```
38
+
39
+ ## What you get
40
+
41
+ Every project has `androidApp`, `iosApp` (Xcode project), a `shared` module with Koin and
42
+ Navigation, logging (Kermit), image loading (Coil), in-app review, update check, an About
43
+ screen, a `build-logic` with convention plugins, and a README with a release checklist.
44
+
45
+ - **Template:** `showcase` (home, onboarding and paywall demo screens) or `blank`
46
+ (a clean shell with a sample feature).
47
+ - **Options for `blank`:** Ktor networking (with an optional in-app network inspector),
48
+ theming (light/dark/system), multi-language strings, DataStore, Room (KMP, bundled SQLite),
49
+ RevenueCat purchases with a custom Compose paywall, AdMob ads with UMP/ATT consent, detekt.
50
+ - **Your own feature modules:** up to 3, each with contract/data/domain/presentation layers.
51
+ - **CI:** an optional GitHub Actions workflow.
52
+ - **Your names everywhere:** package, bundle id, app name, min SDK and iOS deployment target.
53
+
54
+ ## Tools
55
+
56
+ - `cmp_describe`: the defaults, the options and the rules (name formats, limits, which option
57
+ needs which). Agents call it first.
58
+ - `cmp_generate`: creates the project. Required: `projectName` (letters only), `appName`,
59
+ `packageName` (e.g. `com.acme.habits`) and an absolute `outputDir`. Optional:
60
+ `templateType`, `features`, `featuresConfig`, `minSdk`, `iosVersion`, `ci`, `templateRef`.
61
+ It returns the project path, the template version it used, warnings (e.g. test ad IDs to
62
+ replace) and next steps.
63
+
64
+ ## How it works
65
+
66
+ Generation runs entirely on your machine. The first call downloads the pinned template
67
+ ([Keremturker/cmpose-template](https://github.com/Keremturker/cmpose-template)) into
68
+ `~/.cache/cmpose` (override with `CMPOSE_CACHE_DIR`), and later calls reuse it. Each release
69
+ pins one template tag, so `@cmpose/mcp@x.y.z` always generates the same project.
70
+
71
+ Source and issues: [github.com/Keremturker/cmpose](https://github.com/Keremturker/cmpose).
72
+ MIT licensed. The projects you generate are yours.
package/package.json CHANGED
@@ -1,7 +1,8 @@
1
1
  {
2
2
  "name": "@cmpose/mcp",
3
- "version": "0.1.1",
4
- "description": "Local MCP server that generates Compose Multiplatform projects (cmpose)",
3
+ "version": "0.1.2",
4
+ "mcpName": "io.github.Keremturker/cmpose",
5
+ "description": "MCP server that generates buildable Compose Multiplatform (Android + iOS) projects locally from any AI agent",
5
6
  "license": "MIT",
6
7
  "repository": {
7
8
  "type": "git",
@@ -19,7 +20,12 @@
19
20
  "kotlin-multiplatform",
20
21
  "kmp",
21
22
  "generator",
22
- "scaffold"
23
+ "scaffold",
24
+ "android",
25
+ "ios",
26
+ "compose",
27
+ "ai-agent",
28
+ "mcp-server"
23
29
  ],
24
30
  "bin": {
25
31
  "cmpose-mcp": "src/server.js"