Skip to content

Commit 43ebbdb

Browse files
Updated Build MCP docs
1 parent fd72d14 commit 43ebbdb

File tree

2 files changed

+38
-9
lines changed

2 files changed

+38
-9
lines changed

tools/ai-tools/build-mcp.md

Lines changed: 37 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,35 @@ import TabItem from '@theme/TabItem';
2525

2626
## What is Build MCP?
2727

28-
The Build MCP server gives your AI coding assistant direct access to the Avalonia documentation. Instead of relying on training data that may be outdated or incomplete, your assistant can search guides, tutorials, and API references in real time and return answers grounded in the official docs.
28+
The Build MCP server gives your AI coding assistant direct access to the Avalonia documentation and expert development guidance. Instead of relying on training data that may be outdated or incomplete, your assistant can search guides, tutorials, and API references in real time, load Avalonia-specific coding rules, and use guided prompts for common workflows like creating new projects or recreating a UI from a screenshot.
2929

3030
Build MCP is **free to use** and requires no license key or local installation. It runs as a remote server, so setup takes only a few seconds in any MCP-compatible editor or CLI tool.
3131

3232
For a general introduction to MCP, see [AI Tools](/tools/ai-tools/).
3333

3434
## Available tools
3535

36-
The Build MCP server exposes two tools to your AI assistant:
36+
The Build MCP server exposes three tools to your AI assistant:
3737

3838
| Tool | Description |
3939
|------|-------------|
40-
| `search_avalonia_docs` | Searches the full Avalonia documentation, including API references, tutorials, guides, and migration docs. Accepts a natural language query and returns matching results with source links. |
41-
| `lookup_avalonia_api` | Looks up a specific Avalonia class, property, method, or event in the API reference. Use this for targeted API queries such as `TextBlock`, `Window.Show`, or `StyledProperty`. |
40+
| `search_avalonia_docs` | Searches the full Avalonia documentation, including API references, tutorials, guides, and migration docs. Common topics like "styling", "binding", and "mvvm" are automatically routed to optimized queries for better results. |
41+
| `lookup_avalonia_api` | Looks up a specific Avalonia class, property, method, or event in the API reference. Use this for targeted queries such as `TextBlock`, `Window.Show`, or `StyledProperty`. |
42+
| `get_avalonia_expert_rules` | Returns a comprehensive set of Avalonia development rules covering AXAML syntax, the property system, styling, data binding, MVVM patterns, custom controls, layout, theming, assets, threading, and common mistakes to avoid. Call this at the start of a development session so your assistant writes correct, idiomatic Avalonia code. |
43+
44+
## Available prompts
45+
46+
In addition to tools, the Build MCP server provides prompts that configure your assistant for specific workflows. MCP prompts are pre-written instructions that set up the assistant's context and behavior for a task.
47+
48+
:::note
49+
Prompt support varies by client. Claude Desktop, Claude Code, and Cursor support MCP prompts. Other editors may not surface them in the UI. If your editor does not support prompts, you can achieve the same effect by asking your assistant to call the `get_avalonia_expert_rules` tool directly.
50+
:::
51+
52+
| Prompt | Description |
53+
|--------|-------------|
54+
| `init` | Initializes an Avalonia expert session for an existing project. Loads development rules, sets up concise response behavior, and configures the assistant to use the documentation tools for every technical question. |
55+
| `new` | Guides you through creating a new Avalonia application. Covers template selection (`avalonia.mvvm` for desktop, `avalonia.xplat` for cross-platform), project creation with CommunityToolkit.Mvvm, compiled bindings setup, and developer tools installation. Accepts an optional `app_name` parameter. |
56+
| `recreate-ui` | Sets up an iterative design workflow for recreating a UI from a screenshot or image. The assistant writes AXAML, previews it using the [DevTools MCP](/tools/developer-tools/mcp) `attach-to-file` tool, takes screenshots to compare against the target, and keeps refining until the result matches. Accepts an optional `theme` parameter (`light` or `dark`). Requires a paid [Accelerate license](https://my.avalonia.dev/) for the DevTools MCP integration. |
4257

4358
## Setting up the MCP server
4459

@@ -250,16 +265,30 @@ Describe what you want to accomplish in natural language. The AI assistant calls
250265
"Look up the Avalonia TextBlock control in the API reference."
251266
```
252267

253-
**Migration guidance:**
268+
**Loading expert rules at the start of a session:**
254269

255270
```text
256-
"Search the Avalonia docs for how to migrate from WPF to Avalonia."
271+
"Load the Avalonia expert rules so you can help me build my app correctly."
272+
```
273+
274+
**Creating a new project (using the `new` prompt):**
275+
276+
```text
277+
"Create a new Avalonia desktop app called WeatherTracker."
257278
```
258279

259-
**Finding tutorials:**
280+
**Recreating a UI from a screenshot (using the `recreate-ui` prompt):**
260281

261282
```text
262-
"Find an Avalonia tutorial on building an MVVM application."
283+
"Recreate this UI in Avalonia. Use the light theme."
284+
```
285+
286+
This prompt works best when combined with the [DevTools MCP](/tools/developer-tools/mcp), which provides the `attach-to-file` tool for live XAML previewing. The assistant writes AXAML, previews it, takes screenshots, and iterates until the result matches your target design. DevTools MCP requires a paid [Accelerate license](https://my.avalonia.dev/).
287+
288+
**Migration guidance:**
289+
290+
```text
291+
"Search the Avalonia docs for how to migrate from WPF to Avalonia."
263292
```
264293

265294
## See also

tools/ai-tools/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Each MCP setup page includes step-by-step configuration instructions for the fol
2525

2626
## Build MCP
2727

28-
The Build MCP server gives your AI coding assistant direct access to the Avalonia documentation. Your assistant can search guides, tutorials, and API references in real time, returning answers grounded in the official docs rather than relying on training data that may be outdated.
28+
The Build MCP server gives your AI coding assistant direct access to the Avalonia documentation and expert development rules. Your assistant can search guides, tutorials, and API references in real time, load comprehensive coding rules for idiomatic Avalonia development, and use guided prompts for common workflows like creating new projects or recreating a UI from a screenshot.
2929

3030
Build MCP is **free to use** and requires no license key or local installation. It runs as a remote server that connects over HTTP, so setup takes only a few seconds.
3131

0 commit comments

Comments
 (0)