Skip to content

Commit 093713d

Browse files
Marina-L-StoyanovakdinevCopilot
authored
feat(docs): enhance MCP server tool descriptions for clarity and detail (#1737)
* feat(docs): enhance MCP server tool descriptions for clarity and detail * Fix README MCP tool name consistency --------- Co-authored-by: Konstantin Dinev <kdinev@bellumgens.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
1 parent 0245efc commit 093713d

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -203,12 +203,12 @@ The MCP server exposes the following tools to AI assistants:
203203

204204
| Tool | Description |
205205
|------|-------------|
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. |
212212

213213
### Testing with MCP Inspector
214214

@@ -306,7 +306,7 @@ npm run build-pack
306306

307307
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.
308308

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.
310310

311311
## Data Collection
312312

0 commit comments

Comments
 (0)