timepicker-ui-mcp 1.0.0 → 1.0.1

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 +34 -37
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -6,40 +6,40 @@ It runs over stdio and needs Node 18 or newer.
6
6
 
7
7
  ## Tools
8
8
 
9
- | Tool | Description |
10
- |------|-------------|
11
- | `list_themes` | Built-in themes and their CSS import paths. |
12
- | `list_modes` | UI modes (`clock`, `wheel`, `compact-wheel`) and the plugin each needs. |
13
- | `list_plugins` | Optional plugins (range, timezone, wheel) with import paths. |
14
- | `list_events` | Every EventEmitter event with its payload fields. |
15
- | `list_api` | Public instance and static API, plus the `getValue`/`setValue` contract. |
16
- | `list_css_classes` | The `tp-ui-` class names rendered by the templates. |
17
- | `get_options` | Grouped options with type, default and description. Optional `group` filter. |
18
- | `explain_option` | Full detail for one option (`group` + `name`). |
19
- | `get_theme` | The `--tp-` variables a built-in theme overrides. |
20
- | `framework_recipe` | Integration recipe and SSR notes for vanilla, react, next, vue, angular, svelte. |
21
- | `migration_guide` | `v3->v4` field mapping, or the `v4.3->v4.4` / `v4.4->v4.5` changes. |
22
- | `generate_snippet` | Vanilla JS or React setup (CSS imports and plugin registration). |
23
- | `generate_custom_theme` | A `[data-theme]` CSS block from `overrides`, or a full scaffold. |
24
- | `validate_time` | Checks `HH:MM`, `HH:MM:SS`, `h:MM AM/PM` or `h:MM:SS AM/PM` against a 12h or 24h clock. |
25
- | `validate_disabled_time` | Checks a `clock.disabledTime` config (hours, minutes, seconds, range strings). |
9
+ | Tool | Description |
10
+ | ------------------------ | --------------------------------------------------------------------------------------- |
11
+ | `list_themes` | Built-in themes and their CSS import paths. |
12
+ | `list_modes` | UI modes (`clock`, `wheel`, `compact-wheel`) and the plugin each needs. |
13
+ | `list_plugins` | Optional plugins (range, timezone, wheel) with import paths. |
14
+ | `list_events` | Every EventEmitter event with its payload fields. |
15
+ | `list_api` | Public instance and static API, plus the `getValue`/`setValue` contract. |
16
+ | `list_css_classes` | The `tp-ui-` class names rendered by the templates. |
17
+ | `get_options` | Grouped options with type, default and description. Optional `group` filter. |
18
+ | `explain_option` | Full detail for one option (`group` + `name`). |
19
+ | `get_theme` | The `--tp-` variables a built-in theme overrides. |
20
+ | `framework_recipe` | Integration recipe and SSR notes for vanilla, react, next, vue, angular, svelte. |
21
+ | `migration_guide` | `v3->v4` field mapping, or the `v4.3->v4.4` / `v4.4->v4.5` changes. |
22
+ | `generate_snippet` | Vanilla JS or React setup (CSS imports and plugin registration). |
23
+ | `generate_custom_theme` | A `[data-theme]` CSS block from `overrides`, or a full scaffold. |
24
+ | `validate_time` | Checks `HH:MM`, `HH:MM:SS`, `h:MM AM/PM` or `h:MM:SS AM/PM` against a 12h or 24h clock. |
25
+ | `validate_disabled_time` | Checks a `clock.disabledTime` config (hours, minutes, seconds, range strings). |
26
26
 
27
27
  ## Resources
28
28
 
29
- | URI | Description |
30
- |-----|-------------|
31
- | `timepicker-ui://reference` | Grouped-options summary. |
32
- | `timepicker-ui://css-variables` | Every `--tp-` variable and its default. |
33
- | `timepicker-ui://custom-theme-guide` | How to author a custom theme. |
34
- | `timepicker-ui://troubleshooting` | Common symptoms, causes and fixes. |
29
+ | URI | Description |
30
+ | ------------------------------------ | --------------------------------------- |
31
+ | `timepicker-ui://reference` | Grouped-options summary. |
32
+ | `timepicker-ui://css-variables` | Every `--tp-` variable and its default. |
33
+ | `timepicker-ui://custom-theme-guide` | How to author a custom theme. |
34
+ | `timepicker-ui://troubleshooting` | Common symptoms, causes and fixes. |
35
35
 
36
36
  ## Prompts
37
37
 
38
- | Prompt | Argument | Purpose |
39
- |--------|----------|---------|
40
- | `integrate` | `framework` | Walk through a framework integration. |
41
- | `build-custom-theme` | `description` | Turn a palette into a theme. |
42
- | `migrate-v3-to-v4` | `code` | Convert v3 code to v4 grouped options. |
38
+ | Prompt | Argument | Purpose |
39
+ | -------------------- | ------------- | -------------------------------------- |
40
+ | `integrate` | `framework` | Walk through a framework integration. |
41
+ | `build-custom-theme` | `description` | Turn a palette into a theme. |
42
+ | `migrate-v3-to-v4` | `code` | Convert v3 code to v4 grouped options. |
43
43
 
44
44
  ## Build and test
45
45
 
@@ -59,25 +59,22 @@ The generated JSON is committed, so the server works without the `app/` source n
59
59
 
60
60
  ## Adding it to Claude Code
61
61
 
62
- Build it first. No API keys or env vars are needed. `--scope user` makes it available in every project; leave it out to register it for the current project only. Check it with `claude mcp list`, which should show `timepicker-ui ✓ Connected`.
63
-
64
- Point at the built file directly:
62
+ No API keys or env vars are needed. `--scope user` makes it available in every project. Leave it out to register it for the current project only. Check it with `claude mcp list`, which should show `timepicker-ui ✓ Connected`.
65
63
 
66
64
  ```bash
67
- claude mcp add --scope user timepicker-ui -- node /absolute/path/to/timepicker-ui/mcp-server/build/index.js
65
+ claude mcp add --scope user timepicker-ui -- npx -y timepicker-ui-mcp
68
66
  ```
69
67
 
70
- Or link the bin once with `npm link` (or `npm install -g .`) and skip the path:
68
+ On native Windows, wrap `npx` in `cmd /c`:
71
69
 
72
70
  ```bash
73
- npm link
74
- claude mcp add --scope user timepicker-ui -- timepicker-ui-mcp
71
+ claude mcp add --scope user timepicker-ui -- cmd /c npx -y timepicker-ui-mcp
75
72
  ```
76
73
 
77
- The package isn't on npm yet. Once it is, this will work without cloning anything:
74
+ To run a local build instead, build it first and point at the built file:
78
75
 
79
76
  ```bash
80
- claude mcp add --scope user timepicker-ui -- npx -y timepicker-ui-mcp
77
+ claude mcp add --scope user timepicker-ui -- node /absolute/path/to/timepicker-ui/mcp-server/build/index.js
81
78
  ```
82
79
 
83
80
  If you work in this repo, you can also add a project `.mcp.json` (after `npm install && npm run build` in `mcp-server/`):
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "timepicker-ui-mcp",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "mcpName": "io.github.pglejzer/timepicker-ui-mcp",
5
- "description": "MCP server for timepicker-ui: exposes themes, UI modes, plugins, grouped options, events, the public API, config-snippet and custom-theme generation, and time validation as tools for Claude and other MCP clients.",
5
+ "description": "MCP server for timepicker-ui: options, events, themes, public API, snippets and time validation.",
6
6
  "type": "module",
7
7
  "bin": {
8
8
  "timepicker-ui-mcp": "build/index.js"