feat(docs): enhance MCP server tool descriptions for clarity and detail#1737
Open
Marina-L-Stoyanova wants to merge 1 commit into
Open
feat(docs): enhance MCP server tool descriptions for clarity and detail#1737Marina-L-Stoyanova wants to merge 1 commit into
Marina-L-Stoyanova wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the root documentation for the bundled Ignite UI MCP server to reflect current tool naming and provide more detailed per-tool descriptions for AI assistants.
Changes:
- Expanded MCP tool descriptions in the root
README.mdfor clarity. - Updated the project scaffolding tool name in the tools list to
get_project_setup_guide. - Reordered MCP tool rows in the README tool table.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | `search_docs` | Full-text search across Ignite UI docs for a specific framework. Supports prefix matching (e.g., `grid*`). | | ||
| | `search_api` | Search Ignite UI API entries by keyword, feature name, or partial component name. | | ||
| | `get_api_reference` | Return the full API reference for a specific Ignite UI component or class by exact name. | | ||
| | `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. | |
|
coverage: 87.741%. remained the same — mstoyanova/updating-readme into master |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Updating README.md file with the accurate MCP tools names and descriptions.
Related Issue
Closes #
Type of Change
Affected Packages
igniteui-cli(packages/cli)@igniteui/cli-core(packages/core)@igniteui/angular-templates(packages/igx-templates)@igniteui/angular-schematics(packages/ng-schematics)@igniteui/mcp-server(packages/igniteui-mcp)Checklist
npm run test)npm run build)npm run lint)Additional Context