@exhaustive-ui/mcp 22.0.0-alpha.2 → 22.0.0-alpha.4

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.
package/README.md CHANGED
@@ -85,16 +85,16 @@ args = ["-y", "@exhaustive-ui/mcp"]
85
85
 
86
86
  ## Tools
87
87
 
88
- | Tool | Purpose |
89
- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
90
- | `list` | List components, directives, guides, code examples or MCP resources (`kind`, `limit`, `offset`). |
91
- | `search` | Search component docs, guides, API members (inputs, outputs, templates, PT keys, CSS classes, tokens) and code examples (`query`, `scope`). |
92
- | `get_component` | Read a component: selectors, import path, sections, available examples; optionally its API and compiled declarations (`includeApi`), example code (`includeExamples`) and the full Markdown document (`detail: "full"`). Accepts a batch of up to 10 `components`. |
93
- | `get_guide` | Read a guide by name or route (`installation`, `configuration`, `theming/styled`, `tailwind`, `guides/accessibility`...), optionally one `section` or the full document. |
94
- | `get_example` | Return one complete, source-backed code example of a component (a standalone Angular component with template and imports), by `section` or feature `variant`. |
95
- | `get_setup` | Return the setup guidance for an `environment`: `angular-cli` (default), `configuration`, `styled`, `unstyled`, `tailwind`, `icons`, `custom-icons`, `passthrough`. |
96
- | `validate_usage` | Check an Angular template or component source against the compiled API of a component: unknown inputs and outputs, invalid literal values, unsupported two-way bindings, deprecated inputs, wrong selectors and PrimeNG imports. Accepts a batch of `usages`. |
97
- | `version` | Return the server version, the documented library version, where the docs are read from (live site, cache, offline snapshot) and the registered tools, resources and prompts. |
88
+ | Tool | Purpose |
89
+ | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
90
+ | `list` | List components, directives, guides, code examples or MCP resources (`kind`, `limit`, `offset`). |
91
+ | `search` | Search component docs, guides, API members (inputs, outputs, templates, PT keys, CSS classes, tokens) and code examples (`query`, `scope`). |
92
+ | `get_component` | Read a component: selectors, import path, sections, available examples; optionally its API and compiled declarations (`includeApi`), example code (`includeExamples`) and the full Markdown document (`detail: "full"`). Accepts a batch of up to 10 `components`. |
93
+ | `get_guide` | Read a guide by name or route (`installation`, `configuration`, `theming/styled`, `tailwind`, `guides/accessibility`...), optionally one `section` or the full document. |
94
+ | `get_example` | Return one complete, source-backed code example of a component (a standalone Angular component with template and imports), by `section` or feature `variant`. |
95
+ | `get_setup` | Return the setup guidance for an `environment`: `angular-cli` (default), `configuration`, `styled`, `unstyled`, `tailwind`, `icons`, `custom-icons`, `passthrough`. |
96
+ | `validate_usage` | Check an Angular template or component source against the compiled API of a component: unknown inputs and outputs, invalid literal values, unsupported two-way bindings, deprecated inputs, inputs and outputs removed or renamed in v22 (with their replacement), wrong selectors and PrimeNG imports. Accepts a batch of `usages`. |
97
+ | `version` | Return the server version, the documented library version, where the docs are read from (live site, cache, offline snapshot) and the registered tools, resources and prompts. |
98
98
 
99
99
  Component names are resolved loosely: `button`, `p-button`, `Button`, `[pTooltip]`, `@exhaustive-ui/core/select`, a docs URL, and the PrimeNG names of renamed components (`dropdown`, `calendar`, `sidebar`, `overlaypanel`, `inputswitch`, `tabview`...) all work.
100
100
 
@@ -116,7 +116,7 @@ Resource templates:
116
116
  - `guide-docs`: `exhaustive-ui://docs/pages/{guide}.md`
117
117
  - `example-docs`: `exhaustive-ui://docs/examples/{component}/{section}.md`
118
118
 
119
- Prompts: `use_component`, `build_form`, `theme_component`, `migrate_from_primeng`, `audit_component_usage`.
119
+ Prompts: `use_component`, `build_form`, `theme_component`, `migrate_from_primeng`, `update_to_v22`, `audit_component_usage`.
120
120
 
121
121
  ## Where the docs come from
122
122
 
@@ -126,13 +126,13 @@ The server reads these files from the live site at runtime and keeps them in mem
126
126
 
127
127
  ## Environment variables
128
128
 
