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: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -203,12 +203,12 @@ The MCP server exposes the following tools to AI assistants:
203
203
204
204
| Tool | Description |
205
205
|------|-------------|
206
-
|`list_components`| List available Ignite UI component docs for a framework |
207
-
|`get_doc`|Fetch full markdown content of a specific component doc |
208
-
|`search_docs`| Full-text search across Ignite UI documentation|
209
-
|`get_api_reference`|Retrieve the full API reference for a component or class|
210
-
|`search_api`|Search API entries by keyword or partial component name |
211
-
|`generate_ignite_app`|Return a setup guide for a new Ignite UI project |
206
+
|`list_components`| List available Ignite UI component docs. Filter by framework and optional keyword match against filename, component name, keywords, or summary.|
207
+
|`get_doc`|Return the full markdown content of a specific component doc by name (e.g., `grid-editing`, `accordion`).|
208
+
|`search_docs`| Full-text search across Ignite UI docs for a specific framework. Supports prefix matching (e.g., `grid*`).|
209
+
|`search_api`|Search Ignite UI API entries by keyword, feature name, or partial component name.|
210
+
|`get_api_reference`|Return the full API reference for a specific Ignite UI component or class by exact name.|
211
+
|`get_project_setup_guide`|Returns setup guides for creating a new Ignite UI project. For Angular/React/Web Components: CLI scaffolding instructions. For Blazor: `dotnet new` + NuGet setup guide.|
212
212
213
213
### Testing with MCP Inspector
214
214
@@ -306,7 +306,7 @@ npm run build-pack
306
306
307
307
After step 5, `npm pack` from the repo root or `packages/cli/` will produce a tarball with the MCP server, documentation database, and API reference docs all included.
308
308
309
-
>**Skipping API docs:** If you skip step 3, the MCP server will still work for`list_components`, `get_doc`, `search_docs`, and `generate_ignite_app` tools using the bundled SQLite database. Only the `get_api_reference` and `search_api` tools require API docs.
309
+
>**Skipping API docs:** If you skip step 3, the MCP server will still work for`list_components`, `get_doc`, `search_docs`, and `get_project_setup_guide` tools using the bundled SQLite database. Only the `get_api_reference` and `search_api` tools require API docs.
0 commit comments