Skip to content

update docs for ai prompts #1228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 26, 2025
Merged

update docs for ai prompts #1228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
554cb51
update docs for ai prompts
didiyordanova Aug 25, 2025
7f2c3e1
address comments
didiyordanova Aug 26, 2025
c73436f
add code
didiyordanova Aug 26, 2025
3caac79
fix typos
didiyordanova Aug 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ai/copilot-extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ page_title: Telerik MAUI GitHub Copilot Extension
description: Learn how to add and use the Telerik MAUI GitHub Copilot extension as a .NET MAUI AI coding assistant and code generator for better developer productivity. The Telerik MAUI GitHub Copilot extension provides proprietary context about Telerik UI for .NET MAUI to AI-powered software.
slug: ai-copilot-extension
tags: telerik, maui, ai, dotnetmaui, coding assistant, ai server
position: 10
position: 1
---

# Telerik MAUI GitHub Copilot Extension
Expand Down Expand Up @@ -54,8 +54,8 @@ To use the Telerik MAUI Copilot extension:

The following examples demonstrate useful prompts for the Telerik MAUI extension:

* "`@telerikmaui` Generate a DataGrid with sorting and paging enabled."
* "`@telerikmaui` Create a Telerik ComboBox for MAUI with multiple selection enabled."
* "`@telerikmaui` Generate a DataGrid with 5 columns and 500 records. Enable sorting for the firs column and include paging."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* "`@telerikmaui` Generate a DataGrid with 5 columns and 500 records. Enable sorting for the firs column and include paging."
* "`@telerikmaui` Generate a DataGrid with 5 columns and 500 records. Enable sorting for the first column and include paging."

* "`@telerikmaui` Create a Telerik ComboBox with sample data for customers. Enable multiple selection and preselect the first two customers."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't the prompts be very basic/getting started. Is the pre-selection a valid basic scenario?

* "`@telerikmaui` Show me how to implement a Chart with line series."
* "`@telerikmaui` Generate a CollectionView with grouping and filtering capabilities."

Expand Down
24 changes: 12 additions & 12 deletions ai/mcp-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ page_title: Telerik MAUI MCP Server
description: Learn how to add and use the Telerik MAUI MCP Server as a .NET MAUI AI coding assistant and code generator for better developer productivity. The Telerik MAUI MCP server provides proprietary context about Telerik UI for .NET MAUI to AI-powered software.
slug: ai-mcp-server
tags: telerik,maui,ai,ai server,dotnetmaui,coding assistant
position: 20
position: 2
---

# Telerik .NET MAUI MCP Server
Expand Down Expand Up @@ -40,7 +40,7 @@ Use these settings when configuring the server in your MCP client:
| Type | `stdio` (standard input/output transport) |
| Command | `npx` |
| Arguments | `-y` |
| Server Name | `telerikMauiAssistant` (customizable) |
| Server Name | `telerik-maui-assistant` (customizable) |

### License Configuration