129
- | Variable | Default | Purpose |
130
- | --------------------------------- | ----------------------------------- | ------------------------------------------------------------------------------ |
131
- | `EXHAUSTIVE_UI_DOCS_URL` | `https://exhaustive-ui.com` | Docs site to read from, for instance a local `ng serve` of the docs app. |
132
- | `EXHAUSTIVE_UI_MCP_CACHE_TTL` | `900` | Seconds a fetched document is reused before it is fetched again. |
133
- | `EXHAUSTIVE_UI_MCP_FETCH_TIMEOUT` | `10000` | Milliseconds before a request to the docs site is abandoned. |
134
- | `EXHAUSTIVE_UI_MCP_OFFLINE` | unset | Set to `1` to never contact the site and only use the bundled snapshot. |
135
- | `EXHAUSTIVE_UI_MCP_SNAPSHOT_DIR` | the package's `data/` directory | Directory of the offline snapshot (a copy of the site's `/llms/` directory). |
129
+ | Variable | Default | Purpose |
130
+ | --------------------------------- | ------------------------------- | ---------------------------------------------------------------------------- |
131
+ | `EXHAUSTIVE_UI_DOCS_URL` | `https://exhaustive-ui.com` | Docs site to read from, for instance a local `ng serve` of the docs app. |
132
+ | `EXHAUSTIVE_UI_MCP_CACHE_TTL` | `900` | Seconds a fetched document is reused before it is fetched again. |
133
+ | `EXHAUSTIVE_UI_MCP_FETCH_TIMEOUT` | `10000` | Milliseconds before a request to the docs site is abandoned. |
134
+ | `EXHAUSTIVE_UI_MCP_OFFLINE` | unset | Set to `1` to never contact the site and only use the bundled snapshot. |
135
+ | `EXHAUSTIVE_UI_MCP_SNAPSHOT_DIR` | the package's `data/` directory | Directory of the offline snapshot (a copy of the site's `/llms/` directory). |
136
136
 
137
137
  Example, Claude Code pointed at a local docs server:
138
138
 
@@ -166,7 +166,7 @@ export class AccordionDisabledDemo {}
166
166
 
167
167
  ## Dynamic
168
168
 
169
- AccordionPanel can be generated dynamically using the standard @for block.
169
+ AccordionPanel can be generated dynamically using the standard @for block.
170
170
 
171
171
  ```typescript
172
172
  import { Component } from '@angular/core';
@@ -640,7 +640,7 @@ export class AutocompleteMultipleDemo {
640
640
 
641
641
  ## Objects
642
642
 
643
- AutoComplete can also work with objects using the optionLabel property that defines the label to display as a suggestion. The value passed to the model would still be the object instance of a suggestion. Here is an example with a Country object that has name and code fields such as {name: "United States", code:"USA"} .
643
+ AutoComplete can also work with objects using the optionLabel property that defines the label to display as a suggestion. The value passed to the model would still be the object instance of a suggestion. Here is an example with a Country object that has name and code fields such as {name: "United States", code:"USA"} .
644
644
 
645
645
  ```typescript
646
646
  import { Component, OnInit, inject } from '@angular/core';
