You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/igniteui-mcp/Specification.md
+5-9Lines changed: 5 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -142,26 +142,25 @@ Doc "<name>" not found for framework "<framework>". Use list_components to see a
142
142
**Return**: Markdown setup guidance only. The response contains installation, scaffolding, and next-step instructions for the selected framework.
143
143
144
144
### **search_api**
145
-
**Purpose**: Search Ignite UI API entries by keyword, feature, or partial component name across Angular, React, and Web Components. Returns up to 10 results ranked by match count.
145
+
**Purpose**: Search Ignite UI API entries by keyword, feature, or partial component name across all four platforms. Returns up to 10 results ranked by match count.
146
146
147
147
**Logic**:
148
148
- Searches against component names, keywords, API type, and document content
149
-
- Omitting `platform` searches all three supported platforms simultaneously
149
+
- Omitting `platform` searches all four supported platforms simultaneously
150
150
- Results are ranked by match count; each result includes the exact component name, platform tag, API type (class/interface/directive/enum), match count, keyword list, and a content excerpt
151
151
152
152
**Schema**:
153
153
-`query`: String — keyword, partial name, or feature description; max 256 characters — required
154
-
-`platform`: Enum (angular|react|webcomponents) — optional; omit to search all platforms
154
+
-`platform`: Enum (angular|react|webcomponents|blazor) — optional; omit to search all platforms
155
155
156
156
**Constraints**:
157
-
- Blazor is not supported
158
157
- Output is text, not structured JSON
159
158
- Returns an empty-query message immediately if the input is blank
160
159
161
160
**Return**: Up to 10 ranked text results. Use the exact `component` name and `platform` from a result to call `get_api_reference`.
162
161
163
162
### **get_api_reference**
164
-
**Purpose**: Retrieve the full API reference for one Ignite UI component or class. Supports Angular, React, and Web Components. Component name matching is case-insensitive.
163
+
**Purpose**: Retrieve the full API reference for one Ignite UI component or class. Supports Angular, React, Web Components, and Blazor. Component name matching is case-insensitive.
165
164
166
165
**Logic**:
167
166
- Requires the exact component name (obtained from user code or an `search_api` result)
@@ -171,12 +170,9 @@ Doc "<name>" not found for framework "<framework>". Use list_components to see a
171
170
172
171
**Schema**:
173
172
-`component`: String — exact component or class name; max 128 characters — required
-`section`: Enum (all|properties|methods|events) — optional; defaults to `all`
176
175
177
-
**Constraints**:
178
-
- Blazor is not supported
179
-
180
176
**Return**: Formatted Markdown for the requested API entry. The full entry (`section="all"`) includes the class/interface summary, properties with types and descriptions, methods with signatures, and events.
│ │ └── en/components/toc.yml # Table of contents — source of truth for which files to process
@@ -74,6 +82,18 @@ npm run build # compile TypeScript (tsc) → outputs to ./dist/
74
82
npm start # run MCP server in local mode (default, uses bundled SQLite DB)
75
83
```
76
84
85
+
### API Docs Generation
86
+
87
+
The `blazor/api-docs` submodule provides the Astro build pipeline used by all four platforms. Run these scripts once (or when upstream API data changes) to populate the `docs/*-api/` directories:
88
+
89
+
```bash
90
+
npm run build:docs:angular-api # Angular: Astro build → docs/angular-api/
91
+
npm run build:docs:wc-api # Web Components: Astro build → docs/webcomponents-api/
92
+
npm run build:docs:react-api # React: Astro build → docs/react-api/
Copy file name to clipboardExpand all lines: packages/igniteui-mcp/igniteui-doc-mcp/DEVELOPMENT.md
+29-51Lines changed: 29 additions & 51 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ MCP server that serves pre-compressed Ignite UI component documentation via full
6
6
7
7
```bash
8
8
cd packages/igniteui-mcp/igniteui-doc-mcp
9
-
git submodule update --init --recursive
9
+
git submodule update --init blazor/api-docs
10
10
npm install
11
11
```
12
12
@@ -24,19 +24,15 @@ npm run build:db
24
24
```
25
25
26
26
### Building the API markdown
27
-
The repository already tracks the required documentation and source repositories as git submodules. A fresh clone still needs `git submodule update --init --recursive` to materialize them locally.
28
-
29
-
Required submodules for local API markdown generation include:
30
-
-`angular/igniteui-angular`
31
-
-`webcomponents/igniteui-webcomponents`
27
+
The `blazor/api-docs` submodule provides the Astro-based API build pipeline used by all four platforms. A fresh clone still needs `git submodule update --init blazor/api-docs` to materialize it locally.
32
28
33
29
Before using the MCP server from a source checkout, generate the local API markdowns:
34
30
35
31
```bash
36
32
npm run build:docs:all
37
33
```
38
34
39
-
This step builds the Angular and Web Components API markdown used by the local MCP API tools. If you skip it, API lookups may be incomplete or unavailable even if the server itself builds successfully.
35
+
This step generates API docs for all four platforms (Angular, React, Web Components, and Blazor). If you skip it, API lookups may be incomplete or unavailable even if the server itself builds successfully.
40
36
41
37
If you want to refresh submodules to newer upstream commits, run:
42
38
@@ -421,70 +417,52 @@ Per-platform clear removes the platform subdirectory from `docs_processing/`, `d
421
417
422
418
## API Reference Documentation
423
419
424
-
The MCP server provides API reference lookup via the `get_api_reference` and `search_api` tools. API docs are generated from framework submodules using TypeDoc and stored in `docs/<framework>/`.
420
+
The MCP server provides API reference lookup via the `get_api_reference` and `search_api` tools. API docs are generated from the `blazor/api-docs` submodule using its Astro build pipeline and stored as `llms-full.txt` files in `docs/{platform}-api/`.
- Checks the submodule is built (for Web Components, runs `npm install && npm run build:publish` if needed)
448
-
- Runs TypeDoc with the config from `typedoc/<platform>.typedoc.json`
449
-
- Generates markdown files in `docs/<platform>/api/`
450
-
- Builds a search index (`index.json`) with component names, types, keywords, and summaries
441
+
Each `build:docs:{platform}-api` script:
442
+
1. Initializes the `blazor/api-docs` git submodule
443
+
2. Runs `npm install` in the submodule
444
+
3. Runs the Astro static build for the platform (`npm run build:{platform}:en`)
445
+
4. Copies the generated `llms-full.txt` files from `dist/en/api/{platform}/` to `docs/{platform}-api/`
451
446
452
-
**React** uses a pre-built TypeDoc JSON model (`docs/react/igniteui-react.json`) that is checked into git. It does not need a `build:docs`step — the JSON is parsed at runtime by `ReactJsonParser`.
447
+
The Blazor script additionally runs `dotnet tool restore` and `npm run fetch:tools:blazor` + the five docfx package build scripts before the Astro step. Angular's TypeDoc JSON data is pre-bundled in `blazor/api-docs/src/data/angular/` so no fetch step is needed.
453
448
454
449
### Rebuilding After Upstream Changes
455
450
456
-
When the upstream Angular or Web Components library releases a new version:
451
+
When a new version of `blazor/api-docs` is available:
457
452
458
-
1. Update the submodule to the new version:
453
+
1. Update the submodule:
459
454
```bash
460
-
cdangular/igniteui-angular # or webcomponents/igniteui-webcomponents
461
-
git fetch && git checkout <new-tag>
455
+
cdblazor/api-docs
456
+
git fetch && git checkout <new-branch-or-tag>
462
457
cd ../..
463
458
```
464
459
465
-
2. Rebuild the API docs:
460
+
2. Rebuild the affected platform's API docs:
466
461
```bash
467
-
npm run build:docs:angular # or build:docs:webcomponents
462
+
npm run build:docs:angular-api# or wc-api / react-api / blazor-api
468
463
```
469
464
470
-
3. Commit the updated `docs/` output and submodule reference.
471
-
472
-
### Web Components First-Time Build
473
-
474
-
The Web Components submodule requires a one-time library build before TypeDoc can generate docs. The `build-docs.mjs` script handles this automatically:
475
-
476
-
1. If `dist/index.d.ts` is missing, it runs `npm install && npm run build:publish`
477
-
2. After TypeDoc completes, it cleans up `node_modules` if it installed them
478
-
3. Subsequent runs skip the build step if `dist/index.d.ts` exists
479
-
480
-
If the automatic build fails, build manually:
481
-
482
-
```bash
483
-
cd webcomponents/igniteui-webcomponents
484
-
npm install && npm run build:publish
485
-
cd ../..
486
-
npm run build:docs:webcomponents
487
-
```
465
+
3. Commit the updated `docs/{platform}-api/` output and submodule reference.
Copy file name to clipboardExpand all lines: packages/igniteui-mcp/igniteui-doc-mcp/README.md
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,21 +20,19 @@ npx @igniteui/mcp-server
20
20
21
21
In order to run the MCP from this repository, git submodules must be initialized first. The repo already includes the submodule entries, but a fresh clone still needs to fetch them locally.
22
22
23
-
Required submodules for local API markdown generation include:
24
-
-`angular/igniteui-angular`
25
-
-`webcomponents/igniteui-webcomponents`
23
+
The `blazor/api-docs` submodule is required for local API markdown generation for all four platforms (Angular, React, Web Components, and Blazor).
26
24
27
25
Recommended first-time setup:
28
26
29
27
```bash
30
28
cd packages/igniteui-mcp/igniteui-doc-mcp
31
-
git submodule update --init --recursive
29
+
git submodule update --init blazor/api-docs
32
30
npm install
33
31
npm run build:docs:all
34
32
npm run build
35
33
```
36
34
37
-
`npm run build:docs:all` generates the local API markdown artifacts used by the MCP API tools for Angular and Web Components. Run it before starting the server.
35
+
`npm run build:docs:all` generates the local API markdown artifacts used by the MCP API tools for all four platforms (Angular, React, Web Components, and Blazor). Run it before starting the server.
38
36
39
37
If you need to refresh submodules to newer upstream commits later, use:
0 commit comments