Expand Down Expand Up @@ -77,7 +77,7 @@ For complete setup instructions, see [Use MCP servers in Visual Studio](https://
```json
{
"servers": {
"telerikMauiAssistant": {
"telerik-maui-assistant": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@progress/telerik-maui-mcp@latest"],
Expand All @@ -92,7 +92,7 @@ For complete setup instructions, see [Use MCP servers in Visual Studio](https://
```

2. Restart Visual Studio.
3. Enable the `telerikMauiAssistant` tool in the [Copilot Chat window's tool selection dropdown](https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers?view=vs-2022#configuration-example-with-github-mcp-server).
3. Enable the `telerik-maui-assistant` tool in the [Copilot Chat window's tool selection dropdown](https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers?view=vs-2022#configuration-example-with-github-mcp-server).

### Global Setup:

Expand Down Expand Up @@ -145,7 +145,7 @@ Create `.cursor/mcp.json` in your workspace root (or user folder for global setu
```json
{
"mcpServers": {
"telerikMauiAssistant": {
"telerik-maui-assistant": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@progress/telerik-maui-mcp@latest"],
Expand All @@ -164,14 +164,14 @@ Create `.cursor/mcp.json` in your workspace root (or user folder for global setu
To use the Telerik MCP Server:

1. Start your prompt with one of these triggers:
- `/telerik` / `@telerik` / `#telerik`
- `/telerikmaui` / `@telerikmaui` / `#telerikmaui`
- `#telerik`
- `#telerikmaui`
- `#telerik-maui-assistant`

2. Verify server activation by looking for these messages:
- Visual Studio: `Running telerikMauiAssistant`
- Visual Studio: `Running telerik-maui-assistant`
- Visual Studio Code: `Running telerik-maui-assistant`
- Cursor: `Calling MCP tool telerikMauiAssistant`
- Cursor: `Calling MCP tool telerik-maui-assistant`

3. Grant permissions when prompted (per session, workspace, or always).

Expand All @@ -187,9 +187,9 @@ To increase the likelihood of the Telerik MCP server being used, add custom inst

The following examples demonstrate useful prompts for the Telerik .NET MAUI MCP Server:

* "`/telerik` Generate a DataGrid with sorting and paging. Bind it to a Person model with sample ViewModel."
* "`/telerikmaui` Create a ComboBox showing a product list. Include Product class and sample data."
* "`/telerik` Build a CollectionView with sorting and filtering capabilities."
* "`#telerik-maui-assistant Create new maui project with Telerik. Add sample usage of the DataGrid component.`"
* "`#telerik-maui-assistant Create a DataGrid with 3 columns - Name, Country, City. Add the corresponding business object in the code behind and populate it with sample data. Add 20 entries to the data.`"
* "`#telerik-maui-assistant Add CollectionView. Enable drag and drop operation in the control.`"

## Number of Requests

Expand Down
40 changes: 32 additions & 8 deletions ai/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,33 @@ To use the Telerik MAUI AI Coding Assistant, you need:
@[template](/_contentTemplates/common/ai-coding-assistant.md#getting-started)
* @[template](/_contentTemplates/common/ai-coding-assistant.md#number-of-requests)

## Number of Requests
## Recommendations

The Telerik MAUI AI Coding Assistant allows the following maximum number of requests based on your [Telerik license type](https://www.telerik.com/purchase/faq/licensing-purchasing):
Consider the following recommendations when working with the AI Coding Assistant:

| License Type | Request Limit |
|--------------|---------------|
| Perpetual | 50 requests per year |
| Subscription | Virtually unlimited with fair use threshold of 300 requests per day |
| Trial | 300 requests per trial period (does not reset with new trial activations) |
* Add NuGet packages/referenced assemblies for the Telerik UI for WPF product.
* Set the .sln as a context.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Set the .sln as a context.
* Set the `.sln` as a context.

* When switching between tasks and files, start a new session in a new chat window to avoid polluting the context with irrelevant or outdated information.
* At the time of publishing, Claude Sonnet 4 produces optimal results.

## Usage Limits

Access to the AI Coding Assistant depends on your [Telerik license type](https://www.telerik.com/purchase/faq/licensing-purchasing):

Subscription License:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally, I would apply some formatting to Subscription License, Perpetual License, etc. Either bold, >caption, or H3/H4

* A Subscription is the primary license that grants full access to the AI Coding Assistant.
* Includes a virtually unlimited number of requests, with a fair use threshold of 300 requests per day.
* Best for ongoing and high-volume usage.

Perpetual License (Limited Access):
* Perpetual licenses include limited access of 50 requests per year.
* Intended for exploring and trying out the AI Coding Assistant.
* For continued or higher-volume access, upgrade to a Subscription license.

Trial License:
* Trial licenses include 300 requests per trial per year.
* Reactivating the same trial for a new release does not grant additional requests.
* Designed for evaluating the feature before purchasing.

> All Telerik AI tools share a single request quota for your Telerik account. Usage from the [Telerik Copilot extension]({%slug ai-copilot-extension%}) and [Telerik MCP server]({%slug ai-mcp-server%}) counts toward the same limit. Complex prompts in the MCP server may consume multiple requests.

Expand All @@ -68,7 +86,13 @@ Data Storage:

> Make sure also to review the terms and privacy policies of your selected AI model and AI client.

## Telerik Document Processing AI Coding Assistant

You can also use the AI Coding Assistant for Telerik Document Processing to generate high-quality code samples and speed up your development.
Read the full guide in the dedicated [DPL AI Coding Assistant article](https://docs.telerik.com/devtools/document-processing/ai-coding-assistant/overview).

## Next Steps

* Install the [Telerik MAUI GitHub Copilot Extension]({%slug ai-copilot-extension%})
* Configure the [Telerik MAUI MCP Server]({%slug ai-mcp-server%}) with an MCP-enabled client
* Configure the [Telerik MAUI MCP Server]({%slug ai-mcp-server%}) with an MCP-enabled client
* Review the [Prompt Library]({%slug ai-prompt-library%})
Loading