@@ -322,7 +322,7 @@ export class DatepickerFluidDemo {
322
322
 
323
323
  ## Format
324
324
 
325
- Default date format is mm/dd/yy which can be customized using the dateFormat property. Following options can be a part of the format. d - day of month (no leading zero) dd - day of month (two digit) o - day of the year (no leading zeros) oo - day of the year (three digit) D - day name short DD - day name long m - month of year (no leading zero) mm - month of year (two digit) M - month name short MM - month name long y - year (two digit) yy - year (four digit) @ - Unix timestamp (ms since 01/01/1970) ! - Windows ticks (100ns since 01/01/0001) '...' - literal text '' - single quote anything else - literal text
325
+ Default date format is mm/dd/yy which can be customized using the dateFormat property. Following options can be a part of the format. d - day of month (no leading zero) dd - day of month (two digit) o - day of the year (no leading zeros) oo - day of the year (three digit) D - day name short DD - day name long m - month of year (no leading zero) mm - month of year (two digit) M - month name short MM - month name long y - year (two digit) yy - year (four digit) @ - Unix timestamp (ms since 01/01/1970) ! - Windows ticks (100ns since 01/01/0001) '...' - literal text '' - single quote anything else - literal text
326
326
 
327
327
  ```typescript
328
328
  import { Component } from '@angular/core';
@@ -164,7 +164,7 @@ export class ListboxDisabledDemo implements OnInit {
164
164
 
165
165
  ## dragdrop-doc
166
166
 
167
- Items can be reordered using drag and drop by enabling dragdrop property. Depends on @angular/cdk package.
167
+ Items can be reordered using drag and drop by enabling dragdrop property. Depends on @angular/cdk package.
168
168
 
169
169
  ```typescript
170
170
  import { Component, OnInit } from '@angular/core';
@@ -24,5 +24,5 @@ Add a .md to a page's URL to display a Markdown version of that page.
24
24
 
25
25
  ## MCP Server
26
26
 
27
- @exhaustive-ui/mcp is a Model Context Protocol server that gives coding agents such as Claude Code, Cursor, Claude Desktop, VS Code Copilot and Codex tools to query this documentation instead of guessing from PrimeNG memory: list and search components, read a component's docs and API, fetch a complete code example, read the setup guides, and validate an Angular template against the compiled API (unknown inputs or outputs, invalid literal values, unsupported two-way bindings, deprecated inputs, PrimeNG imports and selectors). The server reads the files described on this page from the live site, so it always reflects the deployed documentation without reinstalling the package, and keeps them in memory for 15 minutes. A snapshot of the same files is bundled in the package and used when the network is unavailable. Register it with Claude Code: Or add it to the MCP configuration of your client ( .cursor/mcp.json , claude_desktop_config.json , .vscode/mcp.json with a servers key, ...): The server exposes the list , search , get_component , get_guide , get_example , get_setup , validate_usage and version tools, the Markdown files of this page as MCP resources, and prompts for the usual tasks (use a component, build a form, theme a component, migrate from PrimeNG, audit usage). Set EXHAUSTIVE_UI_DOCS_URL to read another deployment of the docs, for instance a local ng serve , and EXHAUSTIVE_UI_MCP_OFFLINE=1 to only use the bundled snapshot. The package README lists every option.
27
+ @exhaustive-ui/mcp is a Model Context Protocol server that gives coding agents such as Claude Code, Cursor, Claude Desktop, VS Code Copilot and Codex tools to query this documentation instead of guessing from PrimeNG memory: list and search components, read a component's docs and API, fetch a complete code example, read the setup guides, and validate an Angular template against the compiled API (unknown inputs or outputs, invalid literal values, unsupported two-way bindings, deprecated inputs, PrimeNG imports and selectors). The server reads the files described on this page from the live site, so it always reflects the deployed documentation without reinstalling the package, and keeps them in memory for 15 minutes. A snapshot of the same files is bundled in the package and used when the network is unavailable. Register it with Claude Code: Or add it to the MCP configuration of your client ( .cursor/mcp.json , claude_desktop_config.json , .vscode/mcp.json with a servers key, ...): The server exposes the list , search , get_component , get_guide , get_example , get_setup , validate_usage and version tools, the Markdown files of this page as MCP resources, and prompts for the usual tasks (use a component, build a form, theme a component, migrate from PrimeNG, audit usage). Set EXHAUSTIVE_UI_DOCS_URL to read another deployment of the docs, for instance a local ng serve , and EXHAUSTIVE_UI_MCP_OFFLINE=1 to only use the bundled snapshot. The package README lists every option.
28
28
 
@@ -55,7 +55,7 @@ export class OrderlistBasicDemo implements OnInit {
55
55
 
56
56
  ## dragdrop-doc
57
57
 
58
- Items can be reordered using drag and drop by enabling dragdrop property. Depends on @angular/cdk package.
58
+ Items can be reordered using drag and drop by enabling dragdrop property. Depends on @angular/cdk package.
59
59
 
60
60
  ```typescript
61
61
  import { Component, OnInit, inject, signal } from '@angular/core';
@@ -8,7 +8,7 @@ Screen Reader Value to describe the source listbox and target listbox can be pro
8
8
 
9
9
  ## Basic
10
10
 
11
- PickList is used as a controlled input with source and target properties. Content of a list item needs to be defined with the item template that receives an object in the list as parameter. Drag & drop functionality depends on @angular/cdk package.
11
+ PickList is used as a controlled input with source and target properties. Content of a list item needs to be defined with the item template that receives an object in the list as parameter. Drag & drop functionality depends on @angular/cdk package.
12
12
 
13
13
  ```typescript
14
14
  import { Component, OnInit, inject, signal } from '@angular/core';
@@ -104,7 +104,7 @@ export class StyleclassHideonresizeDemo {}
104
104
 
105
105
  ## Toggle Class
106
106
 
107
- StyleClass has two modes, toggleClass to simply add-remove a class and enter/leave animations. The target element to change the styling is defined with the selector property that accepts any valid CSS selector or keywords including @next , prev , parent , grandparent
107
+ StyleClass has two modes, toggleClass to simply add-remove a class and enter/leave animations. The target element to change the styling is defined with the selector property that accepts any valid CSS selector or keywords including @next , prev , parent , grandparent
108
108
 
109
109
  ```typescript
110
110
  import { Component } from '@angular/core';
@@ -223,7 +223,7 @@ export class TabsDisabledDemo {}
223
223
 
224
224
  ## Dynamic
225
225
 
226
- Tabs can be generated dynamically using the standard @for block.
226
+ Tabs can be generated dynamically using the standard @for block.
227
227
 
228
228
  ```typescript
229
229
  import { Component, OnInit } from '@angular/core';